View a markdown version of this page

SsmSendCommandConfiguration - Amazon Application Recovery Controller

SsmSendCommandConfiguration

Configuration for an AWS Systems Manager SendCommand execution block in a Region switch plan. This execution block runs a Systems Manager document on the managed nodes that you target in each AWS Region of the plan.

Contents

regionDocuments

The Systems Manager document and target configuration for each AWS Region in the plan. Provide an entry for each AWS Region that you want the command to run in.

Type: String to SsmDocumentConfig object map

Map Entries: Maximum number of 2 items.

Key Pattern: [a-z]{2}-[a-z-]+-\d+

Required: Yes

retryIntervalMinutes

How often, in minutes, Region switch retries the command if it returns a failure.

Type: Float

Required: Yes

timeoutMinutes

The timeout value specified for the configuration.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

ungraceful

Specifies the settings that determine how the execution block behaves when the plan runs ungracefully, such as whether to skip the command.

Type: SsmSendCommandUngraceful object

Required: No

See Also

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