interface CfnPlanMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ARCRegionSwitch.Mixins.CfnPlanMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsarcregionswitch/mixins#CfnPlanMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.arcregionswitch.mixins.CfnPlanMixinProps |
 Python | aws_cdk.mixins_preview.aws_arcregionswitch.mixins.CfnPlanMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_arcregionswitch » mixins » CfnPlanMixinProps |
Properties for CfnPlanPropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.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 cfnPlanMixinProps: arcregionswitch_mixins.CfnPlanMixinProps = {
associatedAlarms: {
associatedAlarmsKey: {
alarmType: 'alarmType',
crossAccountRole: 'crossAccountRole',
externalId: 'externalId',
resourceIdentifier: 'resourceIdentifier',
},
},
description: 'description',
executionRole: 'executionRole',
name: 'name',
primaryRegion: 'primaryRegion',
recoveryApproach: 'recoveryApproach',
recoveryTimeObjectiveMinutes: 123,
regions: ['regions'],
tags: {
tagsKey: 'tags',
},
triggers: [{
action: 'action',
conditions: [{
associatedAlarmName: 'associatedAlarmName',
condition: 'condition',
}],
description: 'description',
minDelayMinutesBetweenExecutions: 123,
targetRegion: 'targetRegion',
}],
workflows: [{
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
| Name | Type | Description |
|---|---|---|
| associated | IResolvable | { [string]: IResolvable | Associated } | The associated application health alarms for a plan. |
| description? | string | The description for a plan. |
| execution | string | The execution role for a plan. |
| name? | string | The name for a plan. |
| primary | string | The primary Region for a plan. |
| recovery | string | The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive). |
| recovery | number | The recovery time objective for a plan. |
| regions? | string[] | The AWS Regions for a plan. |
| tags? | { [string]: string } | |
| triggers? | IResolvable | (IResolvable | Trigger)[] | The triggers for a plan. |
| workflows? | IResolvable | (IResolvable | Workflow)[] | The workflows for a plan. |
associatedAlarms?
Type:
IResolvable | { [string]: IResolvable | Associated }
(optional)
The associated application health alarms for a plan.
description?
Type:
string
(optional)
The description for a plan.
executionRole?
Type:
string
(optional)
The execution role for a plan.
name?
Type:
string
(optional)
The name for a plan.
primaryRegion?
Type:
string
(optional)
The primary Region for a plan.
recoveryApproach?
Type:
string
(optional)
The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
recoveryTimeObjectiveMinutes?
Type:
number
(optional)
The recovery time objective for a plan.
regions?
Type:
string[]
(optional)
The AWS Regions for a plan.
tags?
Type:
{ [string]: string }
(optional)
triggers?
Type:
IResolvable | (IResolvable | Trigger)[]
(optional)
The triggers for a plan.
workflows?
Type:
IResolvable | (IResolvable | Workflow)[]
(optional)
The workflows for a plan.