GetStackResult

data class GetStackResult(val capabilities: List<StackCapabilitiesItem>? = null, val changeSetId: String? = null, val creationTime: String? = null, val description: String? = null, val disableRollback: Boolean? = null, val enableTerminationProtection: Boolean? = null, val lastUpdateTime: String? = null, val notificationArns: List<String>? = null, val outputs: List<StackOutput>? = null, val parameters: Map<String, String>? = null, val parentId: String? = null, val roleArn: String? = null, val rootId: String? = null, val stackId: String? = null, val stackPolicyBody: Any? = null, val stackStatus: StackStatus? = null, val stackStatusReason: String? = null, val tags: List<Tag>? = null, val templateBody: Any? = null, val timeoutInMinutes: Int? = null)

Constructors

Link copied to clipboard
constructor(capabilities: List<StackCapabilitiesItem>? = null, changeSetId: String? = null, creationTime: String? = null, description: String? = null, disableRollback: Boolean? = null, enableTerminationProtection: Boolean? = null, lastUpdateTime: String? = null, notificationArns: List<String>? = null, outputs: List<StackOutput>? = null, parameters: Map<String, String>? = null, parentId: String? = null, roleArn: String? = null, rootId: String? = null, stackId: String? = null, stackPolicyBody: Any? = null, stackStatus: StackStatus? = null, stackStatusReason: String? = null, tags: List<Tag>? = null, templateBody: Any? = null, timeoutInMinutes: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.

Link copied to clipboard
val changeSetId: String? = null

The unique ID of the change set.

Link copied to clipboard
val creationTime: String? = null

The time at which the stack was created.

Link copied to clipboard
val description: String? = null

A user-defined description associated with the stack.

Link copied to clipboard

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure , but not both. Default: false

Link copied to clipboard

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide . Termination protection is deactivated on stacks by default. For nested stacks , termination protection is set on the root stack and can't be changed directly on the nested stack.

Link copied to clipboard
val lastUpdateTime: String? = null

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Link copied to clipboard

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

Link copied to clipboard
val outputs: List<StackOutput>? = null

A list of output structures.

Link copied to clipboard
val parameters: Map<String, String>? = null

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.

Link copied to clipboard
val parentId: String? = null

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 Embed stacks within other stacks using nested stacks in the AWS CloudFormation User Guide .

Link copied to clipboard
val roleArn: String? = null

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that's generated from your user credentials.

Link copied to clipboard
val rootId: String? = null

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Embed stacks within other stacks using nested stacks in the AWS CloudFormation User Guide .

Link copied to clipboard
val stackId: String? = null

Unique identifier of the stack.

Link copied to clipboard
val stackPolicyBody: Any? = null

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide . You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.

Link copied to clipboard

Current status of the stack.

Link copied to clipboard

Success/failure message associated with the stack status.

Link copied to clipboard
val tags: List<Tag>? = null

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.

Link copied to clipboard
val templateBody: Any? = null

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. Search the CloudFormation User Guide for AWS::CloudFormation::Stack for more information about the expected schema for this property.

Link copied to clipboard
val timeoutInMinutes: Int? = null

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.