software.amazon.awscdk.services.codepipeline

Class CfnCustomActionType

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codepipeline.CfnCustomActionType

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.454Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCustomActionType.ArtifactDetailsProperty Returns information about the details of an artifact.
static class	CfnCustomActionType.Builder A fluent builder for CfnCustomActionType.
static interface	CfnCustomActionType.ConfigurationPropertiesProperty The configuration properties for the custom action.
static interface	CfnCustomActionType.SettingsProperty `Settings` is a property of the `AWS::CodePipeline::CustomActionType` resource that provides URLs that users can access to view information about the CodePipeline custom action.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomActionType(software.constructs.Construct scope, String id, CfnCustomActionTypeProps props) Create a new `AWS::CodePipeline::CustomActionType`.
protected	CfnCustomActionType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomActionType(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCategory() The category of the custom action, such as a build action or a test action.
protected Map<String,Object>	getCfnProperties()
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.
Object	getSettings() URLs that provide users information about this custom action.
TagManager	getTags() The tags for the custom action.
String	getVersion() The version identifier of the custom action.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCategory(String value) The category of the custom action, such as a build action or a test action.
void	setConfigurationProperties(IResolvable value) The configuration properties for the custom action.
void	setConfigurationProperties(List<Object> value) The configuration properties for the custom action.
void	setInputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value) The details of the input artifact for the action, such as its commit ID.
void	setInputArtifactDetails(IResolvable value) The details of the input artifact for the action, such as its commit ID.
void	setOutputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value) The details of the output artifact of the action, such as its commit ID.
void	setOutputArtifactDetails(IResolvable value) The details of the output artifact of the action, such as its commit ID.
void	setProvider(String value) The provider of the service used in the custom action, such as CodeDeploy.
void	setSettings(CfnCustomActionType.SettingsProperty value) URLs that provide users information about this custom action.
void	setSettings(IResolvable value) URLs that provide users information about this custom action.
void	setVersion(String value) The version identifier of the custom action.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomActionType

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

CfnCustomActionType

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

CfnCustomActionType

@Stability(value=Stable)
public CfnCustomActionType(@NotNull
                                                    software.constructs.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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the custom action.

getCategory

@Stability(value=Stable)
 @NotNull
public String getCategory()

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

setCategory

@Stability(value=Stable)
public void setCategory(@NotNull
                                                 String value)

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

getInputArtifactDetails

@Stability(value=Stable)
 @NotNull
public Object getInputArtifactDetails()

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

setInputArtifactDetails

@Stability(value=Stable)
public void setInputArtifactDetails(@NotNull
                                                             CfnCustomActionType.ArtifactDetailsProperty value)

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

setInputArtifactDetails

@Stability(value=Stable)
public void setInputArtifactDetails(@NotNull
                                                             IResolvable value)

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

getOutputArtifactDetails

@Stability(value=Stable)
 @NotNull
public Object getOutputArtifactDetails()

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

setOutputArtifactDetails

@Stability(value=Stable)
public void setOutputArtifactDetails(@NotNull
                                                              CfnCustomActionType.ArtifactDetailsProperty value)

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

setOutputArtifactDetails

@Stability(value=Stable)
public void setOutputArtifactDetails(@NotNull
                                                              IResolvable value)

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

getProvider

@Stability(value=Stable)
 @NotNull
public String getProvider()

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

setProvider

@Stability(value=Stable)
public void setProvider(@NotNull
                                                 String value)

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

getVersion

@Stability(value=Stable)
 @NotNull
public String getVersion()

The version identifier of the custom action.

setVersion

@Stability(value=Stable)
public void setVersion(@NotNull
                                                String value)

The version identifier of the custom action.

getConfigurationProperties

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getSettings()

URLs that provide users information about this custom action.

setSettings

@Stability(value=Stable)
public void setSettings(@Nullable
                                                 CfnCustomActionType.SettingsProperty value)

URLs that provide users information about this custom action.

setSettings

@Stability(value=Stable)
public void setSettings(@Nullable
                                                 IResolvable value)

URLs that provide users information about this custom action.