View a markdown version of this page

Lambdas - Amazon Application Recovery Controller
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Lambdas

Configuration for Amazon Lambda functions used in a Region switch plan.

Contents

arn

The Amazon Resource Name (ARN) of the Lambda function.

Type: String

Required: No

crossAccountRole

The cross account role for the configuration.

Type: String

Pattern: arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+

Required: No

externalId

The external ID (secret key) for the configuration.

Type: String

Required: No

payload

The JSON payload to send to the Lambda function invocation. If you don't specify a payload, Region switch invokes the function with only the execution metadata.

If you provide a JSON object, Region switch merges execution metadata keys (InvokedBy, PlanArn, ExecutionId, StepName) into the top level. If one of your keys has the same name as a metadata key, your key takes precedence.

If you provide any other JSON type (string, number, boolean, or array), Region switch forwards it to the Lambda function unchanged, without adding metadata.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 786432.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: