interface CustomActionProperty

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.CustomActionProperty
Java	software.amazon.awscdk.services.codepipeline.CustomActionProperty
Python	aws_cdk.aws_codepipeline.CustomActionProperty
TypeScript (source)	@aws-cdk/aws-codepipeline » CustomActionProperty

The creation attributes used for defining a configuration property of a custom Action.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
const customActionProperty: codepipeline.CustomActionProperty = {
  name: 'name',
  required: false,

  // the properties below are optional
  description: 'description',
  key: false,
  queryable: false,
  secret: false,
  type: 'type',
};

Properties

Name	Type	Description
name	string	The name of the property.
required	boolean	Whether this property is required.
description?	string	The description of the property.
key?	boolean	Whether this property is a key.
queryable?	boolean	Whether this property is queryable.
secret?	boolean	Whether this property is secret, like a password, or access key.
type?	string	The type of the property, like 'String', 'Number', or 'Boolean'.

---

name

Type: string

The name of the property.

You use this name in the configuration attribute when defining your custom Action class.

---

required

Type: boolean

Whether this property is required.

---

description?

Type: string (optional, default: the description will be empty)

The description of the property.

---

key?

Type: boolean (optional, default: false)

Whether this property is a key.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key

---

queryable?

Type: boolean (optional, default: false)

Whether this property is queryable.

Note that only a single property of a custom Action can be queryable.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable

---

secret?

Type: boolean (optional, default: false)

Whether this property is secret, like a password, or access key.

---

type?

Type: string (optional, default: 'String')

The type of the property, like 'String', 'Number', or 'Boolean'.