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

Class CodeStarConnectionsSourceActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeStarConnectionsSourceActionProps>

Enclosing interface:

CodeStarConnectionsSourceActionProps

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

A builder for CodeStarConnectionsSourceActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CodeStarConnectionsSourceActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CodeStarConnectionsSourceActionProps.Builder	branch(String branch)	Sets the value of CodeStarConnectionsSourceActionProps.getBranch()
CodeStarConnectionsSourceActionProps	build()	Builds the configured instance.
CodeStarConnectionsSourceActionProps.Builder	codeBuildCloneOutput(Boolean codeBuildCloneOutput)	Sets the value of CodeStarConnectionsSourceActionProps.getCodeBuildCloneOutput()
CodeStarConnectionsSourceActionProps.Builder	connectionArn(String connectionArn)	Sets the value of CodeStarConnectionsSourceActionProps.getConnectionArn()
CodeStarConnectionsSourceActionProps.Builder	output(Artifact output)	Sets the value of CodeStarConnectionsSourceActionProps.getOutput()
CodeStarConnectionsSourceActionProps.Builder	owner(String owner)	Sets the value of CodeStarConnectionsSourceActionProps.getOwner()
CodeStarConnectionsSourceActionProps.Builder	repo(String repo)	Sets the value of CodeStarConnectionsSourceActionProps.getRepo()
CodeStarConnectionsSourceActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CodeStarConnectionsSourceActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CodeStarConnectionsSourceActionProps.Builder	triggerOnPush(Boolean triggerOnPush)	Sets the value of CodeStarConnectionsSourceActionProps.getTriggerOnPush()
CodeStarConnectionsSourceActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

connectionArn

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder connectionArn(String connectionArn)

Sets the value of CodeStarConnectionsSourceActionProps.getConnectionArn()

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

output

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

Sets the value of CodeStarConnectionsSourceActionProps.getOutput()

Parameters:

output - The output artifact that this action produces. This parameter is required. Can be used as input for further pipeline actions.

Returns:

this

owner

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

Sets the value of CodeStarConnectionsSourceActionProps.getOwner()

Parameters:

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

Returns:

this

repo

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

Sets the value of CodeStarConnectionsSourceActionProps.getRepo()

Parameters:

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

Returns:

this

branch

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

Sets the value of CodeStarConnectionsSourceActionProps.getBranch()

Parameters:

branch - The branch to build.

Returns:

this

codeBuildCloneOutput

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder codeBuildCloneOutput(Boolean codeBuildCloneOutput)

Sets the value of CodeStarConnectionsSourceActionProps.getCodeBuildCloneOutput()

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. Note: if this option is true, then only CodeBuild actions can use the resulting output.

Returns:

this

triggerOnPush

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

Sets the value of CodeStarConnectionsSourceActionProps.getTriggerOnPush()

Parameters:

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.

Returns:

this

role

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

Parameters:

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.

Returns:

this

actionName

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.

Returns:

this

runOrder

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

variablesNamespace

@Stability(Stable)
public CodeStarConnectionsSourceActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CodeStarConnectionsSourceActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CodeStarConnectionsSourceActionProps

Throws:

NullPointerException - if any required attribute was not provided