software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationCreateUpdateStackAction.Builder

java.lang.Object

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

Enclosing class:

CloudFormationCreateUpdateStackAction

@Stability(value=Stable)
public static final class CloudFormationCreateUpdateStackAction.Builder
extends Object

A fluent builder for CloudFormationCreateUpdateStackAction.

Method Summary

Modifier and Type	Method and Description
CloudFormationCreateUpdateStackAction.Builder	account(String account)
CloudFormationCreateUpdateStackAction.Builder	actionName(String actionName)
CloudFormationCreateUpdateStackAction.Builder	adminPermissions(Boolean adminPermissions)
CloudFormationCreateUpdateStackAction	build()
CloudFormationCreateUpdateStackAction.Builder	capabilities(List<CloudFormationCapabilities> capabilities)
static CloudFormationCreateUpdateStackAction.Builder	create()
CloudFormationCreateUpdateStackAction.Builder	deploymentRole(IRole deploymentRole)
CloudFormationCreateUpdateStackAction.Builder	extraInputs(List<Artifact> extraInputs)
CloudFormationCreateUpdateStackAction.Builder	output(Artifact output)
CloudFormationCreateUpdateStackAction.Builder	outputFileName(String outputFileName)
CloudFormationCreateUpdateStackAction.Builder	parameterOverrides(Map<String,Object> parameterOverrides)
CloudFormationCreateUpdateStackAction.Builder	region(String region)
CloudFormationCreateUpdateStackAction.Builder	replaceOnFailure(Boolean replaceOnFailure)
CloudFormationCreateUpdateStackAction.Builder	role(IRole role)
CloudFormationCreateUpdateStackAction.Builder	runOrder(Number runOrder)
CloudFormationCreateUpdateStackAction.Builder	stackName(String stackName)
CloudFormationCreateUpdateStackAction.Builder	templateConfiguration(ArtifactPath templateConfiguration)
CloudFormationCreateUpdateStackAction.Builder	templatePath(ArtifactPath templatePath)

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CloudFormationCreateUpdateStackAction.Builder create()

Returns:

a new instance of CloudFormationCreateUpdateStackAction.Builder.

actionName

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder actionName(String actionName)

Parameters:

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

Returns:

this

runOrder

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder runOrder(Number runOrder)

Parameters:

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

Returns:

this

role

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder role(IRole role)

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. This parameter is required.

Returns:

this

adminPermissions

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder adminPermissions(Boolean adminPermissions)

Parameters:

adminPermissions - Whether to grant full permissions to CloudFormation while deploying this template. This parameter is required.

Returns:

this

stackName

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder stackName(String stackName)

Parameters:

stackName - The name of the stack to apply this action to. This parameter is required.

Returns:

this

templatePath

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder templatePath(ArtifactPath templatePath)

Parameters:

templatePath - Input artifact with the CloudFormation template to deploy. This parameter is required.

Returns:

this

account

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder account(String account)

Parameters:

account - The AWS account this Action is supposed to operate in. **Note**: if you specify the `role` property, this is ignored - the action will operate in the same region the passed role does. This parameter is required.

Returns:

this

capabilities

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder capabilities(List<CloudFormationCapabilities> capabilities)

Parameters:

capabilities - Acknowledge certain changes made as part of deployment. This parameter is required.

Returns:

this

deploymentRole

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder deploymentRole(IRole deploymentRole)

Parameters:

deploymentRole - IAM role to assume when deploying changes. This parameter is required.

Returns:

this

extraInputs

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder extraInputs(List<Artifact> extraInputs)

Parameters:

extraInputs - The list of additional input Artifacts for this Action. This is especially useful when used in conjunction with the `parameterOverrides` property. For example, if you have:. This parameter is required.

Returns:

this

output

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder output(Artifact output)

Parameters:

output - The name of the output artifact to generate. This parameter is required.

Returns:

this

outputFileName

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder outputFileName(String outputFileName)

Parameters:

outputFileName - A name for the filename in the output artifact to store the AWS CloudFormation call's result. This parameter is required.

Returns:

this

parameterOverrides

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder parameterOverrides(Map<String,Object> parameterOverrides)

Parameters:

parameterOverrides - Additional template parameters. This parameter is required.

Returns:

this

region

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder region(String region)

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 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. This parameter is required.

Returns:

this

replaceOnFailure

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder replaceOnFailure(Boolean replaceOnFailure)

Parameters:

replaceOnFailure - Replace the stack if it's in a failed state. This parameter is required.

Returns:

this

templateConfiguration

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction.Builder templateConfiguration(ArtifactPath templateConfiguration)

Parameters:

templateConfiguration - Input artifact to use for template parameters values and stack policy. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CloudFormationCreateUpdateStackAction build()