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

Class CloudFormationCreateUpdateStackActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationCreateUpdateStackActionProps>

Enclosing interface:

CloudFormationCreateUpdateStackActionProps

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

A builder for CloudFormationCreateUpdateStackActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CloudFormationCreateUpdateStackActionProps.Builder	account(String account)	Sets the value of CloudFormationCreateUpdateStackActionProps.getAccount()
CloudFormationCreateUpdateStackActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
CloudFormationCreateUpdateStackActionProps.Builder	adminPermissions(Boolean adminPermissions)	Sets the value of CloudFormationCreateUpdateStackActionProps.getAdminPermissions()
CloudFormationCreateUpdateStackActionProps	build()	Builds the configured instance.
CloudFormationCreateUpdateStackActionProps.Builder	cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)	Sets the value of CloudFormationCreateUpdateStackActionProps.getCfnCapabilities()
CloudFormationCreateUpdateStackActionProps.Builder	deploymentRole(IRole deploymentRole)	Sets the value of CloudFormationCreateUpdateStackActionProps.getDeploymentRole()
CloudFormationCreateUpdateStackActionProps.Builder	extraInputs(List<? extends Artifact> extraInputs)	Sets the value of CloudFormationCreateUpdateStackActionProps.getExtraInputs()
CloudFormationCreateUpdateStackActionProps.Builder	output(Artifact output)	Sets the value of CloudFormationCreateUpdateStackActionProps.getOutput()
CloudFormationCreateUpdateStackActionProps.Builder	outputFileName(String outputFileName)	Sets the value of CloudFormationCreateUpdateStackActionProps.getOutputFileName()
CloudFormationCreateUpdateStackActionProps.Builder	parameterOverrides(Map<String,? extends Object> parameterOverrides)	Sets the value of CloudFormationCreateUpdateStackActionProps.getParameterOverrides()
CloudFormationCreateUpdateStackActionProps.Builder	region(String region)	Sets the value of CloudFormationCreateUpdateStackActionProps.getRegion()
CloudFormationCreateUpdateStackActionProps.Builder	replaceOnFailure(Boolean replaceOnFailure)	Sets the value of CloudFormationCreateUpdateStackActionProps.getReplaceOnFailure()
CloudFormationCreateUpdateStackActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
CloudFormationCreateUpdateStackActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
CloudFormationCreateUpdateStackActionProps.Builder	stackName(String stackName)	Sets the value of CloudFormationCreateUpdateStackActionProps.getStackName()
CloudFormationCreateUpdateStackActionProps.Builder	templateConfiguration(ArtifactPath templateConfiguration)	Sets the value of CloudFormationCreateUpdateStackActionProps.getTemplateConfiguration()
CloudFormationCreateUpdateStackActionProps.Builder	templatePath(ArtifactPath templatePath)	Sets the value of CloudFormationCreateUpdateStackActionProps.getTemplatePath()
CloudFormationCreateUpdateStackActionProps.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

adminPermissions

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder adminPermissions(Boolean adminPermissions)

Sets the value of CloudFormationCreateUpdateStackActionProps.getAdminPermissions()

Parameters:

adminPermissions - Whether to grant full permissions to CloudFormation while deploying this template. This parameter is required. Setting this to true affects the defaults for role and capabilities, if you don't specify any alternatives.

The default role that will be created for you will have full (i.e., *) permissions on all resources, and the deployment will have named IAM capabilities (i.e., able to create all IAM resources).

This is a shorthand that you can use if you fully trust the templates that are deployed in this pipeline. If you want more fine-grained permissions, use addToRolePolicy and capabilities to control what the CloudFormation deployment is allowed to do.

Returns:

this

stackName

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder stackName(String stackName)

Sets the value of CloudFormationCreateUpdateStackActionProps.getStackName()

Parameters:

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

Returns:

this

templatePath

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder templatePath(ArtifactPath templatePath)

Sets the value of CloudFormationCreateUpdateStackActionProps.getTemplatePath()

Parameters:

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

Returns:

this

account

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

Sets the value of CloudFormationCreateUpdateStackActionProps.getAccount()

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.

Returns:

this

cfnCapabilities

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)

Sets the value of CloudFormationCreateUpdateStackActionProps.getCfnCapabilities()

Parameters:

cfnCapabilities - Acknowledge certain changes made as part of deployment. For stacks that contain certain resources, explicit acknowledgement is required that AWS CloudFormation might create or update those resources. For example, you must specify ANONYMOUS_IAM or NAMED_IAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information, see the link below.

Returns:

this

deploymentRole

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder deploymentRole(IRole deploymentRole)

Sets the value of CloudFormationCreateUpdateStackActionProps.getDeploymentRole()

Parameters:

deploymentRole - IAM role to assume when deploying changes. If not specified, a fresh role is created. The role is created with zero permissions unless adminPermissions is true, in which case the role will have full permissions.

Returns:

this

extraInputs

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder extraInputs(List<? extends Artifact> extraInputs)

Sets the value of CloudFormationCreateUpdateStackActionProps.getExtraInputs()

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:

parameterOverrides: { 'Param1': action1.outputArtifact.bucketName, 'Param2': action2.outputArtifact.objectKey, }

, if the output Artifacts of action1 and action2 were not used to set either the templateConfiguration or the templatePath properties, you need to make sure to include them in the extraInputs - otherwise, you'll get an "unrecognized Artifact" error during your Pipeline's execution.

Returns:

this

output

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

Sets the value of CloudFormationCreateUpdateStackActionProps.getOutput()

Parameters:

output - The name of the output artifact to generate. Only applied if outputFileName is set as well.

Returns:

this

outputFileName

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder outputFileName(String outputFileName)

Sets the value of CloudFormationCreateUpdateStackActionProps.getOutputFileName()

Parameters:

outputFileName - A name for the filename in the output artifact to store the AWS CloudFormation call's result. The file will contain the result of the call to AWS CloudFormation (for example the call to UpdateStack or CreateChangeSet).

AWS CodePipeline adds the file to the output artifact after performing the specified action.

Returns:

this

parameterOverrides

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder parameterOverrides(Map<String,? extends Object> parameterOverrides)

Sets the value of CloudFormationCreateUpdateStackActionProps.getParameterOverrides()

Parameters:

parameterOverrides - Additional template parameters. Template parameters specified here take precedence over template parameters found in the artifact specified by the templateConfiguration property.

We recommend that you use the template configuration file to specify most of your parameter values. Use parameter overrides to specify only dynamic parameter values (values that are unknown until you run the pipeline).

All parameter names must be present in the stack template.

Note: the entire object cannot be more than 1kB.

Returns:

this

region

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

Sets the value of CloudFormationCreateUpdateStackActionProps.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 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

replaceOnFailure

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder replaceOnFailure(Boolean replaceOnFailure)

Sets the value of CloudFormationCreateUpdateStackActionProps.getReplaceOnFailure()

Parameters:

replaceOnFailure - Replace the stack if it's in a failed state. If this is set to true and the stack is in a failed state (one of ROLLBACK_COMPLETE, ROLLBACK_FAILED, CREATE_FAILED, DELETE_FAILED, or UPDATE_ROLLBACK_FAILED), AWS CloudFormation deletes the stack and then creates a new stack.

If this is not set to true and the stack is in a failed state, the deployment fails.

Returns:

this

templateConfiguration

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.Builder templateConfiguration(ArtifactPath templateConfiguration)

Sets the value of CloudFormationCreateUpdateStackActionProps.getTemplateConfiguration()

Parameters:

templateConfiguration - Input artifact to use for template parameters values and stack policy. The template configuration file should contain a JSON object that should look like this: { "Parameters": {...}, "Tags": {...}, "StackPolicy": {... }}. For more information, see AWS CloudFormation Artifacts.

Note that if you include sensitive information, such as passwords, restrict access to this file.

Returns:

this

role

@Stability(Stable)
public CloudFormationCreateUpdateStackActionProps.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 CloudFormationCreateUpdateStackActionProps.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 CloudFormationCreateUpdateStackActionProps.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 CloudFormationCreateUpdateStackActionProps.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 CloudFormationCreateUpdateStackActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CloudFormationCreateUpdateStackActionProps

Throws:

NullPointerException - if any required attribute was not provided