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 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.

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 and region for the stack set operation.
`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 and region for the stack set operation.
`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 and region for the stack set operation.

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 and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    - FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    - SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
      
      An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    Parameters:
    status - The status of the account gate function.
    
    SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    
    FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    
    SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
    
    An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    See Also:
    
    AccountGateStatus
  - getStatus
```
public String getStatus()
```
    The status of the account gate function.
    - SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    - FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    - SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
      
      An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    Returns:
    The status of the account gate function.
    
    SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    
    FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    
    SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
    
    An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    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 and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    - FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    - SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
      
      An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    Parameters:
    status - The status of the account gate function.
    
    SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    
    FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    
    SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
    
    An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    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 and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    - FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    - SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
      
      An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    Parameters:
    status - The status of the account gate function.
    
    SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    
    FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    
    SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
    
    An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    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 and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    - FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    - SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
      
      An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
      
      Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    Parameters:
    status - The status of the account gate function.
    
    SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.
    
    FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
    
    SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:
    
    An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
    
    Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
    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 and region for the stack set operation.
    
    Parameters:
    
    statusReason - The reason for the account gate status assigned to this account and region for the stack set operation.
  - getStatusReason
```
public String getStatusReason()
```
    The reason for the account gate status assigned to this account and region for the stack set operation.
    
    Returns:
    
    The reason for the account gate status assigned to this account and region for the stack set operation.
  - withStatusReason
```
public AccountGateResult withStatusReason(String statusReason)
```
    The reason for the account gate status assigned to this account and region for the stack set operation.
    
    Parameters:
    
    statusReason - The reason for the account gate status assigned to this account and region for the stack set operation.
    
    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