CustomActionRegistrationProps

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

Bases: object

Properties of registering a custom Action.

Parameters
  • artifact_bounds (Union[ActionArtifactBounds, Dict[str, Any]]) – 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[Union[CustomActionProperty, Dict[str, Any]]]]) – 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’

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"
    )
    ]
)

Attributes

action_properties

The properties used for customizing the instance of your Action.

Default

[]

Return type

Optional[List[CustomActionProperty]]

artifact_bounds

The artifact bounds of the Action.

Return type

ActionArtifactBounds

category

The category of the Action.

Return type

ActionCategory

entity_url

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

Default

none

Return type

Optional[str]

execution_url

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

Default

none

Return type

Optional[str]

provider

The provider of the Action.

For example, 'MyCustomActionProvider'

Return type

str

version

The version of your Action.

Default

‘1’

Return type

Optional[str]