aws-cdk-lib.aws_codepipeline.CustomActionRegistrationProps

interface CustomActionRegistrationProps

LanguageType name
.NETAmazon.CDK.AWS.CodePipeline.CustomActionRegistrationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CustomActionRegistrationProps
Javasoftware.amazon.awscdk.services.codepipeline.CustomActionRegistrationProps
Pythonaws_cdk.aws_codepipeline.CustomActionRegistrationProps
TypeScript (source)aws-cdk-lib » aws_codepipeline » CustomActionRegistrationProps

Properties of registering a custom Action.

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',
    },
  ],
});

Properties

NameTypeDescription
artifactBoundsActionArtifactBoundsThe artifact bounds of the Action.
categoryActionCategoryThe category of the Action.
providerstringThe provider of the Action.
actionProperties?CustomActionProperty[]The properties used for customizing the instance of your Action.
entityUrl?stringThe URL shown for the entire Action in the Pipeline UI.
executionUrl?stringThe URL shown for a particular execution of an Action in the Pipeline UI.
version?stringThe version of your Action.

artifactBounds

Type: ActionArtifactBounds

The artifact bounds of the Action.


category

Type: ActionCategory

The category 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.