Package software.amazon.awscdk.services.codepipeline

Class CustomActionRegistration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.codepipeline.CustomActionRegistration

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:08.200Z")
@Stability(Stable)
public class CustomActionRegistration
extends software.constructs.Construct

The resource representing registering a custom Action with CodePipeline.

For the Action to be usable, it has to be registered for every region and every account it's used in. In addition to this class, you should most likely also provide your clients a class representing your custom Action, extending the Action class, and taking the actionProperties as properly typed, construction properties.

Example:

 // Make a custom CodePipeline Action
 // Make a custom CodePipeline Action
 CustomActionRegistration.Builder.create(this, "GenericGitSourceProviderResource")
         .category(ActionCategory.SOURCE)
         .artifactBounds(ActionArtifactBounds.builder().minInputs(0).maxInputs(0).minOutputs(1).maxOutputs(1).build())
         .provider("GenericGitSource")
         .version("1")
         .entityUrl("https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html")
         .executionUrl("https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html")
         .actionProperties(List.of(CustomActionProperty.builder()
                 .name("Branch")
                 .required(true)
                 .key(false)
                 .secret(false)
                 .queryable(false)
                 .description("Git branch to pull")
                 .type("String")
                 .build(), CustomActionProperty.builder()
                 .name("GitUrl")
                 .required(true)
                 .key(false)
                 .secret(false)
                 .queryable(false)
                 .description("SSH git clone URL")
                 .type("String")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CustomActionRegistration.Builder	A fluent builder for CustomActionRegistration.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomActionRegistration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomActionRegistration(software.amazon.jsii.JsiiObjectRef objRef)
	CustomActionRegistration(software.constructs.Construct scope, String id, CustomActionRegistrationProps props)

Method Summary

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

Constructor Details

CustomActionRegistration

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

CustomActionRegistration

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

CustomActionRegistration

@Stability(Stable)
public CustomActionRegistration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CustomActionRegistrationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.