software.amazon.awscdk.core

Class CfnStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.core.CfnStack

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.7.0 (build 179a3a5)",
           date="2020-07-02T12:03:03.193Z")
 @Stability(value=Stable)
public class CfnStack
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::Stack`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStack.Builder A fluent builder for CfnStack.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStack(Construct scope, String id, CfnStackProps props) Create a new `AWS::CloudFormation::Stack`.
protected	CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static CfnStack	fromCloudFormation(Construct scope, String id, Object resourceAttributes, FromCloudFormationOptions options) A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.
protected Map<String,Object>	getCfnProperties()
List<String>	getNotificationArns() `AWS::CloudFormation::Stack.NotificationARNs`.
Object	getParameters() `AWS::CloudFormation::Stack.Parameters`.
TagManager	getTags() `AWS::CloudFormation::Stack.Tags`.
String	getTemplateUrl() `AWS::CloudFormation::Stack.TemplateURL`.
Number	getTimeoutInMinutes() `AWS::CloudFormation::Stack.TimeoutInMinutes`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setNotificationArns(List<String> value) `AWS::CloudFormation::Stack.NotificationARNs`.
void	setParameters(IResolvable value) `AWS::CloudFormation::Stack.Parameters`.
void	setParameters(Map<String,String> value) `AWS::CloudFormation::Stack.Parameters`.
void	setTemplateUrl(String value) `AWS::CloudFormation::Stack.TemplateURL`.
void	setTimeoutInMinutes(Number value) `AWS::CloudFormation::Stack.TimeoutInMinutes`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getUpdatedProperites, isCfnResource, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStack

protected CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

CfnStack

protected CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStack

@Stability(value=Stable)
public CfnStack(@NotNull
                                         Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnStackProps props)

Create a new `AWS::CloudFormation::Stack`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

fromCloudFormation

@Stability(value=Experimental)
 @NotNull
public static CfnStack fromCloudFormation(@NotNull
                                                                                   Construct scope,
                                                                                   @NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   Object resourceAttributes,
                                                                                   @NotNull
                                                                                   FromCloudFormationOptions options)

A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource.

Used in the @aws-cdk/cloudformation-include module.

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

resourceAttributes - This parameter is required.

options - This parameter is required.

inspect

@Stability(value=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

EXPERIMENTAL

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::CloudFormation::Stack.Tags`.

See Also:

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

getTemplateUrl

@Stability(value=Stable)
 @NotNull
public String getTemplateUrl()

`AWS::CloudFormation::Stack.TemplateURL`.

See Also:

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

setTemplateUrl

@Stability(value=Stable)
public void setTemplateUrl(@NotNull
                                                    String value)

`AWS::CloudFormation::Stack.TemplateURL`.

See Also:

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

getNotificationArns

@Stability(value=Stable)
 @Nullable
public List<String> getNotificationArns()

`AWS::CloudFormation::Stack.NotificationARNs`.

See Also:

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

setNotificationArns

@Stability(value=Stable)
public void setNotificationArns(@Nullable
                                                         List<String> value)

`AWS::CloudFormation::Stack.NotificationARNs`.

See Also:

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

getParameters

@Stability(value=Stable)
 @Nullable
public Object getParameters()

`AWS::CloudFormation::Stack.Parameters`.

See Also:

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

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   IResolvable value)

`AWS::CloudFormation::Stack.Parameters`.

See Also:

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

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   Map<String,String> value)

`AWS::CloudFormation::Stack.Parameters`.

See Also:

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

getTimeoutInMinutes

@Stability(value=Stable)
 @Nullable
public Number getTimeoutInMinutes()

`AWS::CloudFormation::Stack.TimeoutInMinutes`.

See Also:

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

setTimeoutInMinutes

@Stability(value=Stable)
public void setTimeoutInMinutes(@Nullable
                                                         Number value)

`AWS::CloudFormation::Stack.TimeoutInMinutes`.

See Also:

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