Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnStackPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnStackPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStackPropsMixin>

Enclosing class:

CfnStackPropsMixin

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

A fluent builder for CfnStackPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnStackPropsMixin	build()
static CfnStackPropsMixin.Builder	create()
static CfnStackPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnStackPropsMixin.Builder	notificationArns(List<String> notificationArns)	The Amazon SNS topic ARNs to publish stack related events.
CfnStackPropsMixin.Builder	parameters(Map<String,String> parameters)	The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
CfnStackPropsMixin.Builder	parameters(IResolvable parameters)	The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
CfnStackPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Key-value pairs to associate with this stack.
CfnStackPropsMixin.Builder	templateUrl(String templateUrl)	The URL of a file that contains the template body.
CfnStackPropsMixin.Builder	timeoutInMinutes(Number timeoutInMinutes)	The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnStackPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnStackPropsMixin.Builder.

create

@Stability(Stable)
public static CfnStackPropsMixin.Builder create()

Returns:

a new instance of CfnStackPropsMixin.Builder.

notificationArns

@Stability(Stable)
public CfnStackPropsMixin.Builder notificationArns(List<String> notificationArns)

The Amazon SNS topic ARNs to publish stack related events.

You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

Parameters:

notificationArns - The Amazon SNS topic ARNs to publish stack related events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-notificationarns

parameters

@Stability(Stable)
public CfnStackPropsMixin.Builder parameters(Map<String,String> parameters)

The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.

If you use the Ref function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type String . In other words, you can't pass values that are of type CommaDelimitedList to nested stacks.

Required if the nested stack requires input parameters.

Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

Parameters:

parameters - The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-parameters

parameters

@Stability(Stable)
public CfnStackPropsMixin.Builder parameters(IResolvable parameters)

The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.

If you use the Ref function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type String . In other words, you can't pass values that are of type CommaDelimitedList to nested stacks.

Required if the nested stack requires input parameters.

Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

Parameters:

parameters - The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-parameters

tags

@Stability(Stable)
public CfnStackPropsMixin.Builder tags(List<? extends CfnTag> tags)

Key-value pairs to associate with this stack.

CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

Parameters:

tags - Key-value pairs to associate with this stack. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-tags

templateUrl

@Stability(Stable)
public CfnStackPropsMixin.Builder templateUrl(String templateUrl)

The URL of a file that contains the template body.

The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket. The location for an Amazon S3 bucket must start with https:// .

Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

Parameters:

templateUrl - The URL of a file that contains the template body. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-templateurl

timeoutInMinutes

@Stability(Stable)
public CfnStackPropsMixin.Builder timeoutInMinutes(Number timeoutInMinutes)

The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

The default is no timeout. When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.

Updates aren't supported.

Parameters:

timeoutInMinutes - The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-timeoutinminutes

build

@Stability(Stable)
public CfnStackPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnStackPropsMixin.