@Generated(value="software.amazon.awssdk:codegen") public class Stack extends Object implements ToCopyableBuilder<Stack.Builder,Stack>
The Stack data type.
Modifier and Type | Class and Description |
---|---|
static interface |
Stack.Builder |
Modifier and Type | Method and Description |
---|---|
static Stack.Builder |
builder() |
List<Capability> |
capabilities()
The capabilities allowed in the stack.
|
List<String> |
capabilitiesStrings()
The capabilities allowed in the stack.
|
String |
changeSetId()
The unique ID of the change set.
|
Instant |
creationTime()
The time at which the stack was created.
|
Instant |
deletionTime()
The time the stack was deleted.
|
String |
description()
A user-defined description associated with the stack.
|
Boolean |
disableRollback()
Boolean to enable or disable rollback on stack creation failures:
|
Boolean |
enableTerminationProtection()
Whether termination protection is enabled for the stack.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Instant |
lastUpdatedTime()
The time the stack was last updated.
|
List<String> |
notificationARNs()
SNS topic ARNs to which stack related events are published.
|
List<Output> |
outputs()
A list of output structures.
|
List<Parameter> |
parameters()
A list of
Parameter structures. |
String |
parentId()
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
stack.
|
String |
roleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the
stack.
|
RollbackConfiguration |
rollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.
|
String |
rootId()
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to
which the nested stack ultimately belongs.
|
static Class<? extends Stack.Builder> |
serializableBuilderClass() |
String |
stackId()
Unique identifier of the stack.
|
String |
stackName()
The name associated with the stack.
|
StackStatus |
stackStatus()
Current status of the stack.
|
String |
stackStatusReason()
Success/failure message associated with the stack status.
|
String |
stackStatusString()
Current status of the stack.
|
List<Tag> |
tags()
A list of
Tag s that specify information about the stack. |
Integer |
timeoutInMinutes()
The amount of time within which stack creation should complete.
|
Stack.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String stackId()
Unique identifier of the stack.
public String stackName()
The name associated with the stack.
public String changeSetId()
The unique ID of the change set.
public String description()
A user-defined description associated with the stack.
public List<Parameter> parameters()
A list of Parameter
structures.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Parameter
structures.public Instant creationTime()
The time at which the stack was created.
public Instant deletionTime()
The time the stack was deleted.
public Instant lastUpdatedTime()
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
public RollbackConfiguration rollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public StackStatus stackStatus()
Current status of the stack.
If the service returns an enum value that is not available in the current SDK version, stackStatus
will
return StackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stackStatusString()
.
StackStatus
public String stackStatusString()
Current status of the stack.
If the service returns an enum value that is not available in the current SDK version, stackStatus
will
return StackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stackStatusString()
.
StackStatus
public String stackStatusReason()
Success/failure message associated with the stack status.
public Boolean disableRollback()
Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
true
: disable rollback
false
: enable rollback
public List<String> notificationARNs()
SNS topic ARNs to which stack related events are published.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Integer timeoutInMinutes()
The amount of time within which stack creation should complete.
public List<Capability> capabilities()
The capabilities allowed in the stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> capabilitiesStrings()
The capabilities allowed in the stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Output> outputs()
A list of output structures.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String roleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
public List<Tag> tags()
A list of Tag
s that specify information about the stack.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Tag
s that specify information about the stack.public Boolean enableTerminationProtection()
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
public String parentId()
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
public String rootId()
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
public Stack.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Stack.Builder,Stack>
public static Stack.Builder builder()
public static Class<? extends Stack.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.