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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.540Z")
 @Stability(value=Stable)
public class CfnCustomActionType
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodePipeline::CustomActionType`.

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 Example:
static class	CfnCustomActionType.Builder A fluent builder for CfnCustomActionType.
static interface	CfnCustomActionType.ConfigurationPropertiesProperty Example:
static interface	CfnCustomActionType.SettingsProperty Example:

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() `AWS::CodePipeline::CustomActionType.Category`.
protected Map<String,Object>	getCfnProperties()
Object	getConfigurationProperties() `AWS::CodePipeline::CustomActionType.ConfigurationProperties`.
Object	getInputArtifactDetails() `AWS::CodePipeline::CustomActionType.InputArtifactDetails`.
Object	getOutputArtifactDetails() `AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.
String	getProvider() `AWS::CodePipeline::CustomActionType.Provider`.
Object	getSettings() `AWS::CodePipeline::CustomActionType.Settings`.
TagManager	getTags() `AWS::CodePipeline::CustomActionType.Tags`.
String	getVersion() `AWS::CodePipeline::CustomActionType.Version`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCategory(String value) `AWS::CodePipeline::CustomActionType.Category`.
void	setConfigurationProperties(IResolvable value) `AWS::CodePipeline::CustomActionType.ConfigurationProperties`.
void	setConfigurationProperties(List<Object> value) `AWS::CodePipeline::CustomActionType.ConfigurationProperties`.
void	setInputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value) `AWS::CodePipeline::CustomActionType.InputArtifactDetails`.
void	setInputArtifactDetails(IResolvable value) `AWS::CodePipeline::CustomActionType.InputArtifactDetails`.
void	setOutputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value) `AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.
void	setOutputArtifactDetails(IResolvable value) `AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.
void	setProvider(String value) `AWS::CodePipeline::CustomActionType.Provider`.
void	setSettings(CfnCustomActionType.SettingsProperty value) `AWS::CodePipeline::CustomActionType.Settings`.
void	setSettings(IResolvable value) `AWS::CodePipeline::CustomActionType.Settings`.
void	setVersion(String value) `AWS::CodePipeline::CustomActionType.Version`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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.

getCategory

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

`AWS::CodePipeline::CustomActionType.Category`.

setCategory

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

`AWS::CodePipeline::CustomActionType.Category`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getConfigurationProperties

@Stability(value=Stable)
 @Nullable
public Object getConfigurationProperties()

`AWS::CodePipeline::CustomActionType.ConfigurationProperties`.

setConfigurationProperties

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

`AWS::CodePipeline::CustomActionType.ConfigurationProperties`.

setConfigurationProperties

@Stability(value=Stable)
public void setConfigurationProperties(@Nullable
                                                                List<Object> value)

`AWS::CodePipeline::CustomActionType.ConfigurationProperties`.

getInputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.InputArtifactDetails`.

setInputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.InputArtifactDetails`.

setInputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.InputArtifactDetails`.

getOutputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.

setOutputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.

setOutputArtifactDetails

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

`AWS::CodePipeline::CustomActionType.OutputArtifactDetails`.

getProvider

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

`AWS::CodePipeline::CustomActionType.Provider`.

setProvider

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

`AWS::CodePipeline::CustomActionType.Provider`.

getSettings

@Stability(value=Stable)
 @Nullable
public Object getSettings()

`AWS::CodePipeline::CustomActionType.Settings`.

setSettings

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

`AWS::CodePipeline::CustomActionType.Settings`.

setSettings

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

`AWS::CodePipeline::CustomActionType.Settings`.

getTags

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

`AWS::CodePipeline::CustomActionType.Tags`.

getVersion

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

`AWS::CodePipeline::CustomActionType.Version`.

setVersion

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

`AWS::CodePipeline::CustomActionType.Version`.