interface WorkflowProperty

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

Represents a workflow in a Region switch plan.

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

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 workflowProperty: arcregionswitch.CfnPlan.WorkflowProperty = {
  workflowTargetAction: 'workflowTargetAction',

  // the properties below are optional
  steps: [{
    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',
  }],
  workflowDescription: 'workflowDescription',
  workflowTargetRegion: 'workflowTargetRegion',
};

Properties

Name	Type	Description
workflowTargetAction	`string`	The action that the workflow performs.
steps?	`IResolvable` `\|` `IResolvable` `\|` `StepProperty[]`	The steps that make up the workflow.
workflowDescription?	`string`	The description of the workflow.
workflowTargetRegion?	`string`	The AWS Region that the workflow targets.

workflowTargetAction

Type: string

The action that the workflow performs.

Valid values include ACTIVATE and DEACTIVATE.

steps?

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

The steps that make up the workflow.

workflowDescription?

Type: string (optional)

The description of the workflow.

workflowTargetRegion?

Type: string (optional)

The AWS Region that the workflow targets.