@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.840Z") public class CfnCustomActionType extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCustomActionType(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrId() |
java.lang.String |
getCategory()
The category of the custom action, such as a build action or a test action.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfigurationProperties()
The configuration properties for the custom action.
|
java.lang.Object |
getInputArtifactDetails()
The details of the input artifact for the action, such as its commit ID.
|
java.lang.Object |
getOutputArtifactDetails()
The details of the output artifact of the action, such as its commit ID.
|
java.lang.String |
getProvider()
The provider of the service used in the custom action, such as CodeDeploy.
|
java.lang.Object |
getSettings()
URLs that provide users information about this custom action.
|
TagManager |
getTags()
The tags for the custom action.
|
java.lang.String |
getVersion()
The version identifier of the custom action.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCategory(java.lang.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(java.util.List<java.lang.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(java.lang.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(java.lang.String value)
The version identifier of the custom action.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCustomActionType(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCustomActionType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCustomActionType(Construct scope, java.lang.String id, CfnCustomActionTypeProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getCategory()
public void setCategory(java.lang.String value)
public java.lang.Object getInputArtifactDetails()
public void setInputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value)
public void setInputArtifactDetails(IResolvable value)
public java.lang.Object getOutputArtifactDetails()
public void setOutputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value)
public void setOutputArtifactDetails(IResolvable value)
public java.lang.String getProvider()
public void setProvider(java.lang.String value)
public java.lang.String getVersion()
public void setVersion(java.lang.String value)
public java.lang.Object getConfigurationProperties()
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 .
public void setConfigurationProperties(IResolvable value)
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 .
public void setConfigurationProperties(java.util.List<java.lang.Object> value)
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 .
public java.lang.Object getSettings()
public void setSettings(IResolvable value)
public void setSettings(CfnCustomActionType.SettingsProperty value)