Package software.amazon.awscdk.pipelines

Class ProduceActionOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.ProduceActionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ProduceActionOptions>

Enclosing interface:

ProduceActionOptions

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

A builder for ProduceActionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ProduceActionOptions.Builder	actionName(String actionName)	Sets the value of ProduceActionOptions.getActionName()
ProduceActionOptions.Builder	artifacts(ArtifactMap artifacts)	Sets the value of ProduceActionOptions.getArtifacts()
ProduceActionOptions.Builder	beforeSelfMutation(Boolean beforeSelfMutation)	Sets the value of ProduceActionOptions.getBeforeSelfMutation()
ProduceActionOptions	build()	Builds the configured instance.
ProduceActionOptions.Builder	codeBuildDefaults(CodeBuildOptions codeBuildDefaults)	Sets the value of ProduceActionOptions.getCodeBuildDefaults()
ProduceActionOptions.Builder	fallbackArtifact(Artifact fallbackArtifact)	Sets the value of ProduceActionOptions.getFallbackArtifact()
ProduceActionOptions.Builder	pipeline(CodePipeline pipeline)	Sets the value of ProduceActionOptions.getPipeline()
ProduceActionOptions.Builder	runOrder(Number runOrder)	Sets the value of ProduceActionOptions.getRunOrder()
ProduceActionOptions.Builder	scope(software.constructs.Construct scope)	Sets the value of ProduceActionOptions.getScope()
ProduceActionOptions.Builder	stackOutputsMap(StackOutputsMap stackOutputsMap)	Sets the value of ProduceActionOptions.getStackOutputsMap()
ProduceActionOptions.Builder	variablesNamespace(String variablesNamespace)	Sets the value of ProduceActionOptions.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

actionName

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

Sets the value of ProduceActionOptions.getActionName()

Parameters:

actionName - Name the action should get. This parameter is required.

Returns:

this

artifacts

@Stability(Stable)
public ProduceActionOptions.Builder artifacts(ArtifactMap artifacts)

Sets the value of ProduceActionOptions.getArtifacts()

Parameters:

artifacts - Helper object to translate FileSets to CodePipeline Artifacts. This parameter is required.

Returns:

this

pipeline

@Stability(Stable)
public ProduceActionOptions.Builder pipeline(CodePipeline pipeline)

Sets the value of ProduceActionOptions.getPipeline()

Parameters:

pipeline - The pipeline the action is being generated for. This parameter is required.

Returns:

this

runOrder

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

Sets the value of ProduceActionOptions.getRunOrder()

Parameters:

runOrder - RunOrder the action should get. This parameter is required.

Returns:

this

scope

@Stability(Stable)
public ProduceActionOptions.Builder scope(software.constructs.Construct scope)

Sets the value of ProduceActionOptions.getScope()

Parameters:

scope - Scope in which to create constructs. This parameter is required.

Returns:

this

stackOutputsMap

@Stability(Stable)
public ProduceActionOptions.Builder stackOutputsMap(StackOutputsMap stackOutputsMap)

Sets the value of ProduceActionOptions.getStackOutputsMap()

Parameters:

stackOutputsMap - Helper object to produce variables exported from stack deployments. This parameter is required. If your step references outputs from a stack deployment, use this to map the output references to Codepipeline variable names.

Note - Codepipeline variables can only be referenced in action configurations.

Returns:

this

beforeSelfMutation

@Stability(Stable)
public ProduceActionOptions.Builder beforeSelfMutation(Boolean beforeSelfMutation)

Sets the value of ProduceActionOptions.getBeforeSelfMutation()

Parameters:

beforeSelfMutation - Whether or not this action is inserted before self mutation. If it is, the action should take care to reflect some part of its own definition in the pipeline action definition, to trigger a restart after self-mutation (if necessary).

Returns:

this

codeBuildDefaults

@Stability(Stable)
public ProduceActionOptions.Builder codeBuildDefaults(CodeBuildOptions codeBuildDefaults)

Sets the value of ProduceActionOptions.getCodeBuildDefaults()

Parameters:

codeBuildDefaults - If this action factory creates a CodeBuild step, default options to inherit.

Returns:

this

fallbackArtifact

@Stability(Stable)
public ProduceActionOptions.Builder fallbackArtifact(Artifact fallbackArtifact)

Sets the value of ProduceActionOptions.getFallbackArtifact()

Parameters:

fallbackArtifact - An input artifact that CodeBuild projects that don't actually need an input artifact can use. CodeBuild Projects MUST have an input artifact in order to be added to the Pipeline. If the Project doesn't actually care about its input (it can be anything), it can use the Artifact passed here.

Returns:

this

variablesNamespace

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

Sets the value of ProduceActionOptions.getVariablesNamespace()

Parameters:

variablesNamespace - If this step is producing outputs, the variables namespace assigned to it. Pass this on to the Action you are creating.

Returns:

this

build

@Stability(Stable)
public ProduceActionOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ProduceActionOptions

Throws:

NullPointerException - if any required attribute was not provided