@propulsionworks/cloudformation 0.1.20 → 0.1.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/out/exports/resources.generated/aws-apigateway-deployment.d.ts +1 -1
  2. package/out/exports/resources.generated/aws-appconfig-configurationprofile.d.ts +3 -3
  3. package/out/exports/resources.generated/aws-appconfig-deployment.d.ts +5 -0
  4. package/out/exports/resources.generated/aws-appintegrations-application.d.ts +52 -0
  5. package/out/exports/resources.generated/aws-aps-resourcepolicy.d.ts +22 -0
  6. package/out/exports/resources.generated/aws-arcregionswitch-plan.d.ts +132 -0
  7. package/out/exports/resources.generated/aws-athena-datacatalog.d.ts +15 -6
  8. package/out/exports/resources.generated/aws-athena-workgroup.d.ts +3 -3
  9. package/out/exports/resources.generated/aws-batch-jobdefinition.d.ts +2 -2
  10. package/out/exports/resources.generated/aws-batch-jobqueue.d.ts +7 -0
  11. package/out/exports/resources.generated/aws-batch-serviceenvironment.d.ts +1 -1
  12. package/out/exports/resources.generated/aws-billingconductor-customlineitem.d.ts +2 -2
  13. package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +4 -0
  14. package/out/exports/resources.generated/aws-codebuild-project.d.ts +17 -0
  15. package/out/exports/resources.generated/aws-codepipeline-webhook.d.ts +1 -0
  16. package/out/exports/resources.generated/aws-connect-user.d.ts +5 -0
  17. package/out/exports/resources.generated/aws-deadline-fleet.d.ts +16 -0
  18. package/out/exports/resources.generated/aws-deadline-monitor.d.ts +6 -1
  19. package/out/exports/resources.generated/aws-docdb-dbcluster.d.ts +5 -1
  20. package/out/exports/resources.generated/aws-dynamodb-globaltable.d.ts +4 -0
  21. package/out/exports/resources.generated/aws-dynamodb-table.d.ts +4 -0
  22. package/out/exports/resources.generated/aws-ec2-ec2fleet.d.ts +1 -1
  23. package/out/exports/resources.generated/aws-ec2-ippoolroutetableassociation.d.ts +33 -0
  24. package/out/exports/resources.generated/aws-ec2-launchtemplate.d.ts +7 -53
  25. package/out/exports/resources.generated/aws-ec2-natgateway.d.ts +1 -1
  26. package/out/exports/resources.generated/aws-ec2-transitgatewayconnectpeer.d.ts +5 -4
  27. package/out/exports/resources.generated/aws-ec2-volume.d.ts +2 -0
  28. package/out/exports/resources.generated/aws-ecr-repository.d.ts +2 -0
  29. package/out/exports/resources.generated/aws-ecr-repositorycreationtemplate.d.ts +2 -2
  30. package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +0 -2
  31. package/out/exports/resources.generated/aws-eks-addon.d.ts +10 -0
  32. package/out/exports/resources.generated/aws-eks-cluster.d.ts +5 -0
  33. package/out/exports/resources.generated/aws-elasticloadbalancingv2-loadbalancer.d.ts +2 -1
  34. package/out/exports/resources.generated/aws-entityresolution-matchingworkflow.d.ts +16 -0
  35. package/out/exports/resources.generated/aws-evs-environment.d.ts +1 -9
  36. package/out/exports/resources.generated/aws-fsx-filesystem.d.ts +8 -0
  37. package/out/exports/resources.generated/aws-glue-job.d.ts +19 -8
  38. package/out/exports/resources.generated/aws-glue-tableoptimizer.d.ts +18 -1
  39. package/out/exports/resources.generated/aws-guardduty-threatentityset.d.ts +89 -0
  40. package/out/exports/resources.generated/aws-guardduty-trustedentityset.d.ts +89 -0
  41. package/out/exports/resources.generated/aws-imagebuilder-component.d.ts +1 -1
  42. package/out/exports/resources.generated/aws-imagebuilder-containerrecipe.d.ts +2 -2
  43. package/out/exports/resources.generated/aws-imagebuilder-distributionconfiguration.d.ts +1 -1
  44. package/out/exports/resources.generated/aws-imagebuilder-imagerecipe.d.ts +4 -2
  45. package/out/exports/resources.generated/aws-imagebuilder-workflow.d.ts +1 -1
  46. package/out/exports/resources.generated/aws-inspectorv2-codesecurityintegration.d.ts +160 -0
  47. package/out/exports/resources.generated/aws-inspectorv2-codesecurityscanconfiguration.d.ts +121 -0
  48. package/out/exports/resources.generated/aws-iot-mitigationaction.d.ts +2 -2
  49. package/out/exports/resources.generated/aws-iotsitewise-assetmodel.d.ts +46 -2
  50. package/out/exports/resources.generated/aws-ivs-playbackrestrictionpolicy.d.ts +2 -2
  51. package/out/exports/resources.generated/aws-ivs-stage.d.ts +54 -0
  52. package/out/exports/resources.generated/aws-kinesisfirehose-deliverystream.d.ts +1 -1
  53. package/out/exports/resources.generated/aws-lambda-permission.d.ts +2 -2
  54. package/out/exports/resources.generated/aws-lambda-url.d.ts +1 -1
  55. package/out/exports/resources.generated/aws-lambda-version.d.ts +1 -1
  56. package/out/exports/resources.generated/aws-logs-destination.d.ts +1 -1
  57. package/out/exports/resources.generated/aws-mediapackagev2-originendpoint.d.ts +18 -0
  58. package/out/exports/resources.generated/aws-networkfirewall-firewall.d.ts +36 -6
  59. package/out/exports/resources.generated/aws-networkfirewall-firewallpolicy.d.ts +16 -9
  60. package/out/exports/resources.generated/aws-networkfirewall-loggingconfiguration.d.ts +8 -8
  61. package/out/exports/resources.generated/aws-networkfirewall-rulegroup.d.ts +36 -22
  62. package/out/exports/resources.generated/aws-networkfirewall-vpcendpointassociation.d.ts +3 -3
  63. package/out/exports/resources.generated/aws-observabilityadmin-organizationtelemetryrule.d.ts +137 -0
  64. package/out/exports/resources.generated/aws-observabilityadmin-telemetryrule.d.ts +132 -0
  65. package/out/exports/resources.generated/aws-omics-workflowversion.d.ts +2 -2
  66. package/out/exports/resources.generated/aws-opensearchservice-domain.d.ts +21 -0
  67. package/out/exports/resources.generated/aws-opsworks-app.d.ts +4 -4
  68. package/out/exports/resources.generated/aws-opsworks-elasticloadbalancerattachment.d.ts +1 -1
  69. package/out/exports/resources.generated/aws-opsworks-instance.d.ts +14 -14
  70. package/out/exports/resources.generated/aws-opsworks-layer.d.ts +8 -8
  71. package/out/exports/resources.generated/aws-opsworks-stack.d.ts +25 -25
  72. package/out/exports/resources.generated/aws-opsworkscm-server.d.ts +2 -2
  73. package/out/exports/resources.generated/aws-pcs-cluster.d.ts +4 -0
  74. package/out/exports/resources.generated/aws-qbusiness-webexperience.d.ts +1 -1
  75. package/out/exports/resources.generated/aws-quicksight-dataset.d.ts +6 -6
  76. package/out/exports/resources.generated/aws-rds-dbcluster.d.ts +5 -0
  77. package/out/exports/resources.generated/aws-rds-dbinstance.d.ts +4 -29
  78. package/out/exports/resources.generated/aws-rds-dbproxy.d.ts +2 -2
  79. package/out/exports/resources.generated/aws-s3-accesspoint.d.ts +1 -1
  80. package/out/exports/resources.generated/aws-s3express-accesspoint.d.ts +1 -0
  81. package/out/exports/resources.generated/aws-s3tables-tablebucketpolicy.d.ts +2 -2
  82. package/out/exports/resources.generated/aws-s3tables-tablepolicy.d.ts +2 -2
  83. package/out/exports/resources.generated/aws-sagemaker-cluster.d.ts +101 -2
  84. package/out/exports/resources.generated/aws-sagemaker-domain.d.ts +0 -6
  85. package/out/exports/resources.generated/aws-sagemaker-processingjob.d.ts +72 -46
  86. package/out/exports/resources.generated/aws-sqs-queue.d.ts +2 -1
  87. package/out/exports/resources.generated/aws-synthetics-canary.d.ts +28 -0
  88. package/out/exports/resources.generated/aws-verifiedpermissions-policystore.d.ts +3 -5
  89. package/out/exports/resources.generated/aws-workspacesweb-portal.d.ts +7 -0
  90. package/out/exports/resources.generated/aws-workspacesweb-sessionlogger.d.ts +125 -0
  91. package/package.json +1 -1
@@ -1,26 +1,32 @@
1
1
  import type { ResourceDefinitionWithAttributes } from "../main.ts";
2
2
  /**
3
+ * Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
3
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html}
4
5
  */
5
6
  export type ARCRegionSwitchPlan = ResourceDefinitionWithAttributes<"AWS::ARCRegionSwitch::Plan", ARCRegionSwitchPlanProps, ARCRegionSwitchPlanAttribs>;
6
7
  /**
8
+ * Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
7
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html}
8
10
  */
9
11
  export type ARCRegionSwitchPlanProps = {
10
12
  /**
13
+ * The associated application health alarms for a plan.
11
14
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-associatedalarms}
12
15
  */
13
16
  AssociatedAlarms?: Record<string, AssociatedAlarm> | undefined;
14
17
  /**
18
+ * The description for a plan.
15
19
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-description}
16
20
  */
17
21
  Description?: string | undefined;
18
22
  /**
23
+ * The execution role for a plan.
19
24
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
20
25
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-executionrole}
21
26
  */
22
27
  ExecutionRole: string;
23
28
  /**
29
+ * The name for a plan.
24
30
  * @minLength 1
25
31
  * @maxLength 32
26
32
  * @pattern ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$
@@ -28,21 +34,25 @@ export type ARCRegionSwitchPlanProps = {
28
34
  */
29
35
  Name: string;
30
36
  /**
37
+ * The primary Region for a plan.
31
38
  * @pattern ^[a-z]{2}-[a-z-]+-\d+$
32
39
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-primaryregion}
33
40
  */
34
41
  PrimaryRegion?: string | undefined;
35
42
  /**
43
+ * The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
36
44
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoveryapproach}
37
45
  */
38
46
  RecoveryApproach: RecoveryApproach;
39
47
  /**
48
+ * The recovery time objective for a plan.
40
49
  * @min 1
41
50
  * @max 10080
42
51
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes}
43
52
  */
44
53
  RecoveryTimeObjectiveMinutes?: number | undefined;
45
54
  /**
55
+ * The AWS Regions for a plan.
46
56
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-regions}
47
57
  */
48
58
  Regions: string[];
@@ -51,10 +61,12 @@ export type ARCRegionSwitchPlanProps = {
51
61
  */
52
62
  Tags?: Record<string, string> | undefined;
53
63
  /**
64
+ * The triggers for a plan.
54
65
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-triggers}
55
66
  */
56
67
  Triggers?: Trigger[] | undefined;
57
68
  /**
69
+ * The workflows for a plan.
58
70
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-workflows}
59
71
  */
60
72
  Workflows: Workflow[];
@@ -64,16 +76,19 @@ export type ARCRegionSwitchPlanProps = {
64
76
  */
65
77
  export type ARCRegionSwitchPlanAttribs = {
66
78
  /**
79
+ * The Amazon Resource Name (ARN) of the plan.
67
80
  * @pattern ^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$
68
81
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-arn}
69
82
  */
70
83
  Arn: string;
71
84
  /**
85
+ * The owner of a plan.
72
86
  * @pattern ^\d{12}$
73
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-owner}
74
88
  */
75
89
  Owner: string;
76
90
  /**
91
+ * The version for the plan.
77
92
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-version}
78
93
  */
79
94
  Version: string;
@@ -87,23 +102,28 @@ export type AlarmCondition = "red" | "green";
87
102
  */
88
103
  export type AlarmType = "applicationHealth" | "trigger";
89
104
  /**
105
+ * Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.
90
106
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html}
91
107
  */
92
108
  export type ArcRoutingControlConfiguration = {
93
109
  /**
110
+ * The cross account role for the configuration.
94
111
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
95
112
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-crossaccountrole}
96
113
  */
97
114
  CrossAccountRole?: string | undefined;
98
115
  /**
116
+ * The external ID (secret key) for the configuration.
99
117
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid}
100
118
  */
101
119
  ExternalId?: string | undefined;
102
120
  /**
121
+ * The Region and ARC routing controls for the configuration.
103
122
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-regionandroutingcontrols}
104
123
  */
105
124
  RegionAndRoutingControls: Record<string, ArcRoutingControlState[]>;
106
125
  /**
126
+ * The timeout value specified for the configuration.
107
127
  * @min 1
108
128
  * @default 60
109
129
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-timeoutminutes}
@@ -124,98 +144,119 @@ export type ArcRoutingControlState = {
124
144
  State: RoutingControlStateChange;
125
145
  };
126
146
  /**
147
+ * Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
127
148
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html}
128
149
  */
129
150
  export type Asg = {
130
151
  /**
152
+ * The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
131
153
  * @pattern ^arn:aws:autoscaling:[a-z0-9-]+:\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\S\s]{1,255}$
132
154
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-arn}
133
155
  */
134
156
  Arn?: string | undefined;
135
157
  /**
158
+ * The cross account role for the configuration.
136
159
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
137
160
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-crossaccountrole}
138
161
  */
139
162
  CrossAccountRole?: string | undefined;
140
163
  /**
164
+ * The external ID (secret key) for the configuration.
141
165
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-asg.html#cfn-arcregionswitch-plan-asg-externalid}
142
166
  */
143
167
  ExternalId?: string | undefined;
144
168
  };
145
169
  /**
170
+ * An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.
146
171
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html}
147
172
  */
148
173
  export type AssociatedAlarm = {
149
174
  /**
175
+ * The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
150
176
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-alarmtype}
151
177
  */
152
178
  AlarmType: AlarmType;
153
179
  /**
180
+ * The cross account role for the configuration.
154
181
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
155
182
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-crossaccountrole}
156
183
  */
157
184
  CrossAccountRole?: string | undefined;
158
185
  /**
186
+ * The external ID (secret key) for the configuration.
159
187
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-externalid}
160
188
  */
161
189
  ExternalId?: string | undefined;
162
190
  /**
191
+ * The resource identifier for alarms that you associate with a plan.
163
192
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-associatedalarm.html#cfn-arcregionswitch-plan-associatedalarm-resourceidentifier}
164
193
  */
165
194
  ResourceIdentifier: string;
166
195
  };
167
196
  /**
197
+ * Configuration for AWS Lambda functions that perform custom actions during a Region switch.
168
198
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html}
169
199
  */
170
200
  export type CustomActionLambdaConfiguration = {
171
201
  /**
202
+ * The AWS Lambda functions for the execution block.
172
203
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-lambdas}
173
204
  */
174
205
  Lambdas: Lambdas[];
175
206
  /**
207
+ * The AWS Region for the function to run in.
176
208
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-regiontorun}
177
209
  */
178
210
  RegionToRun: RegionToRunIn;
179
211
  /**
212
+ * The retry interval specified.
180
213
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-retryintervalminutes}
181
214
  */
182
215
  RetryIntervalMinutes: number;
183
216
  /**
217
+ * The timeout value specified for the configuration.
184
218
  * @min 1
185
219
  * @default 60
186
220
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-timeoutminutes}
187
221
  */
188
222
  TimeoutMinutes?: number | undefined;
189
223
  /**
224
+ * The settings for ungraceful execution.
190
225
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-customactionlambdaconfiguration.html#cfn-arcregionswitch-plan-customactionlambdaconfiguration-ungraceful}
191
226
  */
192
227
  Ungraceful?: LambdaUngraceful | undefined;
193
228
  };
194
229
  /**
230
+ * Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
195
231
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html}
196
232
  */
197
233
  export type Ec2AsgCapacityIncreaseConfiguration = {
198
234
  /**
235
+ * The EC2 Auto Scaling groups for the configuration.
199
236
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-asgs}
200
237
  */
201
238
  Asgs: Asg[];
202
239
  /**
240
+ * The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
203
241
  * @default "sampledMaxInLast24Hours"
204
242
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-capacitymonitoringapproach}
205
243
  */
206
244
  CapacityMonitoringApproach?: Ec2AsgCapacityMonitoringApproach | undefined;
207
245
  /**
246
+ * The target percentage that you specify for EC2 Auto Scaling groups.
208
247
  * @default 100
209
248
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-targetpercent}
210
249
  */
211
250
  TargetPercent?: number | undefined;
212
251
  /**
252
+ * The timeout value specified for the configuration.
213
253
  * @min 1
214
254
  * @default 60
215
255
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-timeoutminutes}
216
256
  */
217
257
  TimeoutMinutes?: number | undefined;
218
258
  /**
259
+ * The settings for ungraceful execution.
219
260
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ec2asgcapacityincreaseconfiguration-ungraceful}
220
261
  */
221
262
  Ungraceful?: Ec2Ungraceful | undefined;
@@ -225,10 +266,12 @@ export type Ec2AsgCapacityIncreaseConfiguration = {
225
266
  */
226
267
  export type Ec2AsgCapacityMonitoringApproach = "sampledMaxInLast24Hours" | "autoscalingMaxInLast24Hours";
227
268
  /**
269
+ * Configuration for handling failures when performing operations on EC2 resources.
228
270
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2ungraceful.html}
229
271
  */
230
272
  export type Ec2Ungraceful = {
231
273
  /**
274
+ * The minimum success percentage that you specify for EC2 Auto Scaling groups.
232
275
  * @min 0
233
276
  * @max 99
234
277
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ec2ungraceful.html#cfn-arcregionswitch-plan-ec2ungraceful-minimumsuccesspercentage}
@@ -236,30 +279,36 @@ export type Ec2Ungraceful = {
236
279
  MinimumSuccessPercentage: number;
237
280
  };
238
281
  /**
282
+ * The configuration for an AWS ECS capacity increase.
239
283
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html}
240
284
  */
241
285
  export type EcsCapacityIncreaseConfiguration = {
242
286
  /**
287
+ * The monitoring approach specified for the configuration, for example, `Most_Recent` .
243
288
  * @default "sampledMaxInLast24Hours"
244
289
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-capacitymonitoringapproach}
245
290
  */
246
291
  CapacityMonitoringApproach?: EcsCapacityMonitoringApproach | undefined;
247
292
  /**
293
+ * The services specified for the configuration.
248
294
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-services}
249
295
  */
250
296
  Services: Service[];
251
297
  /**
298
+ * The target percentage specified for the configuration.
252
299
  * @default 100
253
300
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-targetpercent}
254
301
  */
255
302
  TargetPercent?: number | undefined;
256
303
  /**
304
+ * The timeout value specified for the configuration.
257
305
  * @min 1
258
306
  * @default 60
259
307
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-timeoutminutes}
260
308
  */
261
309
  TimeoutMinutes?: number | undefined;
262
310
  /**
311
+ * The settings for ungraceful execution.
263
312
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecscapacityincreaseconfiguration.html#cfn-arcregionswitch-plan-ecscapacityincreaseconfiguration-ungraceful}
264
313
  */
265
314
  Ungraceful?: EcsUngraceful | undefined;
@@ -269,10 +318,12 @@ export type EcsCapacityIncreaseConfiguration = {
269
318
  */
270
319
  export type EcsCapacityMonitoringApproach = "sampledMaxInLast24Hours" | "containerInsightsMaxInLast24Hours";
271
320
  /**
321
+ * The settings for ungraceful execution.
272
322
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecsungraceful.html}
273
323
  */
274
324
  export type EcsUngraceful = {
275
325
  /**
326
+ * The minimum success percentage specified for the configuration.
276
327
  * @min 0
277
328
  * @max 99
278
329
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ecsungraceful.html#cfn-arcregionswitch-plan-ecsungraceful-minimumsuccesspercentage}
@@ -284,67 +335,81 @@ export type EcsUngraceful = {
284
335
  */
285
336
  export type EksCapacityMonitoringApproach = "sampledMaxInLast24Hours";
286
337
  /**
338
+ * The AWS EKS cluster execution block configuration.
287
339
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html}
288
340
  */
289
341
  export type EksCluster = {
290
342
  /**
343
+ * The Amazon Resource Name (ARN) of an AWS EKS cluster.
291
344
  * @pattern ^arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}$
292
345
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-clusterarn}
293
346
  */
294
347
  ClusterArn: string;
295
348
  /**
349
+ * The cross account role for the configuration.
296
350
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
297
351
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-crossaccountrole}
298
352
  */
299
353
  CrossAccountRole?: string | undefined;
300
354
  /**
355
+ * The external ID (secret key) for the configuration.
301
356
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-ekscluster.html#cfn-arcregionswitch-plan-ekscluster-externalid}
302
357
  */
303
358
  ExternalId?: string | undefined;
304
359
  };
305
360
  /**
361
+ * The AWS EKS resource scaling configuration.
306
362
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html}
307
363
  */
308
364
  export type EksResourceScalingConfiguration = {
309
365
  /**
366
+ * The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
310
367
  * @default "sampledMaxInLast24Hours"
311
368
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-capacitymonitoringapproach}
312
369
  */
313
370
  CapacityMonitoringApproach?: EksCapacityMonitoringApproach | undefined;
314
371
  /**
372
+ * The clusters for the configuration.
315
373
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-eksclusters}
316
374
  */
317
375
  EksClusters?: EksCluster[] | undefined;
318
376
  /**
377
+ * The Kubernetes resource type for the configuration.
319
378
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-kubernetesresourcetype}
320
379
  */
321
380
  KubernetesResourceType: KubernetesResourceType;
322
381
  /**
382
+ * The scaling resources for the configuration.
323
383
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-scalingresources}
324
384
  */
325
385
  ScalingResources?: Record<string, Record<string, KubernetesScalingResource>>[] | undefined;
326
386
  /**
387
+ * The target percentage for the configuration.
327
388
  * @min 1
328
389
  * @default 100
329
390
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-targetpercent}
330
391
  */
331
392
  TargetPercent?: number | undefined;
332
393
  /**
394
+ * The timeout value specified for the configuration.
333
395
  * @min 1
334
396
  * @default 60
335
397
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-timeoutminutes}
336
398
  */
337
399
  TimeoutMinutes?: number | undefined;
338
400
  /**
401
+ * The settings for ungraceful execution.
339
402
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingconfiguration.html#cfn-arcregionswitch-plan-eksresourcescalingconfiguration-ungraceful}
340
403
  */
341
404
  Ungraceful?: EksResourceScalingUngraceful | undefined;
342
405
  };
343
406
  /**
407
+ * The ungraceful settings for AWS EKS resource scaling.
344
408
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.html}
345
409
  */
346
410
  export type EksResourceScalingUngraceful = {
347
411
  /**
412
+ * The minimum success percentage for the configuration.
348
413
  * @min 0
349
414
  * @max 99
350
415
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-eksresourcescalingungraceful.html#cfn-arcregionswitch-plan-eksresourcescalingungraceful-minimumsuccesspercentage}
@@ -352,14 +417,17 @@ export type EksResourceScalingUngraceful = {
352
417
  MinimumSuccessPercentage: number;
353
418
  };
354
419
  /**
420
+ * Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.
355
421
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html}
356
422
  */
357
423
  export type ExecutionApprovalConfiguration = {
358
424
  /**
425
+ * The IAM approval role for the configuration.
359
426
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html#cfn-arcregionswitch-plan-executionapprovalconfiguration-approvalrole}
360
427
  */
361
428
  ApprovalRole: string;
362
429
  /**
430
+ * The timeout value specified for the configuration.
363
431
  * @min 1
364
432
  * @default 60
365
433
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionapprovalconfiguration.html#cfn-arcregionswitch-plan-executionapprovalconfiguration-timeoutminutes}
@@ -367,6 +435,7 @@ export type ExecutionApprovalConfiguration = {
367
435
  TimeoutMinutes?: number | undefined;
368
436
  };
369
437
  /**
438
+ * Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.
370
439
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-executionblockconfiguration.html}
371
440
  */
372
441
  export type ExecutionBlockConfiguration = {
@@ -395,38 +464,46 @@ export type ExecutionBlockConfiguration = {
395
464
  */
396
465
  export type ExecutionBlockType = "CustomActionLambda" | "ManualApproval" | "AuroraGlobalDatabase" | "EC2AutoScaling" | "ARCRoutingControl" | "ARCRegionSwitchPlan" | "Parallel" | "ECSServiceScaling" | "EKSResourceScaling" | "Route53HealthCheck";
397
466
  /**
467
+ * Configuration for Amazon Aurora global databases used in a Region switch plan.
398
468
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html}
399
469
  */
400
470
  export type GlobalAuroraConfiguration = {
401
471
  /**
472
+ * The behavior for a global database, that is, only allow switchover or also allow failover.
402
473
  * @default "switchoverOnly"
403
474
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-behavior}
404
475
  */
405
476
  Behavior: GlobalAuroraDefaultBehavior;
406
477
  /**
478
+ * The cross account role for the configuration.
407
479
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
408
480
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-crossaccountrole}
409
481
  */
410
482
  CrossAccountRole?: string | undefined;
411
483
  /**
484
+ * The database cluster Amazon Resource Names (ARNs) for a global database.
412
485
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-databaseclusterarns}
413
486
  */
414
487
  DatabaseClusterArns: string[];
415
488
  /**
489
+ * The external ID (secret key) for the configuration.
416
490
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-externalid}
417
491
  */
418
492
  ExternalId?: string | undefined;
419
493
  /**
494
+ * The global cluster identifier for a global database.
420
495
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-globalclusteridentifier}
421
496
  */
422
497
  GlobalClusterIdentifier: string;
423
498
  /**
499
+ * The timeout value specified for the configuration.
424
500
  * @min 1
425
501
  * @default 60
426
502
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-timeoutminutes}
427
503
  */
428
504
  TimeoutMinutes?: number | undefined;
429
505
  /**
506
+ * The settings for ungraceful execution.
430
507
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraconfiguration.html#cfn-arcregionswitch-plan-globalauroraconfiguration-ungraceful}
431
508
  */
432
509
  Ungraceful?: GlobalAuroraUngraceful | undefined;
@@ -436,10 +513,12 @@ export type GlobalAuroraConfiguration = {
436
513
  */
437
514
  export type GlobalAuroraDefaultBehavior = "switchoverOnly" | "failover";
438
515
  /**
516
+ * Configuration for handling failures when performing operations on Aurora global databases.
439
517
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraungraceful.html}
440
518
  */
441
519
  export type GlobalAuroraUngraceful = {
442
520
  /**
521
+ * The settings for ungraceful execution.
443
522
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-globalauroraungraceful.html#cfn-arcregionswitch-plan-globalauroraungraceful-ungraceful}
444
523
  */
445
524
  Ungraceful?: GlobalAuroraUngracefulBehavior | undefined;
@@ -449,41 +528,50 @@ export type GlobalAuroraUngraceful = {
449
528
  */
450
529
  export type GlobalAuroraUngracefulBehavior = "failover";
451
530
  /**
531
+ * Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.
452
532
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html}
453
533
  */
454
534
  export type KubernetesResourceType = {
455
535
  /**
536
+ * The API version type for the Kubernetes resource.
456
537
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html#cfn-arcregionswitch-plan-kubernetesresourcetype-apiversion}
457
538
  */
458
539
  ApiVersion: string;
459
540
  /**
541
+ * The kind for the Kubernetes resource.
460
542
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesresourcetype.html#cfn-arcregionswitch-plan-kubernetesresourcetype-kind}
461
543
  */
462
544
  Kind: string;
463
545
  };
464
546
  /**
547
+ * Defines a Kubernetes resource to scale in an Amazon EKS cluster.
465
548
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesscalingresource.html}
466
549
  */
467
550
  export type KubernetesScalingResource = {
468
551
  /**
552
+ * The hpaname for the Kubernetes resource.
469
553
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesscalingresource.html#cfn-arcregionswitch-plan-kubernetesscalingresource-hpaname}
470
554
  */
471
555
  HpaName?: string | undefined;
472
556
  /**
557
+ * The name for the Kubernetes resource.
473
558
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesscalingresource.html#cfn-arcregionswitch-plan-kubernetesscalingresource-name}
474
559
  */
475
560
  Name: string;
476
561
  /**
562
+ * The namespace for the Kubernetes resource.
477
563
  * @pattern ^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
478
564
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-kubernetesscalingresource.html#cfn-arcregionswitch-plan-kubernetesscalingresource-namespace}
479
565
  */
480
566
  Namespace: string;
481
567
  };
482
568
  /**
569
+ * Configuration for handling failures when invoking Lambda functions.
483
570
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdaungraceful.html}
484
571
  */
485
572
  export type LambdaUngraceful = {
486
573
  /**
574
+ * The ungraceful behavior for a Lambda function, which must be set to `skip` .
487
575
  * @default "skip"
488
576
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdaungraceful.html#cfn-arcregionswitch-plan-lambdaungraceful-behavior}
489
577
  */
@@ -494,28 +582,34 @@ export type LambdaUngraceful = {
494
582
  */
495
583
  export type LambdaUngracefulBehavior = "skip";
496
584
  /**
585
+ * Configuration for AWS Lambda functions used in a Region switch plan.
497
586
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html}
498
587
  */
499
588
  export type Lambdas = {
500
589
  /**
590
+ * The Amazon Resource Name (ARN) of the Lambda function.
501
591
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-arn}
502
592
  */
503
593
  Arn?: string | undefined;
504
594
  /**
595
+ * The cross account role for the configuration.
505
596
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
506
597
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-crossaccountrole}
507
598
  */
508
599
  CrossAccountRole?: string | undefined;
509
600
  /**
601
+ * The external ID (secret key) for the configuration.
510
602
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-lambdas.html#cfn-arcregionswitch-plan-lambdas-externalid}
511
603
  */
512
604
  ExternalId?: string | undefined;
513
605
  };
514
606
  /**
607
+ * Configuration for steps that should be executed in parallel during a Region switch.
515
608
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.html}
516
609
  */
517
610
  export type ParallelExecutionBlockConfiguration = {
518
611
  /**
612
+ * The steps for a parallel execution block.
519
613
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-parallelexecutionblockconfiguration.html#cfn-arcregionswitch-plan-parallelexecutionblockconfiguration-steps}
520
614
  */
521
615
  Steps: Step[];
@@ -525,20 +619,24 @@ export type ParallelExecutionBlockConfiguration = {
525
619
  */
526
620
  export type RecoveryApproach = "activeActive" | "activePassive";
527
621
  /**
622
+ * Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.
528
623
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html}
529
624
  */
530
625
  export type RegionSwitchPlanConfiguration = {
531
626
  /**
627
+ * The Amazon Resource Name (ARN) of the plan configuration.
532
628
  * @pattern ^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$
533
629
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn}
534
630
  */
535
631
  Arn: string;
536
632
  /**
633
+ * The cross account role for the configuration.
537
634
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
538
635
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole}
539
636
  */
540
637
  CrossAccountRole?: string | undefined;
541
638
  /**
639
+ * The external ID (secret key) for the configuration.
542
640
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid}
543
641
  */
544
642
  ExternalId?: string | undefined;
@@ -548,35 +646,42 @@ export type RegionSwitchPlanConfiguration = {
548
646
  */
549
647
  export type RegionToRunIn = "activatingRegion" | "deactivatingRegion";
550
648
  /**
649
+ * The Amazon Route 53 health check configuration.
551
650
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html}
552
651
  */
553
652
  export type Route53HealthCheckConfiguration = {
554
653
  /**
654
+ * The cross account role for the configuration.
555
655
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
556
656
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-crossaccountrole}
557
657
  */
558
658
  CrossAccountRole?: string | undefined;
559
659
  /**
660
+ * The external ID (secret key) for the configuration.
560
661
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-externalid}
561
662
  */
562
663
  ExternalId?: string | undefined;
563
664
  /**
665
+ * The Amazon Route 53 health check configuration hosted zone ID.
564
666
  * @minLength 1
565
667
  * @maxLength 32
566
668
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-hostedzoneid}
567
669
  */
568
670
  HostedZoneId: string;
569
671
  /**
672
+ * The Amazon Route 53 health check configuration record name.
570
673
  * @minLength 1
571
674
  * @maxLength 1024
572
675
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordname}
573
676
  */
574
677
  RecordName: string;
575
678
  /**
679
+ * The Amazon Route 53 health check configuration record sets.
576
680
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-recordsets}
577
681
  */
578
682
  RecordSets?: Route53ResourceRecordSet[] | undefined;
579
683
  /**
684
+ * The Amazon Route 53 health check configuration time out (in minutes).
580
685
  * @min 1
581
686
  * @default 60
582
687
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53healthcheckconfiguration.html#cfn-arcregionswitch-plan-route53healthcheckconfiguration-timeoutminutes}
@@ -584,16 +689,19 @@ export type Route53HealthCheckConfiguration = {
584
689
  TimeoutMinutes?: number | undefined;
585
690
  };
586
691
  /**
692
+ * The Amazon Route 53 record set.
587
693
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html}
588
694
  */
589
695
  export type Route53ResourceRecordSet = {
590
696
  /**
697
+ * The Amazon Route 53 record set identifier.
591
698
  * @minLength 1
592
699
  * @maxLength 1024
593
700
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html#cfn-arcregionswitch-plan-route53resourcerecordset-recordsetidentifier}
594
701
  */
595
702
  RecordSetIdentifier?: string | undefined;
596
703
  /**
704
+ * The Amazon Route 53 record set Region.
597
705
  * @pattern ^[a-z]{2}-[a-z-]+-\d+$
598
706
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-route53resourcerecordset.html#cfn-arcregionswitch-plan-route53resourcerecordset-region}
599
707
  */
@@ -604,106 +712,130 @@ export type Route53ResourceRecordSet = {
604
712
  */
605
713
  export type RoutingControlStateChange = "On" | "Off";
606
714
  /**
715
+ * The service for a cross account role.
607
716
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html}
608
717
  */
609
718
  export type Service = {
610
719
  /**
720
+ * The cluster Amazon Resource Name (ARN) for a service.
611
721
  * @pattern ^arn:aws:ecs:[a-z0-9-]+:\d{12}:cluster/[a-zA-Z0-9_-]{1,255}$
612
722
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-clusterarn}
613
723
  */
614
724
  ClusterArn?: string | undefined;
615
725
  /**
726
+ * The cross account role for a service.
616
727
  * @pattern ^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$
617
728
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-crossaccountrole}
618
729
  */
619
730
  CrossAccountRole?: string | undefined;
620
731
  /**
732
+ * The external ID (secret key) for the service.
621
733
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-externalid}
622
734
  */
623
735
  ExternalId?: string | undefined;
624
736
  /**
737
+ * The Amazon Resource Name (ARN) for a service.
625
738
  * @pattern ^arn:aws:ecs:[a-z0-9-]+:\d{12}:service/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]{1,255}$
626
739
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-service.html#cfn-arcregionswitch-plan-service-servicearn}
627
740
  */
628
741
  ServiceArn?: string | undefined;
629
742
  };
630
743
  /**
744
+ * Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.
631
745
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html}
632
746
  */
633
747
  export type Step = {
634
748
  /**
749
+ * The description of a step in a workflow.
635
750
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-description}
636
751
  */
637
752
  Description?: string | undefined;
638
753
  /**
754
+ * The configuration for an execution block in a workflow.
639
755
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblockconfiguration}
640
756
  */
641
757
  ExecutionBlockConfiguration: ExecutionBlockConfiguration;
642
758
  /**
759
+ * The type of an execution block in a workflow.
643
760
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-executionblocktype}
644
761
  */
645
762
  ExecutionBlockType: ExecutionBlockType;
646
763
  /**
764
+ * The name of a step in a workflow.
647
765
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-step.html#cfn-arcregionswitch-plan-step-name}
648
766
  */
649
767
  Name: string;
650
768
  };
651
769
  /**
770
+ * Defines a condition that can automatically trigger the execution of a Region switch plan.
652
771
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html}
653
772
  */
654
773
  export type Trigger = {
655
774
  /**
775
+ * The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
656
776
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-action}
657
777
  */
658
778
  Action: WorkflowTargetAction;
659
779
  /**
780
+ * The conditions that must be met for the trigger to fire.
660
781
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-conditions}
661
782
  */
662
783
  Conditions: TriggerCondition[];
663
784
  /**
785
+ * The description for a trigger.
664
786
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-description}
665
787
  */
666
788
  Description?: string | undefined;
667
789
  /**
790
+ * The minimum time, in minutes, that must elapse between automatic executions of the plan.
668
791
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-mindelayminutesbetweenexecutions}
669
792
  */
670
793
  MinDelayMinutesBetweenExecutions: number;
671
794
  /**
795
+ * The AWS Region for a trigger.
672
796
  * @pattern ^[a-z]{2}-[a-z-]+-\d+$
673
797
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-trigger.html#cfn-arcregionswitch-plan-trigger-targetregion}
674
798
  */
675
799
  TargetRegion: string;
676
800
  };
677
801
  /**
802
+ * Defines a condition that must be met for a trigger to fire.
678
803
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html}
679
804
  */
680
805
  export type TriggerCondition = {
681
806
  /**
807
+ * The name of the CloudWatch alarm associated with the condition.
682
808
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html#cfn-arcregionswitch-plan-triggercondition-associatedalarmname}
683
809
  */
684
810
  AssociatedAlarmName: string;
685
811
  /**
812
+ * The condition that must be met. Valid values include ALARM and OK.
686
813
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-triggercondition.html#cfn-arcregionswitch-plan-triggercondition-condition}
687
814
  */
688
815
  Condition: AlarmCondition;
689
816
  };
690
817
  /**
818
+ * Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.
691
819
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html}
692
820
  */
693
821
  export type Workflow = {
694
822
  /**
823
+ * The steps that make up the workflow.
695
824
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-steps}
696
825
  */
697
826
  Steps?: Step[] | undefined;
698
827
  /**
828
+ * The description of the workflow.
699
829
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowdescription}
700
830
  */
701
831
  WorkflowDescription?: string | undefined;
702
832
  /**
833
+ * The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
703
834
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetaction}
704
835
  */
705
836
  WorkflowTargetAction: WorkflowTargetAction;
706
837
  /**
838
+ * The AWS Region that the workflow targets.
707
839
  * @pattern ^[a-z]{2}-[a-z-]+-\d+$
708
840
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-workflow.html#cfn-arcregionswitch-plan-workflow-workflowtargetregion}
709
841
  */