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.

StackSetOperationResultSummary

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

type StackSetOperationResultSummary struct { Account *string `type:"string"` AccountGateResult *AccountGateResult `type:"structure"` Region *string `type:"string"` Status *string `type:"string" enum:"StackSetOperationResultStatus"` StatusReason *string `type:"string"` }

The structure that contains information about a specified operation's results for a given account in a given region.

Account

Type: *string

The name of the AWS account for this operation result.

AccountGateResult

Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.

For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns FAILED, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.

For more information, see Configuring a target account gate (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html).

Region

Type: *string

The name of the AWS region for this operation result.

Status

Type: *string

The result status of the stack set operation for the given account in the given region.

  • CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

  • FAILED: The operation in the specified account and region failed.

If the stack set operation fails in enough accounts within a region, the

failure tolerance for the stack set operation as a whole might be exceeded.
  • RUNNING: The operation in the specified account and region is currently in progress.

  • PENDING: The operation in the specified account and region has yet to start.

  • SUCCEEDED: The operation in the specified account and region completed successfully.

StatusReason

Type: *string

The reason for the assigned result status.

Method

GoString

func (s StackSetOperationResultSummary) GoString() string

GoString returns the string representation

SetAccount

func (s *StackSetOperationResultSummary) SetAccount(v string) *StackSetOperationResultSummary

SetAccount sets the Account field's value.

SetAccountGateResult

func (s *StackSetOperationResultSummary) SetAccountGateResult(v *AccountGateResult) *StackSetOperationResultSummary

SetAccountGateResult sets the AccountGateResult field's value.

SetRegion

func (s *StackSetOperationResultSummary) SetRegion(v string) *StackSetOperationResultSummary

SetRegion sets the Region field's value.

SetStatus

func (s *StackSetOperationResultSummary) SetStatus(v string) *StackSetOperationResultSummary

SetStatus sets the Status field's value.

SetStatusReason

func (s *StackSetOperationResultSummary) SetStatusReason(v string) *StackSetOperationResultSummary

SetStatusReason sets the StatusReason field's value.

String

func (s StackSetOperationResultSummary) String() string

String returns the string representation

On this page: