Package software.amazon.awscdk.services.codepipeline

Class ActionProperties.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.ActionProperties.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ActionProperties>

Enclosing interface:

ActionProperties

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

A builder for ActionProperties

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ActionProperties.Builder	account(String account)	Sets the value of ActionProperties.getAccount()
ActionProperties.Builder	actionName(String actionName)	Sets the value of ActionProperties.getActionName()
ActionProperties.Builder	artifactBounds(ActionArtifactBounds artifactBounds)	Sets the value of ActionProperties.getArtifactBounds()
ActionProperties	build()	Builds the configured instance.
ActionProperties.Builder	category(ActionCategory category)	Sets the value of ActionProperties.getCategory()
ActionProperties.Builder	inputs(List<? extends Artifact> inputs)	Sets the value of ActionProperties.getInputs()
ActionProperties.Builder	outputs(List<? extends Artifact> outputs)	Sets the value of ActionProperties.getOutputs()
ActionProperties.Builder	owner(String owner)	Sets the value of ActionProperties.getOwner()
ActionProperties.Builder	provider(String provider)	Sets the value of ActionProperties.getProvider()
ActionProperties.Builder	region(String region)	Sets the value of ActionProperties.getRegion()
ActionProperties.Builder	resource(IResource resource)	Sets the value of ActionProperties.getResource()
ActionProperties.Builder	role(IRole role)	Sets the value of ActionProperties.getRole()
ActionProperties.Builder	runOrder(Number runOrder)	Sets the value of ActionProperties.getRunOrder()
ActionProperties.Builder	variablesNamespace(String variablesNamespace)	Sets the value of ActionProperties.getVariablesNamespace()
ActionProperties.Builder	version(String version)	Sets the value of ActionProperties.getVersion()

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

actionName

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

Sets the value of ActionProperties.getActionName()

Parameters:

actionName - the value to be set. This parameter is required.

Returns:

this

artifactBounds

@Stability(Stable)
public ActionProperties.Builder artifactBounds(ActionArtifactBounds artifactBounds)

Sets the value of ActionProperties.getArtifactBounds()

Parameters:

artifactBounds - the value to be set. This parameter is required.

Returns:

this

category

@Stability(Stable)
public ActionProperties.Builder category(ActionCategory category)

Sets the value of ActionProperties.getCategory()

Parameters:

category - The category of the action. This parameter is required. The category defines which action type the owner (the entity that performs the action) performs.

Returns:

this

provider

@Stability(Stable)
public ActionProperties.Builder provider(String provider)

Sets the value of ActionProperties.getProvider()

Parameters:

provider - The service provider that the action calls. This parameter is required.

Returns:

this

account

@Stability(Stable)
public ActionProperties.Builder account(String account)

Sets the value of ActionProperties.getAccount()

Parameters:

account - The account the Action is supposed to live in. For Actions backed by resources, this is inferred from the Stack resource is part of. However, some Actions, like the CloudFormation ones, are not backed by any resource, and they still might want to be cross-account. In general, a concrete Action class should specify either resource, or account - but not both.

Returns:

this

inputs

@Stability(Stable)
public ActionProperties.Builder inputs(List<? extends Artifact> inputs)

Sets the value of ActionProperties.getInputs()

Parameters:

inputs - the value to be set.

Returns:

this

outputs

@Stability(Stable)
public ActionProperties.Builder outputs(List<? extends Artifact> outputs)

Sets the value of ActionProperties.getOutputs()

Parameters:

outputs - the value to be set.

Returns:

this

owner

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

Sets the value of ActionProperties.getOwner()

Parameters:

owner - the value to be set.

Returns:

this

region

@Stability(Stable)
public ActionProperties.Builder region(String region)

Sets the value of ActionProperties.getRegion()

Parameters:

region - The AWS region the given Action resides in. Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the

invalid @link

PipelineProps#crossRegionReplicationBuckets

property. If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets, that you will need to `cdk deploy` before deploying the main, Pipeline-containing Stack.

Returns:

this

resource

@Stability(Stable)
public ActionProperties.Builder resource(IResource resource)

Sets the value of ActionProperties.getResource()

Parameters:

resource - The optional resource that is backing this Action. This is used for automatically handling Actions backed by resources from a different account and/or region.

Returns:

this

role

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

Sets the value of ActionProperties.getRole()

Parameters:

role - the value to be set.

Returns:

this

runOrder

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

Sets the value of ActionProperties.getRunOrder()

Parameters:

runOrder - The order in which AWS CodePipeline runs this action. For more information, see the AWS CodePipeline User Guide. https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements

Returns:

this

variablesNamespace

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

Sets the value of ActionProperties.getVariablesNamespace()

Parameters:

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

Returns:

this

version

@Stability(Stable)
public ActionProperties.Builder version(String version)

Sets the value of ActionProperties.getVersion()

Parameters:

version - the value to be set.

Returns:

this

build

@Stability(Stable)
public ActionProperties build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ActionProperties

Throws:

NullPointerException - if any required attribute was not provided