interface BitBucketSourceActionProps ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.BitBucketSourceActionProps
Java	software.amazon.awscdk.services.codepipeline.actions.BitBucketSourceActionProps
Python	aws_cdk.aws_codepipeline_actions.BitBucketSourceActionProps
TypeScript (source)	@aws-cdk/aws-codepipeline-actions » BitBucketSourceActionProps

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Construction properties for {@link BitBucketSourceAction}.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as codepipeline_actions from '@aws-cdk/aws-codepipeline-actions';
import * as iam from '@aws-cdk/aws-iam';

declare const artifact: codepipeline.Artifact;
declare const role: iam.Role;
const bitBucketSourceActionProps: codepipeline_actions.BitBucketSourceActionProps = {
  actionName: 'actionName',
  connectionArn: 'connectionArn',
  output: artifact,
  owner: 'owner',
  repo: 'repo',

  // the properties below are optional
  branch: 'branch',
  codeBuildCloneOutput: false,
  role: role,
  runOrder: 123,
  triggerOnPush: false,
  variablesNamespace: 'variablesNamespace',
};

Properties

Name	Type	Description
actionName⚠️	string	The physical, human-readable name of the Action.
connectionArn⚠️	string	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.
owner⚠️	string	The owning user or organization of the repository.
repo⚠️	string	The name of the repository.
branch?⚠️	string	The branch to build.
codeBuildCloneOutput?⚠️	boolean	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.
role?⚠️	IRole	The Role in which context's this Action will be executing in.
runOrder?⚠️	number	The runOrder property for this Action.
triggerOnPush?⚠️	boolean	Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.
variablesNamespace?⚠️	string	The name of the namespace to use for variables emitted by this action.

---

actionName⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string

The physical, human-readable name of the Action.

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

---

connectionArn⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string

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

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

'arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh'

---

output⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: Artifact

The output artifact that this action produces.

Can be used as input for further pipeline actions.

---

owner⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string

The owning user or organization of the repository. Example

'aws'

---

repo⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string

The name of the repository. Example

'aws-cdk'

---

branch?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string (optional, default: 'master')

The branch to build.

---

codeBuildCloneOutput?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: boolean (optional, default: false)

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}.

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

---

role?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: IRole (optional, default: a new Role will be generated)

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.

---

runOrder?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: number (optional, default: 1)

The runOrder property for this Action.

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

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

---

triggerOnPush?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: boolean (optional, default: true)

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.

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

---

variablesNamespace?⚠️

⚠️ Deprecated: use CodeStarConnectionsSourceActionProps instead

Type: string (optional, 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)

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