Package software.amazon.awscdk.services.codepipeline

Interface CustomActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomActionProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:36.919Z")
@Stability(Stable)
public interface CustomActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.codepipeline.*;
 CustomActionProperty customActionProperty = CustomActionProperty.builder()
         .name("name")
         .required(false)
         // the properties below are optional
         .description("description")
         .key(false)
         .queryable(false)
         .secret(false)
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomActionProperty.Builder	A builder for CustomActionProperty
static final class	CustomActionProperty.Jsii$Proxy	An implementation for CustomActionProperty

Method Summary

Modifier and Type	Method	Description
static CustomActionProperty.Builder	builder()
default String	getDescription()	The description of the property.
default Boolean	getKey()	Whether this property is a key.
String	getName()	The name of the property.
default Boolean	getQueryable()	Whether this property is queryable.
Boolean	getRequired()	Whether this property is required.
default Boolean	getSecret()	Whether this property is secret, like a password, or access key.
default String	getType()	The type of the property, like 'String', 'Number', or 'Boolean'.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the property.

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

getRequired

@Stability(Stable)
@NotNull
Boolean getRequired()

Whether this property is required.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the property.

Default: the description will be empty

getKey

@Stability(Stable)
@Nullable
default Boolean getKey()

Whether this property is a key.

Default: false

See Also:

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

getQueryable

@Stability(Stable)
@Nullable
default Boolean getQueryable()

Whether this property is queryable.

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

Default: false

See Also:

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

getSecret

@Stability(Stable)
@Nullable
default Boolean getSecret()

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

Default: false

getType

@Stability(Stable)
@Nullable
default String getType()

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

Default: 'String'

builder

@Stability(Stable)
static CustomActionProperty.Builder builder()

Returns:

a CustomActionProperty.Builder of CustomActionProperty