Package software.amazon.awscdk.services.codepipeline.actions

Class CodeStarConnectionsSourceAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeStarConnectionsSourceAction>

Enclosing class:

CodeStarConnectionsSourceAction

@Stability(Stable)
public static final class CodeStarConnectionsSourceAction.Builder
extends Object
implements software.amazon.jsii.Builder<CodeStarConnectionsSourceAction>

A fluent builder for CodeStarConnectionsSourceAction.

Method Summary

Modifier and Type	Method	Description
CodeStarConnectionsSourceAction.Builder	actionName(String actionName)	The physical, human-readable name of the Action.
CodeStarConnectionsSourceAction.Builder	branch(String branch)	The branch to build.
CodeStarConnectionsSourceAction	build()
CodeStarConnectionsSourceAction.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.
CodeStarConnectionsSourceAction.Builder	connectionArn(String connectionArn)	The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.
static CodeStarConnectionsSourceAction.Builder	create()
CodeStarConnectionsSourceAction.Builder	output(Artifact output)	The output artifact that this action produces.
CodeStarConnectionsSourceAction.Builder	owner(String owner)	The owning user or organization of the repository.
CodeStarConnectionsSourceAction.Builder	repo(String repo)	The name of the repository.
CodeStarConnectionsSourceAction.Builder	role(IRole role)	The Role in which context's this Action will be executing in.
CodeStarConnectionsSourceAction.Builder	runOrder(Number runOrder)	The runOrder property for this Action.
CodeStarConnectionsSourceAction.Builder	triggerOnPush(Boolean triggerOnPush)	Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.
CodeStarConnectionsSourceAction.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 Details

create

@Stability(Stable)
public static CodeStarConnectionsSourceAction.Builder create()

Returns:

a new instance of CodeStarConnectionsSourceAction.Builder.

actionName

@Stability(Stable)
public CodeStarConnectionsSourceAction.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(Stable)
public CodeStarConnectionsSourceAction.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(Stable)
public CodeStarConnectionsSourceAction.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(Stable)
public CodeStarConnectionsSourceAction.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 IAction.bind method in the 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(Stable)
public CodeStarConnectionsSourceAction.Builder connectionArn(String connectionArn)

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

Example:

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

Parameters:

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

Returns:

this

See Also:

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

output

@Stability(Stable)
public CodeStarConnectionsSourceAction.Builder output(Artifact output)

The output artifact that this action produces.

Can be used as input for further pipeline actions.

Parameters:

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

Returns:

this

owner

@Stability(Stable)
public CodeStarConnectionsSourceAction.Builder owner(String owner)

The owning user or organization of the repository.

Example:

 "aws";
 

Parameters:

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

Returns:

this

repo

@Stability(Stable)
public CodeStarConnectionsSourceAction.Builder repo(String repo)

The name of the repository.

Example:

 "aws-cdk";
 

Parameters:

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

Returns:

this

branch

@Stability(Stable)
public CodeStarConnectionsSourceAction.Builder branch(String branch)

The branch to build.

Default: 'master'

Parameters:

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

Returns:

this

codeBuildCloneOutput

@Stability(Stable)
public CodeStarConnectionsSourceAction.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 output(software.amazon.awscdk.services.codepipeline.Artifact).

Default: false

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

triggerOnPush

@Stability(Stable)
public CodeStarConnectionsSourceAction.Builder triggerOnPush(Boolean triggerOnPush)

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

Parameters:

triggerOnPush - Controls automatically starting your pipeline when a new commit is made on the configured repository and branch. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CodeStarConnectionsSourceAction build()

Specified by:

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

Returns:

a newly built instance of CodeStarConnectionsSourceAction.