BitBucketSourceActionProps

class aws_cdk.aws_codepipeline_actions.BitBucketSourceActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, connection_arn, output, owner, repo, branch=None, code_build_clone_output=None, trigger_on_push=None)

Bases: aws_cdk.aws_codepipeline_actions.CodeStarConnectionsSourceActionProps

(deprecated) Construction properties for {@link BitBucketSourceAction}.

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

  • connection_arn (str) – The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.

  • output (Artifact) – The output artifact that this action produces. Can be used as input for further pipeline actions.

  • owner (str) – The owning user or organization of the repository.

  • repo (str) – The name of the repository.

  • branch (Optional[str]) – The branch to build. Default: ‘master’

  • code_build_clone_output (Optional[bool]) – Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building. Note: if this option is true, then only CodeBuild actions can use the resulting {@link output}. Default: false

  • trigger_on_push (Optional[bool]) – Controls automatically starting your pipeline when a new commit is made on the configured repository and branch. If unspecified, the default value is true, and the field does not display by default. Default: true

Deprecated

use CodeStarConnectionsSourceActionProps instead

Stability

deprecated

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

The branch to build.

Default

‘master’

Return type

Optional[str]

code_build_clone_output

Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

Note: if this option is true, then only CodeBuild actions can use the resulting {@link output}.

Default

false

See

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config

Return type

Optional[bool]

connection_arn

The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.

See

https://docs.aws.amazon.com/codepipeline/latest/userguide/connections-create.html

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
"arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh"
Return type

str

output

The output artifact that this action produces.

Can be used as input for further pipeline actions.

Return type

Artifact

owner

The owning user or organization of the repository.

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
"aws"
Return type

str

repo

The name of the repository.

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
"aws-cdk"
Return type

str

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

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

1

See

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

Return type

Union[int, float, None]

trigger_on_push

Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.

If unspecified, the default value is true, and the field does not display by default.

Default

true

See

https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html

Return type

Optional[bool]

variables_namespace

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

Return type

Optional[str]