interface StepProperty

Language	Type name
.NET	`Amazon.CDK.aws_arcregionswitch.CfnPlan.StepProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsarcregionswitch#CfnPlan_StepProperty`
Java	`software.amazon.awscdk.services.arcregionswitch.CfnPlan.StepProperty`
Python	`aws_cdk.aws_arcregionswitch.CfnPlan.StepProperty`
TypeScript	`aws-cdk-lib` » `aws_arcregionswitch` » `CfnPlan` » `StepProperty`

Represents a step in a Region switch plan workflow.

Each step performs a specific action during the Region switch process.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_arcregionswitch as arcregionswitch } from 'aws-cdk-lib';

declare const stepProperty_: arcregionswitch.CfnPlan.StepProperty;
const stepProperty: arcregionswitch.CfnPlan.StepProperty = {
  executionBlockConfiguration: {
    arcRoutingControlConfig: {
      regionAndRoutingControls: {
        regionAndRoutingControlsKey: [{
          routingControlArn: 'routingControlArn',
          state: 'state',
        }],
      },

      // the properties below are optional
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
      timeoutMinutes: 123,
    },
    customActionLambdaConfig: {
      lambdas: [{
        arn: 'arn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],
      regionToRun: 'regionToRun',
      retryIntervalMinutes: 123,

      // the properties below are optional
      timeoutMinutes: 123,
      ungraceful: {
        behavior: 'behavior',
      },
    },
    ec2AsgCapacityIncreaseConfig: {
      asgs: [{
        arn: 'arn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],

      // the properties below are optional
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    ecsCapacityIncreaseConfig: {
      services: [{
        clusterArn: 'clusterArn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
        serviceArn: 'serviceArn',
      }],

      // the properties below are optional
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    eksResourceScalingConfig: {
      kubernetesResourceType: {
        apiVersion: 'apiVersion',
        kind: 'kind',
      },

      // the properties below are optional
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      eksClusters: [{
        clusterArn: 'clusterArn',

        // the properties below are optional
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],
      scalingResources: [{
        scalingResourcesKey: {
          scalingResourcesKey: {
            name: 'name',
            namespace: 'namespace',

            // the properties below are optional
            hpaName: 'hpaName',
          },
        },
      }],
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    executionApprovalConfig: {
      approvalRole: 'approvalRole',

      // the properties below are optional
      timeoutMinutes: 123,
    },
    globalAuroraConfig: {
      behavior: 'behavior',
      databaseClusterArns: ['databaseClusterArns'],
      globalClusterIdentifier: 'globalClusterIdentifier',

      // the properties below are optional
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
      timeoutMinutes: 123,
      ungraceful: {
        ungraceful: 'ungraceful',
      },
    },
    parallelConfig: {
      steps: [stepProperty_],
    },
    regionSwitchPlanConfig: {
      arn: 'arn',

      // the properties below are optional
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
    },
    route53HealthCheckConfig: {
      hostedZoneId: 'hostedZoneId',
      recordName: 'recordName',

      // the properties below are optional
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
      recordSets: [{
        recordSetIdentifier: 'recordSetIdentifier',
        region: 'region',
      }],
      timeoutMinutes: 123,
    },
  },
  executionBlockType: 'executionBlockType',
  name: 'name',

  // the properties below are optional
  description: 'description',
};

Properties

Name	Type	Description
executionBlockConfiguration	`IResolvable` `\|` `ExecutionBlockConfigurationProperty`	The configuration for an execution block in a workflow.
executionBlockType	`string`	The type of an execution block in a workflow.
name	`string`	The name of a step in a workflow.
description?	`string`	The description of a step in a workflow.

executionBlockConfiguration

Type: IResolvable | ExecutionBlockConfigurationProperty

The configuration for an execution block in a workflow.

executionBlockType

Type: string

The type of an execution block in a workflow.

name

Type: string

The name of a step in a workflow.

description?

Type: string (optional)

The description of a step in a workflow.