software.amazon.awscdk.services.codepipeline

Interface CfnCustomActionType.ConfigurationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomActionType.ConfigurationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnCustomActionType

@Stability(value=Stable)
public static interface CfnCustomActionType.ConfigurationPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline .

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.*;
 ConfigurationPropertiesProperty configurationPropertiesProperty = ConfigurationPropertiesProperty.builder()
         .key(false)
         .name("name")
         .required(false)
         .secret(false)
         // the properties below are optional
         .description("description")
         .queryable(false)
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCustomActionType.ConfigurationPropertiesProperty.Builder	builder()
default String	getDescription() The description of the action configuration property that is displayed to users.
Object	getKey() Whether the configuration property is a key.
String	getName() The name of the action configuration property.
default Object	getQueryable() Indicates that the property is used with `PollForJobs` .
Object	getRequired() Whether the configuration property is a required value.
Object	getSecret() Whether the configuration property is secret.
default String	getType() The type of the configuration property.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKey

@Stability(value=Stable)
 @NotNull
Object getKey()

Whether the configuration property is a key.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the action configuration property.

getRequired

@Stability(value=Stable)
 @NotNull
Object getRequired()

Whether the configuration property is a required value.

getSecret

@Stability(value=Stable)
 @NotNull
Object getSecret()

Whether the configuration property is secret.

Secrets are hidden from all calls except for GetJobDetails , GetThirdPartyJobDetails , PollForJobs , and PollForThirdPartyJobs .

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

getDescription

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

The description of the action configuration property that is displayed to users.

getQueryable

@Stability(value=Stable)
 @Nullable
default Object getQueryable()

Indicates that the property is used with `PollForJobs` .

When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

getType

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

The type of the configuration property.

builder

@Stability(value=Stable)
static CfnCustomActionType.ConfigurationPropertiesProperty.Builder builder()

Returns:

a CfnCustomActionType.ConfigurationPropertiesProperty.Builder of CfnCustomActionType.ConfigurationPropertiesProperty