AWS::CodePipeline::CustomActionType ConfigurationProperties

The configuration properties for the custom action.

Note

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

Syntax

To declare this entity in your AWS CloudFormation template, use the following 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

The description of the action configuration property that is displayed to users.

Required: No

Type: String

Minimum: 1

Maximum: 160

Update requires: No interruption

Key

Whether the configuration property is a key.

Required: Yes

Type: Boolean

Update requires: No interruption

Name

The name of the action configuration property.

Required: Yes

Type: String

Minimum: 1

Maximum: 50

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Required

Whether the configuration property is a required value.

Required: Yes

Type: Boolean

Update requires: No interruption

Secret

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

Required: Yes

Type: Boolean

Update requires: No interruption

Type

The type of the configuration property.

Required: No

Type: String

Allowed values: Boolean | Number | String

Update requires: No interruption