CommandParameter
A map of key-value pairs that describe the command.
Contents
- name
-
The name of a specific parameter used in a command and command execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 192.
Pattern:
^[.$a-zA-Z0-9_-]+$Required: Yes
- defaultValue
-
The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.
Type: CommandParameterValue object
Required: No
- description
-
The description of the command parameter.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]*Required: No
- type
-
The type of the command parameter.
Type: String
Valid Values:
STRING | INTEGER | DOUBLE | LONG | UNSIGNEDLONG | BOOLEAN | BINARYRequired: No
- value
-
Parameter value that overrides the default value, if set.
Type: CommandParameterValue object
Required: No
- valueConditions
-
The list of conditions that a command parameter value must satisfy to create a command execution.
Type: Array of CommandParameterValueCondition objects
Array Members: Minimum number of 1 item.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
