SsmDocument
AWS Systems Manager Document.
Contents
- actionName
-
User-friendly name for the AWS Systems Manager Document.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
- ssmDocumentName
-
AWS Systems Manager Document name or full ARN.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 172.
Pattern:
^([A-Za-z0-9/:_\.-])+$Required: Yes
- externalParameters
-
AWS Systems Manager Document external parameters.
Type: String to SsmExternalParameter object map
Map Entries: Minimum number of 0 items. Maximum number of 20 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1011.
Key Pattern:
^([A-Za-z0-9])+$Required: No
- mustSucceedForCutover
-
If true, Cutover will not be enabled if the document has failed.
Type: Boolean
Required: No
- parameters
-
AWS Systems Manager Document parameters.
Type: String to array of SsmParameterStoreParameter objects map
Map Entries: Minimum number of 0 items. Maximum number of 20 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1011.
Key Pattern:
^([A-Za-z0-9])+$Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- timeoutSeconds
-
AWS Systems Manager Document timeout seconds.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
