Interface CustomActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CustomActionProperty.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:13.197Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCustomActionProperty
static final class
An implementation forCustomActionProperty
-
Method Summary
Modifier and TypeMethodDescriptionstatic CustomActionProperty.Builder
builder()
default String
The description of the property.default Boolean
getKey()
Whether this property is a key.getName()
The name of the property.default Boolean
Whether this property is queryable.Whether this property is required.default Boolean
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
The name of the property.You use this name in the
configuration
attribute when defining your custom Action class. -
getRequired
Whether this property is required. -
getDescription
The description of the property.Default: the description will be empty
-
getKey
Whether this property is a key.Default: false
- See Also:
-
getQueryable
Whether this property is queryable.Note that only a single property of a custom Action can be queryable.
Default: false
- See Also:
-
getSecret
Whether this property is secret, like a password, or access key.Default: false
-
getType
The type of the property, like 'String', 'Number', or 'Boolean'.Default: 'String'
-
builder
- Returns:
- a
CustomActionProperty.Builder
ofCustomActionProperty
-