AccountGateResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.AccountGateResult

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccountGateResult
extends Object
implements Serializable, Cloneable
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccountGateResult()

Constructors
Constructor and Description
`AccountGateResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountGateResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getStatus()` The status of the account gate function.
`String`	`getStatusReason()` The reason for the account gate status assigned to this account.
`int`	`hashCode()`
`void`	`setStatus(AccountGateStatus status)` The status of the account gate function.
`void`	`setStatus(String status)` The status of the account gate function.
`void`	`setStatusReason(String statusReason)` The reason for the account gate status assigned to this account.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AccountGateResult`	`withStatus(AccountGateStatus status)` The status of the account gate function.
`AccountGateResult`	`withStatus(String status)` The status of the account gate function.
`AccountGateResult`	`withStatusReason(String statusReason)` The reason for the account gate status assigned to this account.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AccountGateResult
```
public AccountGateResult()
```
- Method Detail
  - setStatus
```
public void setStatus(String status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    AccountGateStatus
  - getStatus
```
public String getStatus()
```
    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:
    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.
    See Also:
    
    AccountGateStatus
  - withStatus
```
public AccountGateResult withStatus(String status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccountGateStatus
  - setStatus
```
public void setStatus(AccountGateStatus status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    AccountGateStatus
  - withStatus
```
public AccountGateResult withStatus(AccountGateStatus status)
```
    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.
    Parameters:
    status - 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccountGateStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The reason for the account gate status assigned to this account.
    
    Parameters:
    
    statusReason - The reason for the account gate status assigned to this account.
  - getStatusReason
```
public String getStatusReason()
```
    The reason for the account gate status assigned to this account.
    
    Returns:
    
    The reason for the account gate status assigned to this account.
  - withStatusReason
```
public AccountGateResult withStatusReason(String statusReason)
```
    The reason for the account gate status assigned to this account.
    
    Parameters:
    
    statusReason - The reason for the account gate status assigned to this account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AccountGateResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class AccountGateResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccountGateResult

Method Detail

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

toString

equals

hashCode

clone