ActionConfigurationProperty
Represents information about an action configuration property.
Contents
- key
-
Whether the configuration property is a key.
Type: Boolean
Required: Yes
- name
-
The name of the action configuration property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
- required
-
Whether the configuration property is a required value.
Type: Boolean
Required: Yes
- secret
-
Whether the configuration property is secret. Secrets are hidden from all calls except for
GetJobDetails
,GetThirdPartyJobDetails
,PollForJobs
, andPollForThirdPartyJobs
.When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
Type: Boolean
Required: Yes
- description
-
The description of the action configuration property that is displayed to users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 160.
Required: No
- queryable
-
Indicates that the property is used with
PollForJobs
. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
Type: Boolean
Required: No
- type
-
The type of the configuration property.
Type: String
Valid Values:
String | Number | Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: