software.amazon.awscdk.services.codepipeline.actions

Class BitBucketSourceAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.BitBucketSourceAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BitBucketSourceAction>

Enclosing class:

BitBucketSourceAction

@Stability(value=Experimental)
public static final class BitBucketSourceAction.Builder
extends Object
implements software.amazon.jsii.Builder<BitBucketSourceAction>

A fluent builder for BitBucketSourceAction.

Method Summary

Modifier and Type	Method and Description
BitBucketSourceAction.Builder	actionName(String actionName) The physical, human-readable name of the Action.
BitBucketSourceAction.Builder	branch(String branch) The branch to build.
BitBucketSourceAction	build()
BitBucketSourceAction.Builder	codeBuildCloneOutput(Boolean codeBuildCloneOutput) 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.
BitBucketSourceAction.Builder	connectionArn(String connectionArn) The ARN of the CodeStar Connection created in the AWS console that has permissions to access this BitBucket repository.
static BitBucketSourceAction.Builder	create() EXPERIMENTAL
BitBucketSourceAction.Builder	output(Artifact output) The output artifact that this action produces.
BitBucketSourceAction.Builder	owner(String owner) The owning user or organization of the repository.
BitBucketSourceAction.Builder	repo(String repo) The name of the repository.
BitBucketSourceAction.Builder	role(IRole role) The Role in which context's this Action will be executing in.
BitBucketSourceAction.Builder	runOrder(Number runOrder) The runOrder property for this Action.
BitBucketSourceAction.Builder	variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static BitBucketSourceAction.Builder create()

EXPERIMENTAL

Returns:

a new instance of BitBucketSourceAction.Builder.

actionName

@Stability(value=Stable)
public BitBucketSourceAction.Builder actionName(String actionName)

The physical, human-readable name of the Action.

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

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public BitBucketSourceAction.Builder runOrder(Number runOrder)

The runOrder property for this Action.

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

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

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

variablesNamespace

@Stability(value=Stable)
public BitBucketSourceAction.Builder variablesNamespace(String variablesNamespace)

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

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public BitBucketSourceAction.Builder role(IRole 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

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

connectionArn

@Stability(value=Experimental)
public BitBucketSourceAction.Builder connectionArn(String connectionArn)

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

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";

EXPERIMENTAL

Parameters:

connectionArn - The ARN of the CodeStar Connection created in the AWS console that has permissions to access this BitBucket repository. This parameter is required.

Returns:

this

See Also:

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

output

@Stability(value=Experimental)
public BitBucketSourceAction.Builder output(Artifact output)

The output artifact that this action produces.

Can be used as input for further pipeline actions.

EXPERIMENTAL

Parameters:

output - The output artifact that this action produces. This parameter is required.

Returns:

this

owner

@Stability(value=Experimental)
public BitBucketSourceAction.Builder owner(String owner)

The owning user or organization of the repository.

Example:

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

EXPERIMENTAL

Parameters:

owner - The owning user or organization of the repository. This parameter is required.

Returns:

this

repo

@Stability(value=Experimental)
public BitBucketSourceAction.Builder repo(String repo)

The name of the repository.

Example:

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

EXPERIMENTAL

Parameters:

repo - The name of the repository. This parameter is required.

Returns:

this

branch

@Stability(value=Experimental)
public BitBucketSourceAction.Builder branch(String branch)

The branch to build.

Default: 'master'

EXPERIMENTAL

Parameters:

branch - The branch to build. This parameter is required.

Returns:

this

codeBuildCloneOutput

@Stability(value=Experimental)
public BitBucketSourceAction.Builder codeBuildCloneOutput(Boolean codeBuildCloneOutput)

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

EXPERIMENTAL

Parameters:

codeBuildCloneOutput - 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. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(value=Experimental)
public BitBucketSourceAction build()

Specified by:

build in interface software.amazon.jsii.Builder<BitBucketSourceAction>