Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.cloudformation.model
Class Stack

java.lang.Object
  extended by com.amazonaws.services.cloudformation.model.Stack
All Implemented Interfaces:
Serializable

public class Stack
extends Object
implements Serializable

The Stack data type.

See Also:
Serialized Form

Constructor Summary
Stack()
           
 
Method Summary
 boolean equals(Object obj)
           
 List<String> getCapabilities()
          The capabilities allowed in the stack.
 Date getCreationTime()
          Time at which the stack was created.
 String getDescription()
          User defined description associated with the stack.
 Boolean getDisableRollback()
          Boolean to enable or disable rollback on stack creation failures:
 Date getLastUpdatedTime()
          The time the stack was last updated.
 List<String> getNotificationARNs()
          SNS topic ARNs to which stack related events are published.
 List<Output> getOutputs()
          A list of output structures.
 List<Parameter> getParameters()
          A list of Parameter structures.
 String getStackId()
          Unique identifier of the stack.
 String getStackName()
          The name associated with the stack.
 String getStackStatus()
          Current status of the stack.
 String getStackStatusReason()
          Success/failure message associated with the stack status.
 List<Tag> getTags()
          A list of Tags that specify cost allocation information for the stack.
 Integer getTimeoutInMinutes()
          The amount of time within which stack creation should complete.
 int hashCode()
           
 Boolean isDisableRollback()
          Boolean to enable or disable rollback on stack creation failures:
 void setCapabilities(Collection<String> capabilities)
          The capabilities allowed in the stack.
 void setCreationTime(Date creationTime)
          Time at which the stack was created.
 void setDescription(String description)
          User defined description associated with the stack.
 void setDisableRollback(Boolean disableRollback)
          Boolean to enable or disable rollback on stack creation failures:
 void setLastUpdatedTime(Date lastUpdatedTime)
          The time the stack was last updated.
 void setNotificationARNs(Collection<String> notificationARNs)
          SNS topic ARNs to which stack related events are published.
 void setOutputs(Collection<Output> outputs)
          A list of output structures.
 void setParameters(Collection<Parameter> parameters)
          A list of Parameter structures.
 void setStackId(String stackId)
          Unique identifier of the stack.
 void setStackName(String stackName)
          The name associated with the stack.
 void setStackStatus(StackStatus stackStatus)
          Current status of the stack.
 void setStackStatus(String stackStatus)
          Current status of the stack.
 void setStackStatusReason(String stackStatusReason)
          Success/failure message associated with the stack status.
 void setTags(Collection<Tag> tags)
          A list of Tags that specify cost allocation information for the stack.
 void setTimeoutInMinutes(Integer timeoutInMinutes)
          The amount of time within which stack creation should complete.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 Stack withCapabilities(Collection<String> capabilities)
          The capabilities allowed in the stack.
 Stack withCapabilities(String... capabilities)
          The capabilities allowed in the stack.
 Stack withCreationTime(Date creationTime)
          Time at which the stack was created.
 Stack withDescription(String description)
          User defined description associated with the stack.
 Stack withDisableRollback(Boolean disableRollback)
          Boolean to enable or disable rollback on stack creation failures:
 Stack withLastUpdatedTime(Date lastUpdatedTime)
          The time the stack was last updated.
 Stack withNotificationARNs(Collection<String> notificationARNs)
          SNS topic ARNs to which stack related events are published.
 Stack withNotificationARNs(String... notificationARNs)
          SNS topic ARNs to which stack related events are published.
 Stack withOutputs(Collection<Output> outputs)
          A list of output structures.
 Stack withOutputs(Output... outputs)
          A list of output structures.
 Stack withParameters(Collection<Parameter> parameters)
          A list of Parameter structures.
 Stack withParameters(Parameter... parameters)
          A list of Parameter structures.
 Stack withStackId(String stackId)
          Unique identifier of the stack.
 Stack withStackName(String stackName)
          The name associated with the stack.
 Stack withStackStatus(StackStatus stackStatus)
          Current status of the stack.
 Stack withStackStatus(String stackStatus)
          Current status of the stack.
 Stack withStackStatusReason(String stackStatusReason)
          Success/failure message associated with the stack status.
 Stack withTags(Collection<Tag> tags)
          A list of Tags that specify cost allocation information for the stack.
 Stack withTags(Tag... tags)
          A list of Tags that specify cost allocation information for the stack.
 Stack withTimeoutInMinutes(Integer timeoutInMinutes)
          The amount of time within which stack creation should complete.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Stack

public Stack()
Method Detail

getStackId

public String getStackId()
Unique identifier of the stack.

Returns:
Unique identifier of the stack.

setStackId

public void setStackId(String stackId)
Unique identifier of the stack.

Parameters:
stackId - Unique identifier of the stack.

withStackId

public Stack withStackId(String stackId)
Unique identifier of the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
stackId - Unique identifier of the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

getStackName

public String getStackName()
The name associated with the stack.

Returns:
The name associated with the stack.

setStackName

public void setStackName(String stackName)
The name associated with the stack.

Parameters:
stackName - The name associated with the stack.

withStackName

public Stack withStackName(String stackName)
The name associated with the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
stackName - The name associated with the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()
User defined description associated with the stack.

Returns:
User defined description associated with the stack.

setDescription

public void setDescription(String description)
User defined description associated with the stack.

Parameters:
description - User defined description associated with the stack.

withDescription

public Stack withDescription(String description)
User defined description associated with the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
description - User defined description associated with the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

getParameters

public List<Parameter> getParameters()
A list of Parameter structures.

Returns:
A list of Parameter structures.

setParameters

public void setParameters(Collection<Parameter> parameters)
A list of Parameter structures.

Parameters:
parameters - A list of Parameter structures.

withParameters

public Stack withParameters(Parameter... parameters)
A list of Parameter structures.

Returns a reference to this object so that method calls can be chained together.

Parameters:
parameters - A list of Parameter structures.
Returns:
A reference to this updated object so that method calls can be chained together.

withParameters

public Stack withParameters(Collection<Parameter> parameters)
A list of Parameter structures.

Returns a reference to this object so that method calls can be chained together.

Parameters:
parameters - A list of Parameter structures.
Returns:
A reference to this updated object so that method calls can be chained together.

getCreationTime

public Date getCreationTime()
Time at which the stack was created.

Returns:
Time at which the stack was created.

setCreationTime

public void setCreationTime(Date creationTime)
Time at which the stack was created.

Parameters:
creationTime - Time at which the stack was created.

withCreationTime

public Stack withCreationTime(Date creationTime)
Time at which the stack was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:
creationTime - Time at which the stack was created.
Returns:
A reference to this updated object so that method calls can be chained together.

getLastUpdatedTime

public Date getLastUpdatedTime()
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Returns:
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

setLastUpdatedTime

public void setLastUpdatedTime(Date lastUpdatedTime)
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Parameters:
lastUpdatedTime - The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

withLastUpdatedTime

public Stack withLastUpdatedTime(Date lastUpdatedTime)
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Returns a reference to this object so that method calls can be chained together.

Parameters:
lastUpdatedTime - The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
Returns:
A reference to this updated object so that method calls can be chained together.

getStackStatus

public String getStackStatus()
Current status of the stack.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

Returns:
Current status of the stack.
See Also:
StackStatus

setStackStatus

public void setStackStatus(String stackStatus)
Current status of the stack.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

Parameters:
stackStatus - Current status of the stack.
See Also:
StackStatus

withStackStatus

public Stack withStackStatus(String stackStatus)
Current status of the stack.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

Parameters:
stackStatus - Current status of the stack.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
StackStatus

setStackStatus

public void setStackStatus(StackStatus stackStatus)
Current status of the stack.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

Parameters:
stackStatus - Current status of the stack.
See Also:
StackStatus

withStackStatus

public Stack withStackStatus(StackStatus stackStatus)
Current status of the stack.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE

Parameters:
stackStatus - Current status of the stack.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
StackStatus

getStackStatusReason

public String getStackStatusReason()
Success/failure message associated with the stack status.

Returns:
Success/failure message associated with the stack status.

setStackStatusReason

public void setStackStatusReason(String stackStatusReason)
Success/failure message associated with the stack status.

Parameters:
stackStatusReason - Success/failure message associated with the stack status.

withStackStatusReason

public Stack withStackStatusReason(String stackStatusReason)
Success/failure message associated with the stack status.

Returns a reference to this object so that method calls can be chained together.

Parameters:
stackStatusReason - Success/failure message associated with the stack status.
Returns:
A reference to this updated object so that method calls can be chained together.

isDisableRollback

public Boolean isDisableRollback()
Boolean to enable or disable rollback on stack creation failures:

Returns:
Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback
  • false: enable rollback

setDisableRollback

public void setDisableRollback(Boolean disableRollback)
Boolean to enable or disable rollback on stack creation failures:

Parameters:
disableRollback - Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback
  • false: enable rollback

withDisableRollback

public Stack withDisableRollback(Boolean disableRollback)
Boolean to enable or disable rollback on stack creation failures:

Returns a reference to this object so that method calls can be chained together.

Parameters:
disableRollback - Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback
  • false: enable rollback
Returns:
A reference to this updated object so that method calls can be chained together.

getDisableRollback

public Boolean getDisableRollback()
Boolean to enable or disable rollback on stack creation failures:

Returns:
Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback
  • false: enable rollback

getNotificationARNs

public List<String> getNotificationARNs()
SNS topic ARNs to which stack related events are published.

Constraints:
Length: 0 - 5

Returns:
SNS topic ARNs to which stack related events are published.

setNotificationARNs

public void setNotificationARNs(Collection<String> notificationARNs)
SNS topic ARNs to which stack related events are published.

Constraints:
Length: 0 - 5

Parameters:
notificationARNs - SNS topic ARNs to which stack related events are published.

withNotificationARNs

public Stack withNotificationARNs(String... notificationARNs)
SNS topic ARNs to which stack related events are published.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 5

Parameters:
notificationARNs - SNS topic ARNs to which stack related events are published.
Returns:
A reference to this updated object so that method calls can be chained together.

withNotificationARNs

public Stack withNotificationARNs(Collection<String> notificationARNs)
SNS topic ARNs to which stack related events are published.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 5

Parameters:
notificationARNs - SNS topic ARNs to which stack related events are published.
Returns:
A reference to this updated object so that method calls can be chained together.

getTimeoutInMinutes

public Integer getTimeoutInMinutes()
The amount of time within which stack creation should complete.

Constraints:
Range: 1 -

Returns:
The amount of time within which stack creation should complete.

setTimeoutInMinutes

public void setTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time within which stack creation should complete.

Constraints:
Range: 1 -

Parameters:
timeoutInMinutes - The amount of time within which stack creation should complete.

withTimeoutInMinutes

public Stack withTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time within which stack creation should complete.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:
timeoutInMinutes - The amount of time within which stack creation should complete.
Returns:
A reference to this updated object so that method calls can be chained together.

getCapabilities

public List<String> getCapabilities()
The capabilities allowed in the stack.

Returns:
The capabilities allowed in the stack.

setCapabilities

public void setCapabilities(Collection<String> capabilities)
The capabilities allowed in the stack.

Parameters:
capabilities - The capabilities allowed in the stack.

withCapabilities

public Stack withCapabilities(String... capabilities)
The capabilities allowed in the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
capabilities - The capabilities allowed in the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

withCapabilities

public Stack withCapabilities(Collection<String> capabilities)
The capabilities allowed in the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
capabilities - The capabilities allowed in the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

getOutputs

public List<Output> getOutputs()
A list of output structures.

Returns:
A list of output structures.

setOutputs

public void setOutputs(Collection<Output> outputs)
A list of output structures.

Parameters:
outputs - A list of output structures.

withOutputs

public Stack withOutputs(Output... outputs)
A list of output structures.

Returns a reference to this object so that method calls can be chained together.

Parameters:
outputs - A list of output structures.
Returns:
A reference to this updated object so that method calls can be chained together.

withOutputs

public Stack withOutputs(Collection<Output> outputs)
A list of output structures.

Returns a reference to this object so that method calls can be chained together.

Parameters:
outputs - A list of output structures.
Returns:
A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()
A list of Tags that specify cost allocation information for the stack.

Returns:
A list of Tags that specify cost allocation information for the stack.

setTags

public void setTags(Collection<Tag> tags)
A list of Tags that specify cost allocation information for the stack.

Parameters:
tags - A list of Tags that specify cost allocation information for the stack.

withTags

public Stack withTags(Tag... tags)
A list of Tags that specify cost allocation information for the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tags - A list of Tags that specify cost allocation information for the stack.
Returns:
A reference to this updated object so that method calls can be chained together.

withTags

public Stack withTags(Collection<Tag> tags)
A list of Tags that specify cost allocation information for the stack.

Returns a reference to this object so that method calls can be chained together.

Parameters:
tags - A list of Tags that specify cost allocation information for the stack.
Returns:
A reference to this updated 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()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.