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.

StackEvent

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

type StackEvent struct { ClientRequestToken *string `min:"1" type:"string"` EventId *string `type:"string" required:"true"` LogicalResourceId *string `type:"string"` PhysicalResourceId *string `type:"string"` ResourceProperties *string `type:"string"` ResourceStatus *string `type:"string" enum:"ResourceStatus"` ResourceStatusReason *string `type:"string"` ResourceType *string `min:"1" type:"string"` StackId *string `type:"string" required:"true"` StackName *string `type:"string" required:"true"` Timestamp *time.Time `type:"timestamp" required:"true"` }

The StackEvent data type.

ClientRequestToken

Type: *string

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

EventId

Type: *string

The unique ID of this event.

EventId is a required field

LogicalResourceId

Type: *string

The logical name of the resource specified in the template.

PhysicalResourceId

Type: *string

The name or unique identifier associated with the physical instance of the resource.

ResourceProperties

Type: *string

BLOB of the properties used to create the resource.

ResourceStatus

Type: *string

Current status of the resource.

ResourceStatusReason

Type: *string

Success/failure message associated with the resource.

ResourceType

Type: *string

Type of resource. (For more information, go to AWS Resource Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the AWS CloudFormation User Guide.)

StackId

Type: *string

The unique ID name of the instance of the stack.

StackId is a required field

StackName

Type: *string

The name associated with a stack.

StackName is a required field

Timestamp

Type: *time.Time

Time the status was updated.

Timestamp is a required field

Method

GoString

func (s StackEvent) GoString() string

GoString returns the string representation

SetClientRequestToken

func (s *StackEvent) SetClientRequestToken(v string) *StackEvent

SetClientRequestToken sets the ClientRequestToken field's value.

SetEventId

func (s *StackEvent) SetEventId(v string) *StackEvent

SetEventId sets the EventId field's value.

SetLogicalResourceId

func (s *StackEvent) SetLogicalResourceId(v string) *StackEvent

SetLogicalResourceId sets the LogicalResourceId field's value.

SetPhysicalResourceId

func (s *StackEvent) SetPhysicalResourceId(v string) *StackEvent

SetPhysicalResourceId sets the PhysicalResourceId field's value.

SetResourceProperties

func (s *StackEvent) SetResourceProperties(v string) *StackEvent

SetResourceProperties sets the ResourceProperties field's value.

SetResourceStatus

func (s *StackEvent) SetResourceStatus(v string) *StackEvent

SetResourceStatus sets the ResourceStatus field's value.

SetResourceStatusReason

func (s *StackEvent) SetResourceStatusReason(v string) *StackEvent

SetResourceStatusReason sets the ResourceStatusReason field's value.

SetResourceType

func (s *StackEvent) SetResourceType(v string) *StackEvent

SetResourceType sets the ResourceType field's value.

SetStackId

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

SetStackId sets the StackId field's value.

SetStackName

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

SetStackName sets the StackName field's value.

SetTimestamp

func (s *StackEvent) SetTimestamp(v time.Time) *StackEvent

SetTimestamp sets the Timestamp field's value.

String

func (s StackEvent) String() string

String returns the string representation

On this page: