software.amazon.awscdk.services.codepipeline

Interface CustomActionProperty

All Known Implementing Classes:

CustomActionProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:02.358Z")
public interface 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 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 and Description
static class	CustomActionProperty.Builder A builder for CustomActionProperty
static class	CustomActionProperty.Jsii$Proxy An implementation for CustomActionProperty

Method Summary

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

Method Detail

getName

java.lang.String getName()

The name of the property.

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

getRequired

java.lang.Boolean getRequired()

Whether this property is required.

getDescription

default java.lang.String getDescription()

The description of the property.

Default: the description will be empty

getKey

default java.lang.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

default java.lang.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

default java.lang.Boolean getSecret()

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

Default: false

getType

default java.lang.String getType()

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

Default: 'String'

builder

static CustomActionProperty.Builder builder()

Returns:

a CustomActionProperty.Builder of CustomActionProperty