You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Types::AccountGateResult

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Structure that contains the results of the account gate function AWS CloudFormation StackSets invokes, if present, before proceeding with stack set operations in an account.

Account gating enables you to specify a Lamdba function for an account that encapsulates any requirements that must be met before AWS CloudFormation StackSets proceeds with stack set operations in that account. CloudFormation invokes the function each time stack set operations are initiated for that account, and only proceeds if the function returns a success code.

Instance Attribute Summary collapse

Instance Attribute Details

#statusString

The status of the account gate function.

  • SUCCEEDED: The account gate function has determined that the account passes any requirements for stack set operations to occur. AWS CloudFormation proceeds with stack operations in the account.

  • FAILED: The account gate function has determined that the account does not meet the requirements for stack set operations to occur. AWS CloudFormation cancels the stack set operations in that account, and the stack set operation status is set to FAILED.

  • SKIPPED: An account gate function has not been specified for the account, or the AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with stack set operations in the account.

Returns:

  • (String)


47
48
49
50
51
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 47

class AccountGateResult < Struct.new(
  :status,
  :status_reason)
  include Aws::Structure
end

#status_reasonString

The reason for the account gate status assigned to this account.

Returns:

  • (String)


47
48
49
50
51
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 47

class AccountGateResult < Struct.new(
  :status,
  :status_reason)
  include Aws::Structure
end