2.233.0

interface StepProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.ARCRegionSwitch.Mixins.CfnPlanPropsMixin.StepProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsarcregionswitch/mixins#CfnPlanPropsMixin_StepProperty
Javasoftware.amazon.awscdk.mixins.preview.services.arcregionswitch.mixins.CfnPlanPropsMixin.StepProperty
Pythonaws_cdk.mixins_preview.aws_arcregionswitch.mixins.CfnPlanPropsMixin.StepProperty
TypeScript @aws-cdk/mixins-preview » aws_arcregionswitch » mixins » CfnPlanPropsMixin » StepProperty

Represents a step in a Region switch plan workflow.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html

Example

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

declare const stepProperty_: arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty;
const stepProperty: arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty = {
  description: 'description',
  executionBlockConfiguration: {
    arcRoutingControlConfig: {
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
      regionAndRoutingControls: {
        regionAndRoutingControlsKey: [{
          routingControlArn: 'routingControlArn',
          state: 'state',
        }],
      },
      timeoutMinutes: 123,
    },
    customActionLambdaConfig: {
      lambdas: [{
        arn: 'arn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],
      regionToRun: 'regionToRun',
      retryIntervalMinutes: 123,
      timeoutMinutes: 123,
      ungraceful: {
        behavior: 'behavior',
      },
    },
    ec2AsgCapacityIncreaseConfig: {
      asgs: [{
        arn: 'arn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    ecsCapacityIncreaseConfig: {
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      services: [{
        clusterArn: 'clusterArn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
        serviceArn: 'serviceArn',
      }],
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    eksResourceScalingConfig: {
      capacityMonitoringApproach: 'capacityMonitoringApproach',
      eksClusters: [{
        clusterArn: 'clusterArn',
        crossAccountRole: 'crossAccountRole',
        externalId: 'externalId',
      }],
      kubernetesResourceType: {
        apiVersion: 'apiVersion',
        kind: 'kind',
      },
      scalingResources: [{
        scalingResourcesKey: {
          scalingResourcesKey: {
            hpaName: 'hpaName',
            name: 'name',
            namespace: 'namespace',
          },
        },
      }],
      targetPercent: 123,
      timeoutMinutes: 123,
      ungraceful: {
        minimumSuccessPercentage: 123,
      },
    },
    executionApprovalConfig: {
      approvalRole: 'approvalRole',
      timeoutMinutes: 123,
    },
    globalAuroraConfig: {
      behavior: 'behavior',
      crossAccountRole: 'crossAccountRole',
      databaseClusterArns: ['databaseClusterArns'],
      externalId: 'externalId',
      globalClusterIdentifier: 'globalClusterIdentifier',
      timeoutMinutes: 123,
      ungraceful: {
        ungraceful: 'ungraceful',
      },
    },
    parallelConfig: {
      steps: [stepProperty_],
    },
    regionSwitchPlanConfig: {
      arn: 'arn',
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
    },
    route53HealthCheckConfig: {
      crossAccountRole: 'crossAccountRole',
      externalId: 'externalId',
      hostedZoneId: 'hostedZoneId',
      recordName: 'recordName',
      recordSets: [{
        recordSetIdentifier: 'recordSetIdentifier',
        region: 'region',
      }],
      timeoutMinutes: 123,
    },
  },
  executionBlockType: 'executionBlockType',
  name: 'name',
};

Properties

NameTypeDescription
description?stringThe description of a step in a workflow.
executionBlockConfiguration?IResolvable | ExecutionBlockConfigurationPropertyThe configuration for an execution block in a workflow.
executionBlockType?stringThe type of an execution block in a workflow.
name?stringThe name of a step in a workflow.

description?

Type: string (optional)

The description of a step in a workflow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-description

executionBlockConfiguration?

Type: IResolvable | ExecutionBlockConfigurationProperty (optional)

The configuration for an execution block in a workflow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblockconfiguration

executionBlockType?

Type: string (optional)

The type of an execution block in a workflow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblocktype

name?

Type: string (optional)

The name of a step in a workflow.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-name

← PreviousNext →