SsmDocumentConfig

The Systems Manager document to run and the managed nodes to target for a single AWS Region.

documentArn

The Amazon Resource Name (ARN) of the Systems Manager document to run.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 256.

Pattern: arn:[a-z0-9\-]+:ssm:[a-z0-9\-]+:([0-9]{12})?:document/[a-zA-Z0-9_.\-]+

Required: Yes

targets

The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

Type: Array of SsmTarget objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

crossAccountRole

The cross-account role for the configuration.

Type: String

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

Required: No

documentVersion

The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

Type: String

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

Pattern: ([$]LATEST|[$]DEFAULT|[1-9][0-9]*)

Required: No

externalId

The external ID (secret key) for the configuration.

Type: String

Required: No

parameters

The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

Type: String to array of strings map

Map Entries: Minimum number of 0 items. Maximum number of 30 items.

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Pattern: .{1,65535}

Required: No

SsmDocumentConfig

Contents

See Also