AWS cli documentation change
Summary
Added LambdaEventSourceMapping configuration option to region switch plans, including timeout settings, enable/disable actions, cross-account role support with external IDs, and ungraceful execution handling. Updated AWS CLI version references and clarified default target percentages for EC2 Auto Scaling groups.
Security assessment
The change adds security documentation for cross-account access using IAM roles with external IDs (security best practice) but doesn't address any existing vulnerability. The external ID field helps prevent confused deputy problems.
Diff
diff --git a/cli/latest/reference/arc-region-switch/create-plan.md b/cli/latest/reference/arc-region-switch/create-plan.md index 96fb50bf6..e8ba68ca5 100644 --- a//cli/latest/reference/arc-region-switch/create-plan.md +++ b//cli/latest/reference/arc-region-switch/create-plan.md @@ -15 +15 @@ - * [AWS CLI 2.34.45 Command Reference](../../index.html) » + * [AWS CLI 2.34.48 Command Reference](../../index.html) » @@ -140 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `customActionLambdaConfig`, `ec2AsgCapacityIncreaseConfig`, `executionApprovalConfig`, `arcRoutingControlConfig`, `globalAuroraConfig`, `parallelConfig`, `regionSwitchPlanConfig`, `ecsCapacityIncreaseConfig`, `eksResourceScalingConfig`, `route53HealthCheckConfig`, `documentDbConfig`, `rdsPromoteReadReplicaConfig`, `rdsCreateCrossRegionReadReplicaConfig`. +>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `customActionLambdaConfig`, `ec2AsgCapacityIncreaseConfig`, `executionApprovalConfig`, `arcRoutingControlConfig`, `globalAuroraConfig`, `parallelConfig`, `regionSwitchPlanConfig`, `ecsCapacityIncreaseConfig`, `eksResourceScalingConfig`, `route53HealthCheckConfig`, `documentDbConfig`, `rdsPromoteReadReplicaConfig`, `rdsCreateCrossRegionReadReplicaConfig`, `lambdaEventSourceMappingConfig`. @@ -290 +290 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>> The target percentage that you specify for EC2 Auto Scaling groups. +>>>>>>> The target percentage that you specify for EC2 Auto Scaling groups. The default is 100. @@ -479 +479 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `customActionLambdaConfig`, `ec2AsgCapacityIncreaseConfig`, `executionApprovalConfig`, `arcRoutingControlConfig`, `globalAuroraConfig`, `parallelConfig`, `regionSwitchPlanConfig`, `ecsCapacityIncreaseConfig`, `eksResourceScalingConfig`, `route53HealthCheckConfig`, `documentDbConfig`, `rdsPromoteReadReplicaConfig`, `rdsCreateCrossRegionReadReplicaConfig`. +>>>>>>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `customActionLambdaConfig`, `ec2AsgCapacityIncreaseConfig`, `executionApprovalConfig`, `arcRoutingControlConfig`, `globalAuroraConfig`, `parallelConfig`, `regionSwitchPlanConfig`, `ecsCapacityIncreaseConfig`, `eksResourceScalingConfig`, `route53HealthCheckConfig`, `documentDbConfig`, `rdsPromoteReadReplicaConfig`, `rdsCreateCrossRegionReadReplicaConfig`, `lambdaEventSourceMappingConfig`. @@ -629 +629 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>>>>>> The target percentage that you specify for EC2 Auto Scaling groups. +>>>>>>>>>>> The target percentage that you specify for EC2 Auto Scaling groups. The default is 100. @@ -904 +904 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>>>>>> The target percentage specified for the configuration. +>>>>>>>>>>> The target percentage specified for the configuration. The default is 100. @@ -1044 +1044 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>>>>>> The target percentage for the configuration. +>>>>>>>>>>> The target percentage for the configuration. The default is 100. @@ -1310,0 +1311,86 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re +>>>>>>>>> +>>>>>>>>> lambdaEventSourceMappingConfig -> (structure) +>>>>>>>>> +>>>>>>>>>> A Lambda event source mapping execution block. +>>>>>>>>>> +>>>>>>>>>> timeoutMinutes -> (integer) +>>>>>>>>>> +>>>>>>>>>>> The timeout value specified for the configuration. +>>>>>>>>>>> +>>>>>>>>>>> Constraints: +>>>>>>>>>>> +>>>>>>>>>>> * min: `1` +>>>>>>>>>>> + +>>>>>>>>>> +>>>>>>>>>> action -> (string) [required] +>>>>>>>>>> +>>>>>>>>>>> The action to take - whether to `enable` or `disable` an event source mapping. +>>>>>>>>>>> +>>>>>>>>>>> Possible values: +>>>>>>>>>>> +>>>>>>>>>>> * `enable` +>>>>>>>>>>> * `disable` +>>>>>>>>>>> + +>>>>>>>>>> +>>>>>>>>>> regionEventSourceMappings -> (map) [required] +>>>>>>>>>> +>>>>>>>>>>> Per-region configuration for which Lambda event source mapping to enable or disable when activating or deactivating a region. +>>>>>>>>>>> +>>>>>>>>>>> Constraints: +>>>>>>>>>>> +>>>>>>>>>>> * min: `1` +>>>>>>>>>>> * max: `2` +>>>>>>>>>>> + +>>>>>>>>>>> +>>>>>>>>>>> key -> (string) +>>>>>>>>>>> +>>>>>>>>>>>> Constraints: +>>>>>>>>>>>> +>>>>>>>>>>>> * pattern: `[a-z]{2}-[a-z-]+-\d+` +>>>>>>>>>>>> + +>>>>>>>>>>> +>>>>>>>>>>> value -> (structure) +>>>>>>>>>>> +>>>>>>>>>>>> The Amazon Web Services Lambda event source mapping configuration, containing the resource ARN and optional cross-account configuration. +>>>>>>>>>>>> +>>>>>>>>>>>> crossAccountRole -> (string) +>>>>>>>>>>>> +>>>>>>>>>>>>> The cross account role for the configuration. +>>>>>>>>>>>>> +>>>>>>>>>>>>> Constraints: +>>>>>>>>>>>>> +>>>>>>>>>>>>> * pattern: `arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+` +>>>>>>>>>>>>> + +>>>>>>>>>>>> +>>>>>>>>>>>> externalId -> (string) +>>>>>>>>>>>> +>>>>>>>>>>>>> The external ID (secret key) for the configuration. +>>>>>>>>>>>> +>>>>>>>>>>>> arn -> (string) [required] +>>>>>>>>>>>> +>>>>>>>>>>>>> The Amazon Resource Name (ARN) of the Lambda event source mapping. +>>>>>>>>>>>>> +>>>>>>>>>>>>> Constraints: +>>>>>>>>>>>>> +>>>>>>>>>>>>> * pattern: `arn:aws[a-zA-Z-]*:lambda:[a-z0-9-]+:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` +>>>>>>>>>>>>> + +>>>>>>>>>> +>>>>>>>>>> ungraceful -> (structure) +>>>>>>>>>> +>>>>>>>>>>> The settings for ungraceful execution. +>>>>>>>>>>> +>>>>>>>>>>> behavior -> (string) +>>>>>>>>>>> +>>>>>>>>>>>> Set to `skip` to skip executing this event source mapping step during an ungraceful execution. +>>>>>>>>>>>> +>>>>>>>>>>>> Possible values: +>>>>>>>>>>>> +>>>>>>>>>>>> * `skip` +>>>>>>>>>>>> + @@ -1330,0 +1417 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re +>>>>>>>>> * `LambdaEventSourceMapping` @@ -1442 +1529 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>> The target percentage specified for the configuration. +>>>>>>> The target percentage specified for the configuration. The default is 100. @@ -1582 +1669 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re ->>>>>>> The target percentage for the configuration. +>>>>>>> The target percentage for the configuration. The default is 100. @@ -1848,0 +1936,86 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re +>>>>> +>>>>> lambdaEventSourceMappingConfig -> (structure) +>>>>> +>>>>>> A Lambda event source mapping execution block. +>>>>>> +>>>>>> timeoutMinutes -> (integer) +>>>>>> +>>>>>>> The timeout value specified for the configuration. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * min: `1` +>>>>>>> + +>>>>>> +>>>>>> action -> (string) [required] +>>>>>> +>>>>>>> The action to take - whether to `enable` or `disable` an event source mapping. +>>>>>>> +>>>>>>> Possible values: +>>>>>>> +>>>>>>> * `enable` +>>>>>>> * `disable` +>>>>>>> + +>>>>>> +>>>>>> regionEventSourceMappings -> (map) [required] +>>>>>> +>>>>>>> Per-region configuration for which Lambda event source mapping to enable or disable when activating or deactivating a region. +>>>>>>> +>>>>>>> Constraints: +>>>>>>> +>>>>>>> * min: `1` +>>>>>>> * max: `2` +>>>>>>> + +>>>>>>> +>>>>>>> key -> (string) +>>>>>>> +>>>>>>>> Constraints: +>>>>>>>> +>>>>>>>> * pattern: `[a-z]{2}-[a-z-]+-\d+` +>>>>>>>> + +>>>>>>> +>>>>>>> value -> (structure) +>>>>>>> +>>>>>>>> The Amazon Web Services Lambda event source mapping configuration, containing the resource ARN and optional cross-account configuration. +>>>>>>>> +>>>>>>>> crossAccountRole -> (string) +>>>>>>>> +>>>>>>>>> The cross account role for the configuration. +>>>>>>>>> +>>>>>>>>> Constraints: +>>>>>>>>> +>>>>>>>>> * pattern: `arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+` +>>>>>>>>> + +>>>>>>>> +>>>>>>>> externalId -> (string) +>>>>>>>> +>>>>>>>>> The external ID (secret key) for the configuration. +>>>>>>>> +>>>>>>>> arn -> (string) [required] +>>>>>>>> +>>>>>>>>> The Amazon Resource Name (ARN) of the Lambda event source mapping. +>>>>>>>>> +>>>>>>>>> Constraints: +>>>>>>>>> +>>>>>>>>> * pattern: `arn:aws[a-zA-Z-]*:lambda:[a-z0-9-]+:\d{12}:event-source-mapping:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` +>>>>>>>>> + +>>>>>> +>>>>>> ungraceful -> (structure) +>>>>>> +>>>>>>> The settings for ungraceful execution. +>>>>>>> +>>>>>>> behavior -> (string) +>>>>>>>