Package software.amazon.awscdk.services.codepipeline

Class CfnPipeline.ActionDeclarationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.CfnPipeline.ActionDeclarationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipeline.ActionDeclarationProperty>

Enclosing interface:

CfnPipeline.ActionDeclarationProperty

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

A builder for CfnPipeline.ActionDeclarationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPipeline.ActionDeclarationProperty.Builder	actionTypeId(IResolvable actionTypeId)	Sets the value of CfnPipeline.ActionDeclarationProperty.getActionTypeId()
CfnPipeline.ActionDeclarationProperty.Builder	actionTypeId(CfnPipeline.ActionTypeIdProperty actionTypeId)	Sets the value of CfnPipeline.ActionDeclarationProperty.getActionTypeId()
CfnPipeline.ActionDeclarationProperty	build()	Builds the configured instance.
CfnPipeline.ActionDeclarationProperty.Builder	commands(List<String> commands)	Sets the value of CfnPipeline.ActionDeclarationProperty.getCommands()
CfnPipeline.ActionDeclarationProperty.Builder	configuration(Object configuration)	Sets the value of CfnPipeline.ActionDeclarationProperty.getConfiguration()
CfnPipeline.ActionDeclarationProperty.Builder	inputArtifacts(List<? extends Object> inputArtifacts)	Sets the value of CfnPipeline.ActionDeclarationProperty.getInputArtifacts()
CfnPipeline.ActionDeclarationProperty.Builder	inputArtifacts(IResolvable inputArtifacts)	Sets the value of CfnPipeline.ActionDeclarationProperty.getInputArtifacts()
CfnPipeline.ActionDeclarationProperty.Builder	name(String name)	Sets the value of CfnPipeline.ActionDeclarationProperty.getName()
CfnPipeline.ActionDeclarationProperty.Builder	namespace(String namespace)	Sets the value of CfnPipeline.ActionDeclarationProperty.getNamespace()
CfnPipeline.ActionDeclarationProperty.Builder	outputArtifacts(List<? extends Object> outputArtifacts)	Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputArtifacts()
CfnPipeline.ActionDeclarationProperty.Builder	outputArtifacts(IResolvable outputArtifacts)	Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputArtifacts()
CfnPipeline.ActionDeclarationProperty.Builder	outputVariables(List<String> outputVariables)	Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputVariables()
CfnPipeline.ActionDeclarationProperty.Builder	region(String region)	Sets the value of CfnPipeline.ActionDeclarationProperty.getRegion()
CfnPipeline.ActionDeclarationProperty.Builder	roleArn(String roleArn)	Sets the value of CfnPipeline.ActionDeclarationProperty.getRoleArn()
CfnPipeline.ActionDeclarationProperty.Builder	runOrder(Number runOrder)	Sets the value of CfnPipeline.ActionDeclarationProperty.getRunOrder()
CfnPipeline.ActionDeclarationProperty.Builder	timeoutInMinutes(Number timeoutInMinutes)	Sets the value of CfnPipeline.ActionDeclarationProperty.getTimeoutInMinutes()

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

actionTypeId

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder actionTypeId(IResolvable actionTypeId)

Sets the value of CfnPipeline.ActionDeclarationProperty.getActionTypeId()

Parameters:

actionTypeId - Specifies the action type and the provider of the action. This parameter is required.

Returns:

this

actionTypeId

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder actionTypeId(CfnPipeline.ActionTypeIdProperty actionTypeId)

Sets the value of CfnPipeline.ActionDeclarationProperty.getActionTypeId()

Parameters:

actionTypeId - Specifies the action type and the provider of the action. This parameter is required.

Returns:

this

name

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder name(String name)

Sets the value of CfnPipeline.ActionDeclarationProperty.getName()

Parameters:

name - The action declaration's name. This parameter is required.

Returns:

this

commands

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder commands(List<String> commands)

Sets the value of CfnPipeline.ActionDeclarationProperty.getCommands()

Parameters:

commands - The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in AWS CodeBuild .

Returns:

this

configuration

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder configuration(Object configuration)

Sets the value of CfnPipeline.ActionDeclarationProperty.getConfiguration()

Parameters:

configuration - The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide . For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide .

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : { Key : Value },

Returns:

this

inputArtifacts

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder inputArtifacts(IResolvable inputArtifacts)

Sets the value of CfnPipeline.ActionDeclarationProperty.getInputArtifacts()

Parameters:

inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .

Returns:

this

inputArtifacts

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder inputArtifacts(List<? extends Object> inputArtifacts)

Sets the value of CfnPipeline.ActionDeclarationProperty.getInputArtifacts()

Parameters:

inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the CodeBuild action reference page in the AWS CodePipeline User Guide .

Returns:

this

namespace

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder namespace(String namespace)

Sets the value of CfnPipeline.ActionDeclarationProperty.getNamespace()

Parameters:

namespace - The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

Returns:

this

outputArtifacts

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder outputArtifacts(IResolvable outputArtifacts)

Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputArtifacts()

Parameters:

outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

Returns:

this

outputArtifacts

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder outputArtifacts(List<? extends Object> outputArtifacts)

Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputArtifacts()

Parameters:

outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the Action structure reference in the AWS CodePipeline User Guide .

Returns:

this

outputVariables

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder outputVariables(List<String> outputVariables)

Sets the value of CfnPipeline.ActionDeclarationProperty.getOutputVariables()

Parameters:

outputVariables - The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.

Returns:

this

region

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder region(String region)

Sets the value of CfnPipeline.ActionDeclarationProperty.getRegion()

Parameters:

region - The action declaration's AWS Region, such as us-east-1.

Returns:

this

roleArn

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder roleArn(String roleArn)

Sets the value of CfnPipeline.ActionDeclarationProperty.getRoleArn()

Parameters:

roleArn - The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

Returns:

this

runOrder

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder runOrder(Number runOrder)

Sets the value of CfnPipeline.ActionDeclarationProperty.getRunOrder()

Parameters:

runOrder - The order in which actions are run.

Returns:

this

timeoutInMinutes

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty.Builder timeoutInMinutes(Number timeoutInMinutes)

Sets the value of CfnPipeline.ActionDeclarationProperty.getTimeoutInMinutes()

Parameters:

timeoutInMinutes - A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline . This attribute is available only to the manual approval ActionType.

Returns:

this

build

@Stability(Stable)
public CfnPipeline.ActionDeclarationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipeline.ActionDeclarationProperty>

Returns:

a new instance of CfnPipeline.ActionDeclarationProperty

Throws:

NullPointerException - if any required attribute was not provided