software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationCreateUpdateStackActionProps.Builder

java.lang.Object

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

Enclosing interface:

CloudFormationCreateUpdateStackActionProps

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

A builder for CloudFormationCreateUpdateStackActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CloudFormationCreateUpdateStackActionProps.Builder	account(String account) Sets the value of Account
CloudFormationCreateUpdateStackActionProps.Builder	actionName(String actionName) Sets the value of ActionName
CloudFormationCreateUpdateStackActionProps.Builder	adminPermissions(Boolean adminPermissions) Sets the value of AdminPermissions
CloudFormationCreateUpdateStackActionProps	build() Builds the configured instance.
CloudFormationCreateUpdateStackActionProps.Builder	capabilities(List<CloudFormationCapabilities> capabilities) Sets the value of Capabilities
CloudFormationCreateUpdateStackActionProps.Builder	deploymentRole(IRole deploymentRole) Sets the value of DeploymentRole
CloudFormationCreateUpdateStackActionProps.Builder	extraInputs(List<Artifact> extraInputs) Sets the value of ExtraInputs
CloudFormationCreateUpdateStackActionProps.Builder	output(Artifact output) Sets the value of Output
CloudFormationCreateUpdateStackActionProps.Builder	outputFileName(String outputFileName) Sets the value of OutputFileName
CloudFormationCreateUpdateStackActionProps.Builder	parameterOverrides(Map<String,Object> parameterOverrides) Sets the value of ParameterOverrides
CloudFormationCreateUpdateStackActionProps.Builder	region(String region) Sets the value of Region
CloudFormationCreateUpdateStackActionProps.Builder	replaceOnFailure(Boolean replaceOnFailure) Sets the value of ReplaceOnFailure
CloudFormationCreateUpdateStackActionProps.Builder	role(IRole role) Sets the value of Role
CloudFormationCreateUpdateStackActionProps.Builder	runOrder(Number runOrder) Sets the value of RunOrder
CloudFormationCreateUpdateStackActionProps.Builder	stackName(String stackName) Sets the value of StackName
CloudFormationCreateUpdateStackActionProps.Builder	templateConfiguration(ArtifactPath templateConfiguration) Sets the value of TemplateConfiguration
CloudFormationCreateUpdateStackActionProps.Builder	templatePath(ArtifactPath templatePath) Sets the value of TemplatePath

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

adminPermissions

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

Sets the value of 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 CloudFormationCreateUpdateStackActionProps.Builder stackName(String stackName)

Sets the value of StackName

Parameters:

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

Returns:

this

templatePath

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

Sets the value of TemplatePath

Parameters:

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

Returns:

this

account

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

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

Returns:

this

capabilities

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

Sets the value of Capabilities

Parameters:

capabilities - Acknowledge certain changes made as part of deployment.

Returns:

this

deploymentRole

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

Sets the value of DeploymentRole

Parameters:

deploymentRole - IAM role to assume when deploying changes.

Returns:

this

extraInputs

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

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

Returns:

this

output

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

Sets the value of Output

Parameters:

output - The name of the output artifact to generate.

Returns:

this

outputFileName

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

Sets the value of OutputFileName

Parameters:

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

Returns:

this

parameterOverrides

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

Sets the value of ParameterOverrides

Parameters:

parameterOverrides - Additional template parameters.

Returns:

this

region

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

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

Returns:

this

replaceOnFailure

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

Sets the value of ReplaceOnFailure

Parameters:

replaceOnFailure - Replace the stack if it's in a failed state.

Returns:

this

templateConfiguration

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

Sets the value of TemplateConfiguration

Parameters:

templateConfiguration - Input artifact to use for template parameters values and stack policy.

Returns:

this

role

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

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

Returns:

this

actionName

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

Sets the value of 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 CloudFormationCreateUpdateStackActionProps.Builder runOrder(Number runOrder)

Sets the value of RunOrder

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of CloudFormationCreateUpdateStackActionProps

Throws:

NullPointerException - if any required attribute was not provided