Skip to content
v2.274.0

CustomActionRegistrationProps Struct ​

Properties of registering a custom Action.

Example ​

ts
// 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 ​

actionPropertiesoptionalCustomActionProperty[]action_propertiesoptionaltyping.List[CustomActionProperty]actionPropertiesoptionalList<CustomActionProperty>ActionPropertiesoptionalCustomActionProperty[]ActionPropertiesoptional*[]CustomActionProperty= []#
The properties used for customizing the instance of your Action.
artifactBoundsActionArtifactBoundsartifact_boundsActionArtifactBoundsartifactBoundsActionArtifactBoundsArtifactBoundsActionArtifactBoundsArtifactBoundsActionArtifactBoundsrequired#
The artifact bounds of the Action.
categoryActionCategorycategoryActionCategorycategoryActionCategoryCategoryActionCategoryCategoryActionCategoryrequired#
The category of the Action.
entityUrloptionalstringentity_urloptionalstrentityUrloptionalStringEntityUrloptionalstringEntityUrloptional*string= none#
The URL shown for the entire Action in the Pipeline UI.
executionUrloptionalstringexecution_urloptionalstrexecutionUrloptionalStringExecutionUrloptionalstringExecutionUrloptional*string= none#
The URL shown for a particular execution of an Action in the Pipeline UI.
providerstringproviderstrproviderStringProviderstringProvider*stringrequired#
The provider of the Action.

For example, 'MyCustomActionProvider'

versionoptionalstringversionoptionalstrversionoptionalStringVersionoptionalstringVersionoptional*string= '1'#
The version of your Action.