aws-cdk-lib.aws_codebuild.BitBucketSourceCredentials

class BitBucketSourceCredentials (construct)

LanguageType name
.NETAmazon.CDK.AWS.CodeBuild.BitBucketSourceCredentials
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#BitBucketSourceCredentials
Javasoftware.amazon.awscdk.services.codebuild.BitBucketSourceCredentials
Pythonaws_cdk.aws_codebuild.BitBucketSourceCredentials
TypeScript (source)aws-cdk-lib » aws_codebuild » BitBucketSourceCredentials

Implements IConstruct, IDependable, IResource

The source credentials used when contacting the BitBucket API.

Note: CodeBuild only allows a single credential for BitBucket to be saved in a given AWS account in a given region - any attempt to add more than one will result in an error.

Example

new codebuild.BitBucketSourceCredentials(this, 'CodeBuildBitBucketCreds', {
  username: SecretValue.secretsManager('my-bitbucket-creds', { jsonField: 'username' }),
  password: SecretValue.secretsManager('my-bitbucket-creds', { jsonField: 'password' }),
});

Initializer

new BitBucketSourceCredentials(scope: Construct, id: string, props: BitBucketSourceCredentialsProps)

Parameters

  • scope Construct
  • id string
  • props BitBucketSourceCredentialsProps

Construct Props

NameTypeDescription
passwordSecretValueYour BitBucket application password.
usernameSecretValueYour BitBucket username.

password

Type: SecretValue

Your BitBucket application password.


username

Type: SecretValue

Your BitBucket username.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.