Class CfnCustomActionType
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic interface
Returns information about the details of an artifact.static final class
A fluent builder forCfnCustomActionType
.static interface
The configuration properties for the custom action.static interface
Settings
is a property of theAWS::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.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnCustomActionType
(Construct scope, String id, CfnCustomActionTypeProps props) Create a newAWS::CodePipeline::CustomActionType
.protected
CfnCustomActionType
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCustomActionType
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe category of the custom action, such as a build action or a test action.The configuration properties for the custom action.The details of the input artifact for the action, such as its commit ID.The details of the output artifact of the action, such as its commit ID.The provider of the service used in the custom action, such as CodeDeploy.URLs that provide users information about this custom action.getTags()
The tags for the custom action.The version identifier of the custom action.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
(List<Object> value) The configuration properties for the custom action.void
The configuration properties for the custom action.void
The details of the input artifact for the action, such as its commit ID.void
The details of the input artifact for the action, such as its commit ID.void
The details of the output artifact of the action, such as its commit ID.void
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
(IResolvable value) URLs that provide users information about this custom action.void
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.core.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.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Details
-
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 newAWS::CodePipeline::CustomActionType
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
The tags for the custom action. -
getCategory
The category of the custom action, such as a build action or a test action. -
setCategory
The category of the custom action, such as a build action or a test action. -
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
The details of the input artifact for the action, such as its commit ID. -
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
The details of the output artifact of the action, such as its commit ID. -
getProvider
The provider of the service used in the custom action, such as CodeDeploy. -
setProvider
The provider of the service used in the custom action, such as CodeDeploy. -
getVersion
The version identifier of the custom action. -
setVersion
The version identifier of the custom action. -
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
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
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
URLs that provide users information about this custom action. -
setSettings
URLs that provide users information about this custom action. -
setSettings
URLs that provide users information about this custom action.
-