Package software.amazon.awscdk.services.codepipeline

Interface CfnCustomActionTypeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomActionTypeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:00.864Z")
@Stability(Stable)
public interface CfnCustomActionTypeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCustomActionType.

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.*;
 CfnCustomActionTypeProps cfnCustomActionTypeProps = CfnCustomActionTypeProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCustomActionTypeProps.Builder	builder()
String	getCategory()	The category of the custom action, such as a build action or a test action.
default Object	getConfigurationProperties()	The configuration properties for the custom action.
Object	getInputArtifactDetails()	The details of the input artifact for the action, such as its commit ID.
Object	getOutputArtifactDetails()	The details of the output artifact of the action, such as its commit ID.
String	getProvider()	The provider of the service used in the custom action, such as CodeDeploy.
default Object	getSettings()	URLs that provide users information about this custom action.
default List<CfnTag>	getTags()	The tags for the custom action.
String	getVersion()	The version identifier of the custom action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategory

@Stability(Stable)
@NotNull
String getCategory()

The category of the custom action, such as a build action or a test action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category

getInputArtifactDetails

@Stability(Stable)
@NotNull
Object getInputArtifactDetails()

The details of the input artifact for the action, such as its commit ID.

Returns union: either IResolvable or CfnCustomActionType.ArtifactDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails

getOutputArtifactDetails

@Stability(Stable)
@NotNull
Object getOutputArtifactDetails()

The details of the output artifact of the action, such as its commit ID.

Returns union: either IResolvable or CfnCustomActionType.ArtifactDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails

getProvider

@Stability(Stable)
@NotNull
String getProvider()

The provider of the service used in the custom action, such as CodeDeploy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider

getVersion

@Stability(Stable)
@NotNull
String getVersion()

The version identifier of the custom action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version

getConfigurationProperties

@Stability(Stable)
@Nullable
default 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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCustomActionType.ConfigurationPropertiesProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties

getSettings

@Stability(Stable)
@Nullable
default Object getSettings()

URLs that provide users information about this custom action.

Returns union: either IResolvable or CfnCustomActionType.SettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the custom action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags

builder

@Stability(Stable)
static CfnCustomActionTypeProps.Builder builder()

Returns:

a CfnCustomActionTypeProps.Builder of CfnCustomActionTypeProps