aws-cdk-lib.aws_codepipeline.CustomActionProperty

interface CustomActionProperty

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.CustomActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CustomActionProperty
Javasoftware.amazon.awscdk.services.codepipeline.CustomActionProperty
Pythonaws_cdk.aws_codepipeline.CustomActionProperty
TypeScript (source)aws-cdk-lib » 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 { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const customActionProperty: codepipeline.CustomActionProperty = {
  name: 'name',
  required: false,

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

Properties

NameTypeDescription
namestringThe name of the property.
requiredbooleanWhether this property is required.
description?stringThe description of the property.
key?booleanWhether this property is a key.
queryable?booleanWhether this property is queryable.
secret?booleanWhether this property is secret, like a password, or access key.
type?stringThe 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'.