software.amazon.awscdk.services.codepipeline

Class CustomActionRegistration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.codepipeline.CustomActionRegistration

All Implemented Interfaces:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.886Z")
public class CustomActionRegistration
extends 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 and Description
static class	CustomActionRegistration.Builder A fluent builder for CustomActionRegistration.

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

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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, toString, wait, wait, wait

Constructor Detail

CustomActionRegistration

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

CustomActionRegistration

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

CustomActionRegistration

public CustomActionRegistration(software.constructs.Construct scope,
                                java.lang.String id,
                                CustomActionRegistrationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.