Package software.amazon.awscdk.services.codepipeline

Interface CustomActionRegistrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomActionRegistrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-11T03:45:51.654Z")
@Stability(Stable)
public interface CustomActionRegistrationProps
extends software.amazon.jsii.JsiiSerializable

Properties of registering a custom Action.

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	Interface	Description
static final class	CustomActionRegistrationProps.Builder	A builder for CustomActionRegistrationProps
static final class	CustomActionRegistrationProps.Jsii$Proxy	An implementation for CustomActionRegistrationProps

Method Summary

Modifier and Type	Method	Description
static CustomActionRegistrationProps.Builder	builder()
default List<CustomActionProperty>	getActionProperties()	The properties used for customizing the instance of your Action.
ActionArtifactBounds	getArtifactBounds()	The artifact bounds of the Action.
ActionCategory	getCategory()	The category of the Action.
default String	getEntityUrl()	The URL shown for the entire Action in the Pipeline UI.
default String	getExecutionUrl()	The URL shown for a particular execution of an Action in the Pipeline UI.
String	getProvider()	The provider of the Action.
default String	getVersion()	The version of your Action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArtifactBounds

@Stability(Stable)
@NotNull
ActionArtifactBounds getArtifactBounds()

The artifact bounds of the Action.

getCategory

@Stability(Stable)
@NotNull
ActionCategory getCategory()

The category of the Action.

getProvider

@Stability(Stable)
@NotNull
String getProvider()

The provider of the Action.

For example, 'MyCustomActionProvider'

getActionProperties

@Stability(Stable)
@Nullable
default List<CustomActionProperty> getActionProperties()

The properties used for customizing the instance of your Action.

Default: []

getEntityUrl

@Stability(Stable)
@Nullable
default String getEntityUrl()

The URL shown for the entire Action in the Pipeline UI.

Default: none

getExecutionUrl

@Stability(Stable)
@Nullable
default String getExecutionUrl()

The URL shown for a particular execution of an Action in the Pipeline UI.

Default: none

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

The version of your Action.

Default: '1'

builder

@Stability(Stable)
static CustomActionRegistrationProps.Builder builder()

Returns:

a CustomActionRegistrationProps.Builder of CustomActionRegistrationProps