AWS cli medium security documentation change
Summary
Added LambdaEventSourceMappingConfig to region switch plans, including cross-account security parameters and default value clarifications
Security assessment
The change introduces 'externalId' field described as a 'secret key' for cross-account configurations, which is a security feature for access control. It also documents IAM role patterns and adds security constraints for cross-account Lambda event source mappings.
Diff
diff --git a/cli/latest/reference/arc-region-switch/update-plan.md b/cli/latest/reference/arc-region-switch/update-plan.md index b3d1836b3..f6d84aded 100644 --- a//cli/latest/reference/arc-region-switch/update-plan.md +++ b//cli/latest/reference/arc-region-switch/update-plan.md @@ -15 +15 @@ - * [AWS CLI 2.34.45 Command Reference](../../index.html) » + * [AWS CLI 2.34.48 Command Reference](../../index.html) » @@ -144 +144 @@ 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`. @@ -294 +294 @@ 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. @@ -483 +483 @@ 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`. @@ -633 +633 @@ 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. @@ -908 +908 @@ 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. @@ -1048 +1048 @@ 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. @@ -1314,0 +1315,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` +>>>>>>>>>>>> + @@ -1334,0 +1421 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/arc-re +>>>>>>>>> * `LambdaEventSourceMapping` @@ -1446 +1533 @@ 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. @@ -1586 +1673 @@ 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. @@ -1852,0 +1940,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) +>>>>>>>