CustomActionRegistration

class aws_cdk.aws_codepipeline.CustomActionRegistration(scope, id, *, artifact_bounds, category, provider, action_properties=None, entity_url=None, execution_url=None, version=None)

Bases: aws_cdk.core.Construct

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.

ExampleMetadata

infused

Example:

# Make a custom CodePipeline Action
codepipeline.CustomActionRegistration(self, "GenericGitSourceProviderResource",
    category=codepipeline.ActionCategory.SOURCE,
    artifact_bounds=codepipeline.ActionArtifactBounds(min_inputs=0, max_inputs=0, min_outputs=1, max_outputs=1),
    provider="GenericGitSource",
    version="1",
    entity_url="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
    execution_url="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-custom-action.html",
    action_properties=[codepipeline.CustomActionProperty(
        name="Branch",
        required=True,
        key=False,
        secret=False,
        queryable=False,
        description="Git branch to pull",
        type="String"
    ), codepipeline.CustomActionProperty(
        name="GitUrl",
        required=True,
        key=False,
        secret=False,
        queryable=False,
        description="SSH git clone URL",
        type="String"
    )
    ]
)
Parameters
  • scope (Construct) –

  • id (str) –

  • artifact_bounds (ActionArtifactBounds) – The artifact bounds of the Action.

  • category (ActionCategory) – The category of the Action.

  • provider (str) – The provider of the Action. For example, 'MyCustomActionProvider'

  • action_properties (Optional[Sequence[CustomActionProperty]]) – The properties used for customizing the instance of your Action. Default: []

  • entity_url (Optional[str]) – The URL shown for the entire Action in the Pipeline UI. Default: none

  • execution_url (Optional[str]) – The URL shown for a particular execution of an Action in the Pipeline UI. Default: none

  • version (Optional[str]) – The version of your Action. Default: ‘1’

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool