CodeCommitSourceActionProps

class aws_cdk.aws_codepipeline_actions.CodeCommitSourceActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, output, repository, branch=None, trigger=None)

Bases: aws_cdk.aws_codepipeline.CommonAwsActionProps

__init__(*, action_name, run_order=None, variables_namespace=None, role=None, output, repository, branch=None, trigger=None)

Construction properties of the {@link CodeCommitSourceAction CodeCommit source CodePipeline Action}.

Parameters

  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – The name of the namespace to use for variables emitted by this action. Default: - a name will be generated, based on the stage and action names, if any of the action’s variables were referenced - otherwise, no namespace will be set

  • role (Optional[IRole]) – The Role in which context’s this Action will be executing in. The Pipeline’s Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property. Default: a new Role will be generated

  • output (Artifact) –

  • repository (IRepository) – The CodeCommit repository.

  • branch (Optional[str]) – Default: ‘master’

  • trigger (Optional[CodeCommitTrigger]) – How should CodePipeline detect source changes for this Action. Default: CodeCommitTrigger.EVENTS

Attributes

action_name

The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Return type

str

branch

default :default: ‘master’

Return type

Optional[str]

output
Return type

Artifact

repository

The CodeCommit repository.

Return type

IRepository

role

The Role in which context’s this Action will be executing in.

The Pipeline’s Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

default :default: a new Role will be generated

Return type

Optional[IRole]

run_order

The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

default :default: 1

see :see: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

Return type

Union[int, float, None]

trigger

How should CodePipeline detect source changes for this Action.

default :default: CodeCommitTrigger.EVENTS

Return type

Optional[CodeCommitTrigger]

variables_namespace

The name of the namespace to use for variables emitted by this action.

default :default:

  • a name will be generated, based on the stage and action names, if any of the action’s variables were referenced - otherwise, no namespace will be set

Return type

Optional[str]