Package 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(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();

  • Method Details

    • getKey

      @Stability(Stable) @NotNull Object getKey()
      Whether the configuration property is a key.

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the action configuration property.

    • getRequired

      @Stability(Stable) @NotNull Object getRequired()
      Whether the configuration property is a required value.

    • getSecret

      @Stability(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(Stable) @Nullable default String getDescription()
      The description of the action configuration property that is displayed to users.

    • getQueryable

      @Stability(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(Stable) @Nullable default String getType()
      The type of the configuration property.

    • builder

      @Stability(Stable) static CfnCustomActionType.ConfigurationPropertiesProperty.Builder builder()
      Returns:
      a CfnCustomActionType.ConfigurationPropertiesProperty.Builder of CfnCustomActionType.ConfigurationPropertiesProperty