CfnCustomActionType

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.codepipeline.CfnCustomActionType

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.840Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
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)`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnCustomActionType(Construct scope,
                           java.lang.String id,
                           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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrId
```
public java.lang.String getAttrId()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags for the custom action.
  - getCategory
```
public java.lang.String getCategory()
```
    The category of the custom action, such as a build action or a test action.
  - setCategory
```
public void setCategory(java.lang.String value)
```
    The category of the custom action, such as a build action or a test action.
  - getInputArtifactDetails
```
public java.lang.Object getInputArtifactDetails()
```
    The details of the input artifact for the action, such as its commit ID.
  - setInputArtifactDetails
```
public void setInputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value)
```
    The details of the input artifact for the action, such as its commit ID.
  - setInputArtifactDetails
```
public void setInputArtifactDetails(IResolvable value)
```
    The details of the input artifact for the action, such as its commit ID.
  - getOutputArtifactDetails
```
public java.lang.Object getOutputArtifactDetails()
```
    The details of the output artifact of the action, such as its commit ID.
  - setOutputArtifactDetails
```
public void setOutputArtifactDetails(CfnCustomActionType.ArtifactDetailsProperty value)
```
    The details of the output artifact of the action, such as its commit ID.
  - setOutputArtifactDetails
```
public void setOutputArtifactDetails(IResolvable value)
```
    The details of the output artifact of the action, such as its commit ID.
  - getProvider
```
public java.lang.String getProvider()
```
    The provider of the service used in the custom action, such as CodeDeploy.
  - setProvider
```
public void setProvider(java.lang.String value)
```
    The provider of the service used in the custom action, such as CodeDeploy.
  - getVersion
```
public java.lang.String getVersion()
```
    The version identifier of the custom action.
  - setVersion
```
public void setVersion(java.lang.String value)
```
    The version identifier of the custom action.
  - getConfigurationProperties
```
public java.lang.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
```
public void setConfigurationProperties(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
```
public void setConfigurationProperties(java.util.List<java.lang.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
```
public java.lang.Object getSettings()
```
    URLs that provide users information about this custom action.
  - setSettings
```
public void setSettings(IResolvable value)
```
    URLs that provide users information about this custom action.
  - setSettings
```
public void setSettings(CfnCustomActionType.SettingsProperty value)
```
    URLs that provide users information about this custom action.

Class CfnCustomActionType

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCustomActionType

CfnCustomActionType

CfnCustomActionType

Method Detail

inspect

renderProperties

getAttrId

getCfnProperties

getTags

getCategory

setCategory

getInputArtifactDetails

setInputArtifactDetails

setInputArtifactDetails

getOutputArtifactDetails

setOutputArtifactDetails

setOutputArtifactDetails

getProvider

setProvider

getVersion

setVersion

getConfigurationProperties

setConfigurationProperties

setConfigurationProperties

getSettings

setSettings

setSettings