software.amazon.awscdk.services.codepipeline

Interface CustomActionRegistrationProps

All Known Implementing Classes:

CustomActionRegistrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.888Z")
public interface CustomActionRegistrationProps

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

Method Summary

Modifier and Type	Method and Description
static CustomActionRegistrationProps.Builder	builder()
default java.util.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 java.lang.String	getEntityUrl() The URL shown for the entire Action in the Pipeline UI.
default java.lang.String	getExecutionUrl() The URL shown for a particular execution of an Action in the Pipeline UI.
java.lang.String	getProvider() The provider of the Action.
default java.lang.String	getVersion() The version of your Action.

Method Detail

getArtifactBounds

ActionArtifactBounds getArtifactBounds()

The artifact bounds of the Action.

getCategory

ActionCategory getCategory()

The category of the Action.

getProvider

java.lang.String getProvider()

The provider of the Action.

For example, 'MyCustomActionProvider'

getActionProperties

default java.util.List<CustomActionProperty> getActionProperties()

The properties used for customizing the instance of your Action.

Default: []

getEntityUrl

default java.lang.String getEntityUrl()

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

Default: none

getExecutionUrl

default java.lang.String getExecutionUrl()

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

Default: none

getVersion

default java.lang.String getVersion()

The version of your Action.

Default: '1'

builder

static CustomActionRegistrationProps.Builder builder()

Returns:

a CustomActionRegistrationProps.Builder of CustomActionRegistrationProps