Package software.amazon.awscdk.services.codepipeline

Class CfnCustomActionType

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.codepipeline.CfnCustomActionType
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.876Z") @Stability(Stable) public class CfnCustomActionType extends CfnResource implements IInspectable
A CloudFormation AWS::CodePipeline::CustomActionType.

The AWS::CodePipeline::CustomActionType resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. For more information, see Create and Add a Custom Action in AWS CodePipeline in the AWS CodePipeline User Guide .

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.*;
 CfnCustomActionType cfnCustomActionType = CfnCustomActionType.Builder.create(this, "MyCfnCustomActionType")
         .category("category")
         .inputArtifactDetails(ArtifactDetailsProperty.builder()
                 .maximumCount(123)
                 .minimumCount(123)
                 .build())
         .outputArtifactDetails(ArtifactDetailsProperty.builder()
                 .maximumCount(123)
                 .minimumCount(123)
                 .build())
         .provider("provider")
         .version("version")
         // the properties below are optional
         .configurationProperties(List.of(ConfigurationPropertiesProperty.builder()
                 .key(false)
                 .name("name")
                 .required(false)
                 .secret(false)
                 // the properties below are optional
                 .description("description")
                 .queryable(false)
                 .type("type")
                 .build()))
         .settings(SettingsProperty.builder()
                 .entityUrlTemplate("entityUrlTemplate")
                 .executionUrlTemplate("executionUrlTemplate")
                 .revisionUrlTemplate("revisionUrlTemplate")
                 .thirdPartyConfigurationUrl("thirdPartyConfigurationUrl")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomActionType

      protected CfnCustomActionType(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomActionType

      protected CfnCustomActionType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomActionType

      @Stability(Stable) public CfnCustomActionType(@NotNull Construct scope, @NotNull String id, @NotNull CfnCustomActionTypeProps props)
      Create a new AWS::CodePipeline::CustomActionType.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags for the custom action.

    • getCategory

      @Stability(Stable) @NotNull public String getCategory()
      The category of the custom action, such as a build action or a test action.

    • setCategory

      @Stability(Stable) public void setCategory(@NotNull String value)
      The category of the custom action, such as a build action or a test action.

    • getInputArtifactDetails

      @Stability(Stable) @NotNull public Object getInputArtifactDetails()
      The details of the input artifact for the action, such as its commit ID.

    • setInputArtifactDetails

      @Stability(Stable) public void setInputArtifactDetails(@NotNull CfnCustomActionType.ArtifactDetailsProperty value)
      The details of the input artifact for the action, such as its commit ID.

    • setInputArtifactDetails

      @Stability(Stable) public void setInputArtifactDetails(@NotNull IResolvable value)
      The details of the input artifact for the action, such as its commit ID.

    • getOutputArtifactDetails

      @Stability(Stable) @NotNull public Object getOutputArtifactDetails()
      The details of the output artifact of the action, such as its commit ID.

    • setOutputArtifactDetails

      @Stability(Stable) public void setOutputArtifactDetails(@NotNull CfnCustomActionType.ArtifactDetailsProperty value)
      The details of the output artifact of the action, such as its commit ID.

    • setOutputArtifactDetails

      @Stability(Stable) public void setOutputArtifactDetails(@NotNull IResolvable value)
      The details of the output artifact of the action, such as its commit ID.

    • getProvider

      @Stability(Stable) @NotNull public String getProvider()
      The provider of the service used in the custom action, such as CodeDeploy.

    • setProvider

      @Stability(Stable) public void setProvider(@NotNull String value)
      The provider of the service used in the custom action, such as CodeDeploy.

    • getVersion

      @Stability(Stable) @NotNull public String getVersion()
      The version identifier of the custom action.

    • setVersion

      @Stability(Stable) public void setVersion(@NotNull String value)
      The version identifier of the custom action.

    • getConfigurationProperties

      @Stability(Stable) @Nullable public Object getConfigurationProperties()
      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 .

    • setConfigurationProperties

      @Stability(Stable) public void setConfigurationProperties(@Nullable IResolvable value)
      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 .

    • setConfigurationProperties

      @Stability(Stable) public void setConfigurationProperties(@Nullable List<Object> value)
      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 .

    • getSettings

      @Stability(Stable) @Nullable public Object getSettings()
      URLs that provide users information about this custom action.

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable IResolvable value)
      URLs that provide users information about this custom action.

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable CfnCustomActionType.SettingsProperty value)
      URLs that provide users information about this custom action.