TemplateActionDocument
Contents
- actionID
-
Template post migration custom action ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-zA-Z]$Required: No
- actionName
-
Template post migration custom action name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- active
-
Template post migration custom action active status.
Type: Boolean
Required: No
- category
-
Template post migration custom action category.
Type: String
Valid Values:
DISASTER_RECOVERY | OPERATING_SYSTEM | LICENSE_AND_SUBSCRIPTION | VALIDATION | OBSERVABILITY | REFACTORING | SECURITY | NETWORKING | CONFIGURATION | BACKUP | OTHERRequired: No
- description
-
Template post migration custom action description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
^[0-9a-zA-Z ():/.,'-_#*; ]*$Required: No
- documentIdentifier
-
Template post migration custom action document identifier.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- documentVersion
-
Template post migration custom action document version.
Type: String
Pattern:
^(\$DEFAULT|\$LATEST|[0-9]+)$Required: No
- externalParameters
-
Template post migration custom action 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
-
Template post migration custom action must succeed for cutover.
Type: Boolean
Required: No
- operatingSystem
-
Operating system eligible for this template post migration custom action.
Type: String
Pattern:
^(linux|windows)$Required: No
- order
-
Template post migration custom action order.
Type: Integer
Valid Range: Minimum value of 1001. Maximum value of 10000.
Required: No
- parameters
-
Template post migration custom action 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
-
Template post migration custom action timeout in 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:
