AWS CodePipeline CustomActionType ConfigurationProperties
ConfigurationProperties
is a property of the AWS::CodePipeline::CustomActionType resource that defines a
configuration for an AWS CodePipeline custom action.
Syntax
JSON
{ "
Description
" :String
, "Key
" :Boolean
, "Name
" :String
, "Queryable
" :Boolean
, "Required
" :Boolean
, "Secret
" :Boolean
, "Type
" :String
}
YAML
Description
:String
Key
:Boolean
Name
:String
Queryable
:Boolean
Required
:Boolean
Secret
:Boolean
Type
:String
Properties
Description
-
A description of this configuration property that will be displayed to users.
Required: No
Type: String
Key
-
Indicates whether the configuration property is a key.
Required: Yes
Type: Boolean
Name
-
A name for this configuration property.
Required: Yes
Type: String
Queryable
-
Indicates whether the configuration property will be used with the
PollForJobs
call. A custom action can have one queryable property. The queryable property must be required (see theRequired
property) and must not be secret (see theSecret
property). For more information, see thequeryable
contents for the ActionConfigurationProperty data type in the AWS CodePipeline API Reference.Required: No
Type: Boolean
Required
-
Indicates whether the configuration property is a required value.
Required: Yes
Type: Boolean
Secret
-
Indicates whether the configuration property is secret. Secret configuration properties are hidden from all AWS CodePipeline calls except for
GetJobDetails
,GetThirdPartyJobDetails
,PollForJobs
, andPollForThirdPartyJobs
.Required: Yes
Type: Boolean
Type
-
The type of the configuration property, such as
String
,Number
, orBoolean
.Required: No
Type: String