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.

StackResourceDrift

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

type StackResourceDrift struct { ActualProperties *string `type:"string"` ExpectedProperties *string `type:"string"` LogicalResourceId *string `type:"string" required:"true"` PhysicalResourceId *string `type:"string"` PhysicalResourceIdContext []*PhysicalResourceIdContextKeyValuePair `type:"list"` PropertyDifferences []*PropertyDifference `type:"list"` ResourceType *string `min:"1" type:"string" required:"true"` StackId *string `type:"string" required:"true"` StackResourceDriftStatus *string `type:"string" required:"true" enum:"StackResourceDriftStatus"` Timestamp *time.Time `type:"timestamp" required:"true"` }

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

ActualProperties

Type: *string

A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

ExpectedProperties

Type: *string

A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

LogicalResourceId

Type: *string

The logical name of the resource specified in the template.

LogicalResourceId is a required field

PhysicalResourceId

Type: *string

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

PhysicalResourceIdContext

Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

PropertyDifferences

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

ResourceType

Type: *string

The type of the resource.

ResourceType is a required field

StackId

Type: *string

The ID of the stack.

StackId is a required field

StackResourceDriftStatus

Type: *string

Status of the resource's actual configuration compared to its expected configuration

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

  • IN_SYNC: The resources's actual configuration matches its expected template configuration.

  • NOT_CHECKED: AWS CloudFormation does not currently return this value.

StackResourceDriftStatus is a required field

Timestamp

Type: *time.Time

Time at which AWS CloudFormation performed drift detection on the stack resource.

Timestamp is a required field

Method

GoString

func (s StackResourceDrift) GoString() string

GoString returns the string representation

SetActualProperties

func (s *StackResourceDrift) SetActualProperties(v string) *StackResourceDrift

SetActualProperties sets the ActualProperties field's value.

SetExpectedProperties

func (s *StackResourceDrift) SetExpectedProperties(v string) *StackResourceDrift

SetExpectedProperties sets the ExpectedProperties field's value.

SetLogicalResourceId

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

SetLogicalResourceId sets the LogicalResourceId field's value.

SetPhysicalResourceId

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

SetPhysicalResourceId sets the PhysicalResourceId field's value.

SetPhysicalResourceIdContext

func (s *StackResourceDrift) SetPhysicalResourceIdContext(v []*PhysicalResourceIdContextKeyValuePair) *StackResourceDrift

SetPhysicalResourceIdContext sets the PhysicalResourceIdContext field's value.

SetPropertyDifferences

func (s *StackResourceDrift) SetPropertyDifferences(v []*PropertyDifference) *StackResourceDrift

SetPropertyDifferences sets the PropertyDifferences field's value.

SetResourceType

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

SetResourceType sets the ResourceType field's value.

SetStackId

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

SetStackId sets the StackId field's value.

SetStackResourceDriftStatus

func (s *StackResourceDrift) SetStackResourceDriftStatus(v string) *StackResourceDrift

SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value.

SetTimestamp

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

SetTimestamp sets the Timestamp field's value.

String

func (s StackResourceDrift) String() string

String returns the string representation

On this page: