2.233.0

interface WorkflowProperty

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

Represents a workflow in a Region switch plan.

A workflow defines a sequence of steps to execute during a Region switch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.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 workflowProperty: arcregionswitch_mixins.CfnPlanPropsMixin.WorkflowProperty = {
  steps: [{
    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',
  }],
  workflowDescription: 'workflowDescription',
  workflowTargetAction: 'workflowTargetAction',
  workflowTargetRegion: 'workflowTargetRegion',
};

Properties

NameTypeDescription
steps?IResolvable | (IResolvable | StepProperty)[]The steps that make up the workflow.
workflowDescription?stringThe description of the workflow.
workflowTargetAction?stringThe action that the workflow performs.
workflowTargetRegion?stringThe AWS Region that the workflow targets.

steps?

Type: IResolvable | (IResolvable | StepProperty)[] (optional)

The steps that make up the workflow.

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

workflowDescription?

Type: string (optional)

The description of the workflow.

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

workflowTargetAction?

Type: string (optional)

The action that the workflow performs.

Valid values include ACTIVATE and DEACTIVATE.

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

workflowTargetRegion?

Type: string (optional)

The AWS Region that the workflow targets.

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

← PreviousNext →