class CustomActionRegistration (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CustomActionRegistration`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CustomActionRegistration`
Java	`software.amazon.awscdk.services.codepipeline.CustomActionRegistration`
Python	`aws_cdk.aws_codepipeline.CustomActionRegistration`
TypeScript (source)	`aws-cdk-lib` » `aws_codepipeline` » `CustomActionRegistration`

Implements IConstruct, IDependable

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
new codepipeline.CustomActionRegistration(this, 'GenericGitSourceProviderResource', {
  category: codepipeline.ActionCategory.SOURCE,
  artifactBounds: { minInputs: 0, maxInputs: 0, minOutputs: 1, maxOutputs: 1 },
  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: [
    {
      name: 'Branch',
      required: true,
      key: false,
      secret: false,
      queryable: false,
      description: 'Git branch to pull',
      type: 'String',
    },
    {
      name: 'GitUrl',
      required: true,
      key: false,
      secret: false,
      queryable: false,
      description: 'SSH git clone URL',
      type: 'String',
    },
  ],
});

Initializer

new CustomActionRegistration(scope: Construct, id: string, props: CustomActionRegistrationProps)

Parameters

scope Construct
id string
props CustomActionRegistrationProps

Construct Props

Name	Type	Description
artifactBounds	`ActionArtifactBounds`	The artifact bounds of the Action.
category	`ActionCategory`	The category of the Action.
provider	`string`	The provider of the Action.
actionProperties?	`CustomActionProperty[]`	The properties used for customizing the instance of your Action.
entityUrl?	`string`	The URL shown for the entire Action in the Pipeline UI.
executionUrl?	`string`	The URL shown for a particular execution of an Action in the Pipeline UI.
version?	`string`	The version of your Action.

artifactBounds

Type: ActionArtifactBounds

The artifact bounds of the Action.

provider

Type: string

The provider of the Action.

For example, 'MyCustomActionProvider'

actionProperties?

Type: CustomActionProperty[] (optional, default: [])

The properties used for customizing the instance of your Action.

entityUrl?

Type: string (optional, default: none)

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

executionUrl?

Type: string (optional, default: none)

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

version?

Type: string (optional, default: '1')

The version of your Action.

Properties

Name	Type	Description
node	`Node`	The tree node.

node

Type: Node

The tree node.

Methods

Name	Description
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)

public with(...mixins: IMixin[]): IConstruct