AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

CustomActionRegistration

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.

Import

import { CustomActionRegistration } from 'aws-cdk-lib/aws-codepipeline';

Or use the module namespace:

import * as codepipeline from 'aws-cdk-lib/aws-codepipeline';
// codepipeline.CustomActionRegistration

Properties

Configuration passed to the constructor as CustomActionRegistrationProps.

artifactBoundsRequired
ActionArtifactBounds

The artifact bounds of the Action.

categoryRequired
ActionCategory

The category of the Action.

providerRequired
string

The provider of the Action. For example, `'MyCustomActionProvider'`

actionPropertiesOptional
CustomActionProperty[]

The properties used for customizing the instance of your Action.

Default: []

entityUrlOptional
string

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

Default: none

executionUrlOptional
string

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

Default: none

versionOptional
string

The version of your Action.

Default: '1'

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter