com.amazonaws.services.cloudformation.model

Class StackResource

java.lang.Object

com.amazonaws.services.cloudformation.model.StackResource

All Implemented Interfaces:

Serializable, Cloneable

public class StackResource
extends Object
implements Serializable, Cloneable

The StackResource data type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StackResource()

Method Summary

Methods

Modifier and Type	Method and Description
StackResource	clone()
boolean	equals(Object obj)
String	getDescription() User defined description associated with the resource.
String	getLogicalResourceId() The logical name of the resource specified in the template.
String	getPhysicalResourceId() The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String	getResourceStatus() Current status of the resource.
String	getResourceStatusReason() Success/failure message associated with the resource.
String	getResourceType() Type of resource.
String	getStackId() Unique identifier of the stack.
String	getStackName() The name associated with the stack.
Date	getTimestamp() Time the status was updated.
int	hashCode()
void	setDescription(String description) User defined description associated with the resource.
void	setLogicalResourceId(String logicalResourceId) The logical name of the resource specified in the template.
void	setPhysicalResourceId(String physicalResourceId) The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
void	setResourceStatus(ResourceStatus resourceStatus) Current status of the resource.
void	setResourceStatus(String resourceStatus) Current status of the resource.
void	setResourceStatusReason(String resourceStatusReason) Success/failure message associated with the resource.
void	setResourceType(String resourceType) Type of resource.
void	setStackId(String stackId) Unique identifier of the stack.
void	setStackName(String stackName) The name associated with the stack.
void	setTimestamp(Date timestamp) Time the status was updated.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StackResource	withDescription(String description) User defined description associated with the resource.
StackResource	withLogicalResourceId(String logicalResourceId) The logical name of the resource specified in the template.
StackResource	withPhysicalResourceId(String physicalResourceId) The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
StackResource	withResourceStatus(ResourceStatus resourceStatus) Current status of the resource.
StackResource	withResourceStatus(String resourceStatus) Current status of the resource.
StackResource	withResourceStatusReason(String resourceStatusReason) Success/failure message associated with the resource.
StackResource	withResourceType(String resourceType) Type of resource.
StackResource	withStackId(String stackId) Unique identifier of the stack.
StackResource	withStackName(String stackName) The name associated with the stack.
StackResource	withTimestamp(Date timestamp) Time the status was updated.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StackResource

public StackResource()

Method Detail

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

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

getLogicalResourceId

public String getLogicalResourceId()

The logical name of the resource specified in the template.

Returns:

The logical name of the resource specified in the template.

setLogicalResourceId

public void setLogicalResourceId(String logicalResourceId)

The logical name of the resource specified in the template.

Parameters:

logicalResourceId - The logical name of the resource specified in the template.

withLogicalResourceId

public StackResource withLogicalResourceId(String logicalResourceId)

The logical name of the resource specified in the template.

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

Parameters:

logicalResourceId - The logical name of the resource specified in the template.

Returns:

A reference to this updated object so that method calls can be chained together.

getPhysicalResourceId

public String getPhysicalResourceId()

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

Returns:

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

setPhysicalResourceId

public void setPhysicalResourceId(String physicalResourceId)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

Parameters:

physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

withPhysicalResourceId

public StackResource withPhysicalResourceId(String physicalResourceId)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

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

Parameters:

physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

Returns:

A reference to this updated object so that method calls can be chained together.

getResourceType

public String getResourceType()

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Returns:

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

setResourceType

public void setResourceType(String resourceType)

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Parameters:

resourceType - Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

withResourceType

public StackResource withResourceType(String resourceType)

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

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

Parameters:

resourceType - Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Returns:

A reference to this updated object so that method calls can be chained together.

getTimestamp

public Date getTimestamp()

Time the status was updated.

Returns:

Time the status was updated.

setTimestamp

public void setTimestamp(Date timestamp)

Time the status was updated.

Parameters:

timestamp - Time the status was updated.

withTimestamp

public StackResource withTimestamp(Date timestamp)

Time the status was updated.

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

Parameters:

timestamp - Time the status was updated.

Returns:

A reference to this updated object so that method calls can be chained together.

getResourceStatus

public String getResourceStatus()

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

Returns:

Current status of the resource.

See Also:

ResourceStatus

setResourceStatus

public void setResourceStatus(String resourceStatus)

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

Parameters:

resourceStatus - Current status of the resource.

See Also:

ResourceStatus

withResourceStatus

public StackResource withResourceStatus(String resourceStatus)

Current status of the resource.

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

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

Parameters:

resourceStatus - Current status of the resource.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ResourceStatus

setResourceStatus

public void setResourceStatus(ResourceStatus resourceStatus)

Current status of the resource.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

Parameters:

resourceStatus - Current status of the resource.

See Also:

ResourceStatus

withResourceStatus

public StackResource withResourceStatus(ResourceStatus resourceStatus)

Current status of the resource.

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

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE

Parameters:

resourceStatus - Current status of the resource.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ResourceStatus

getResourceStatusReason

public String getResourceStatusReason()

Success/failure message associated with the resource.

Returns:

Success/failure message associated with the resource.

setResourceStatusReason

public void setResourceStatusReason(String resourceStatusReason)

Success/failure message associated with the resource.

Parameters:

resourceStatusReason - Success/failure message associated with the resource.

withResourceStatusReason

public StackResource withResourceStatusReason(String resourceStatusReason)

Success/failure message associated with the resource.

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

Parameters:

resourceStatusReason - Success/failure message associated with the resource.

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

Returns:

User defined description associated with the resource.

setDescription

public void setDescription(String description)

User defined description associated with the resource.

Parameters:

description - User defined description associated with the resource.

withDescription

public StackResource withDescription(String description)

User defined description associated with the resource.

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

Parameters:

description - User defined description associated with the resource.

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

clone

public StackResource clone()

Overrides:

clone in class Object