CustomActionProperty Struct
The creation attributes used for defining a configuration property of a custom Action.
Example
ts
// 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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the property.
Default: the description will be empty
Whether this property is a key.
The name of the property.
You use this name in the configuration attribute when defining your custom Action class.
queryableoptionalbooleanqueryableoptionalboolqueryableoptionalBooleanQueryableoptionalboolQueryableoptional*bool= false#Whether this property is queryable.
Note that only a single property of a custom Action can be queryable.
Whether this property is required.
secretoptionalbooleansecretoptionalboolsecretoptionalBooleanSecretoptionalboolSecretoptional*bool= false#Whether this property is secret, like a password, or access key.
The type of the property, like 'String', 'Number', or 'Boolean'.