AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Stack

import "github.com/aws/aws-sdk-go/service/cloudformation"

type Stack struct { Capabilities []*string `type:"list"` ChangeSetId *string `min:"1" type:"string"` CreationTime *time.Time `type:"timestamp" required:"true"` DeletionTime *time.Time `type:"timestamp"` Description *string `min:"1" type:"string"` DisableRollback *bool `type:"boolean"` DriftInformation *StackDriftInformation `type:"structure"` EnableTerminationProtection *bool `type:"boolean"` LastUpdatedTime *time.Time `type:"timestamp"` NotificationARNs []*string `type:"list"` Outputs []*Output `type:"list"` Parameters []*Parameter `type:"list"` ParentId *string `type:"string"` RoleARN *string `min:"20" type:"string"` RollbackConfiguration *RollbackConfiguration `type:"structure"` RootId *string `type:"string"` StackId *string `type:"string"` StackName *string `type:"string" required:"true"` StackStatus *string `type:"string" required:"true" enum:"StackStatus"` StackStatusReason *string `type:"string"` Tags []*Tag `type:"list"` TimeoutInMinutes *int64 `min:"1" type:"integer"` }

The Stack data type.

Capabilities

Type: []*string

The capabilities allowed in the stack.

ChangeSetId

Type: *string

The unique ID of the change set.

CreationTime

Type: *time.Time

The time at which the stack was created.

CreationTime is a required field

DeletionTime

Type: *time.Time

The time the stack was deleted.

Description

Type: *string

A user-defined description associated with the stack.

DisableRollback

Type: *bool

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

DriftInformation

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

EnableTerminationProtection

Type: *bool

Whether termination protection is enabled for the stack.

For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the AWS CloudFormation User Guide.

LastUpdatedTime

Type: *time.Time

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

NotificationARNs

Type: []*string

SNS topic ARNs to which stack related events are published.

Outputs

The Output data type.

Parameters

The Parameter data type.

ParentId

Type: *string

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) in the AWS CloudFormation User Guide.

RoleARN

Type: *string

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.

RollbackConfiguration

Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).

RootId

Type: *string

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) in the AWS CloudFormation User Guide.

StackId

Type: *string

Unique identifier of the stack.

StackName

Type: *string

The name associated with the stack.

StackName is a required field

StackStatus

Type: *string

Current status of the stack.

StackStatus is a required field

StackStatusReason

Type: *string

Success/failure message associated with the stack status.

Tags

The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.

TimeoutInMinutes

Type: *int64

The amount of time within which stack creation should complete.

Method

GoString

func (s Stack) GoString() string

GoString returns the string representation

SetCapabilities

func (s *Stack) SetCapabilities(v []*string) *Stack

SetCapabilities sets the Capabilities field's value.

SetChangeSetId

func (s *Stack) SetChangeSetId(v string) *Stack

SetChangeSetId sets the ChangeSetId field's value.

SetCreationTime

func (s *Stack) SetCreationTime(v time.Time) *Stack

SetCreationTime sets the CreationTime field's value.

SetDeletionTime

func (s *Stack) SetDeletionTime(v time.Time) *Stack

SetDeletionTime sets the DeletionTime field's value.

SetDescription

func (s *Stack) SetDescription(v string) *Stack

SetDescription sets the Description field's value.

SetDisableRollback

func (s *Stack) SetDisableRollback(v bool) *Stack

SetDisableRollback sets the DisableRollback field's value.

SetDriftInformation

func (s *Stack) SetDriftInformation(v *StackDriftInformation) *Stack

SetDriftInformation sets the DriftInformation field's value.

SetEnableTerminationProtection

func (s *Stack) SetEnableTerminationProtection(v bool) *Stack

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

SetLastUpdatedTime

func (s *Stack) SetLastUpdatedTime(v time.Time) *Stack

SetLastUpdatedTime sets the LastUpdatedTime field's value.

SetNotificationARNs

func (s *Stack) SetNotificationARNs(v []*string) *Stack

SetNotificationARNs sets the NotificationARNs field's value.

SetOutputs

func (s *Stack) SetOutputs(v []*Output) *Stack

SetOutputs sets the Outputs field's value.

SetParameters

func (s *Stack) SetParameters(v []*Parameter) *Stack

SetParameters sets the Parameters field's value.

SetParentId

func (s *Stack) SetParentId(v string) *Stack

SetParentId sets the ParentId field's value.

SetRoleARN

func (s *Stack) SetRoleARN(v string) *Stack

SetRoleARN sets the RoleARN field's value.

SetRollbackConfiguration

func (s *Stack) SetRollbackConfiguration(v *RollbackConfiguration) *Stack

SetRollbackConfiguration sets the RollbackConfiguration field's value.

SetRootId

func (s *Stack) SetRootId(v string) *Stack

SetRootId sets the RootId field's value.

SetStackId

func (s *Stack) SetStackId(v string) *Stack

SetStackId sets the StackId field's value.

SetStackName

func (s *Stack) SetStackName(v string) *Stack

SetStackName sets the StackName field's value.

SetStackStatus

func (s *Stack) SetStackStatus(v string) *Stack

SetStackStatus sets the StackStatus field's value.

SetStackStatusReason

func (s *Stack) SetStackStatusReason(v string) *Stack

SetStackStatusReason sets the StackStatusReason field's value.

SetTags

func (s *Stack) SetTags(v []*Tag) *Stack

SetTags sets the Tags field's value.

SetTimeoutInMinutes

func (s *Stack) SetTimeoutInMinutes(v int64) *Stack

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

String

func (s Stack) String() string

String returns the string representation

On this page: