software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationDeleteStackActionProps.Builder

java.lang.Object

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

Enclosing interface:

CloudFormationDeleteStackActionProps

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

A builder for CloudFormationDeleteStackActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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

account

@Stability(value=Stable)
public CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.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 CloudFormationDeleteStackActionProps.Builder parameterOverrides(Map<String,Object> parameterOverrides)

Sets the value of ParameterOverrides

Parameters:

parameterOverrides - Additional template parameters.

Returns:

this

region

@Stability(value=Stable)
public CloudFormationDeleteStackActionProps.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

templateConfiguration

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

Builds the configured instance.

Returns:

a new instance of CloudFormationDeleteStackActionProps

Throws:

NullPointerException - if any required attribute was not provided