com.amazonaws.services.cloudformation.model

Class ResourceDetail

java.lang.Object

com.amazonaws.services.cloudformation.model.ResourceDetail

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResourceDetail
extends Object
implements Serializable, Cloneable

Details about a resource in a generated template

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceDetail()

Method Summary

Modifier and Type	Method and Description
ResourceDetail	addResourceIdentifierEntry(String key, String value) Add a single ResourceIdentifier entry
ResourceDetail	clearResourceIdentifierEntries() Removes all the entries added into ResourceIdentifier.
ResourceDetail	clone()
boolean	equals(Object obj)
String	getLogicalResourceId() The logical id for this resource in the final generated template.
Map<String,String>	getResourceIdentifier() A list of up to 256 key-value pairs that identifies the resource in the generated template.
String	getResourceStatus() Status of the processing of a resource in a generated template.
String	getResourceStatusReason() The reason for the resource detail, providing more information if a failure happened.
String	getResourceType() The type of the resource, such as AWS::DynamoDB::Table.
List<WarningDetail>	getWarnings() The warnings generated for this resource.
int	hashCode()
void	setLogicalResourceId(String logicalResourceId) The logical id for this resource in the final generated template.
void	setResourceIdentifier(Map<String,String> resourceIdentifier) A list of up to 256 key-value pairs that identifies the resource in the generated template.
void	setResourceStatus(String resourceStatus) Status of the processing of a resource in a generated template.
void	setResourceStatusReason(String resourceStatusReason) The reason for the resource detail, providing more information if a failure happened.
void	setResourceType(String resourceType) The type of the resource, such as AWS::DynamoDB::Table.
void	setWarnings(Collection<WarningDetail> warnings) The warnings generated for this resource.
String	toString() Returns a string representation of this object.
ResourceDetail	withLogicalResourceId(String logicalResourceId) The logical id for this resource in the final generated template.
ResourceDetail	withResourceIdentifier(Map<String,String> resourceIdentifier) A list of up to 256 key-value pairs that identifies the resource in the generated template.
ResourceDetail	withResourceStatus(GeneratedTemplateResourceStatus resourceStatus) Status of the processing of a resource in a generated template.
ResourceDetail	withResourceStatus(String resourceStatus) Status of the processing of a resource in a generated template.
ResourceDetail	withResourceStatusReason(String resourceStatusReason) The reason for the resource detail, providing more information if a failure happened.
ResourceDetail	withResourceType(String resourceType) The type of the resource, such as AWS::DynamoDB::Table.
ResourceDetail	withWarnings(Collection<WarningDetail> warnings) The warnings generated for this resource.
ResourceDetail	withWarnings(WarningDetail... warnings) The warnings generated for this resource.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceDetail

public ResourceDetail()

Method Detail

setResourceType

public void setResourceType(String resourceType)

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

Parameters:

resourceType - The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

getResourceType

public String getResourceType()

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

Returns:

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

withResourceType

public ResourceDetail withResourceType(String resourceType)

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

Parameters:

resourceType - The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

Returns:

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

setLogicalResourceId

public void setLogicalResourceId(String logicalResourceId)

The logical id for this resource in the final generated template.

Parameters:

logicalResourceId - The logical id for this resource in the final generated template.

getLogicalResourceId

public String getLogicalResourceId()

The logical id for this resource in the final generated template.

Returns:

The logical id for this resource in the final generated template.

withLogicalResourceId

public ResourceDetail withLogicalResourceId(String logicalResourceId)

The logical id for this resource in the final generated template.

Parameters:

logicalResourceId - The logical id for this resource in the final generated template.

Returns:

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

getResourceIdentifier

public Map<String,String> getResourceIdentifier()

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

Returns:

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

setResourceIdentifier

public void setResourceIdentifier(Map<String,String> resourceIdentifier)

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

Parameters:

resourceIdentifier - A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

withResourceIdentifier

public ResourceDetail withResourceIdentifier(Map<String,String> resourceIdentifier)

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

Parameters:

resourceIdentifier - A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

Returns:

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

addResourceIdentifierEntry

public ResourceDetail addResourceIdentifierEntry(String key,
                                                 String value)

Add a single ResourceIdentifier entry

See Also:

withResourceIdentifier(java.util.Map<java.lang.String, java.lang.String>)

clearResourceIdentifierEntries

public ResourceDetail clearResourceIdentifierEntries()

Removes all the entries added into ResourceIdentifier.

Returns:

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

setResourceStatus

public void setResourceStatus(String resourceStatus)

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Parameters:

resourceStatus - Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

See Also:

GeneratedTemplateResourceStatus

getResourceStatus

public String getResourceStatus()

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Returns:

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

See Also:

GeneratedTemplateResourceStatus

withResourceStatus

public ResourceDetail withResourceStatus(String resourceStatus)

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Parameters:

resourceStatus - Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Returns:

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

See Also:

GeneratedTemplateResourceStatus

withResourceStatus

public ResourceDetail withResourceStatus(GeneratedTemplateResourceStatus resourceStatus)

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Parameters:

resourceStatus - Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

Returns:

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

See Also:

GeneratedTemplateResourceStatus

setResourceStatusReason

public void setResourceStatusReason(String resourceStatusReason)

The reason for the resource detail, providing more information if a failure happened.

Parameters:

resourceStatusReason - The reason for the resource detail, providing more information if a failure happened.

getResourceStatusReason

public String getResourceStatusReason()

The reason for the resource detail, providing more information if a failure happened.

Returns:

The reason for the resource detail, providing more information if a failure happened.

withResourceStatusReason

public ResourceDetail withResourceStatusReason(String resourceStatusReason)

The reason for the resource detail, providing more information if a failure happened.

Parameters:

resourceStatusReason - The reason for the resource detail, providing more information if a failure happened.

Returns:

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

getWarnings

public List<WarningDetail> getWarnings()

The warnings generated for this resource.

Returns:

The warnings generated for this resource.

setWarnings

public void setWarnings(Collection<WarningDetail> warnings)

The warnings generated for this resource.

Parameters:

warnings - The warnings generated for this resource.

withWarnings

public ResourceDetail withWarnings(WarningDetail... warnings)

The warnings generated for this resource.

NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.

Parameters:

warnings - The warnings generated for this resource.

Returns:

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

withWarnings

public ResourceDetail withWarnings(Collection<WarningDetail> warnings)

The warnings generated for this resource.

Parameters:

warnings - The warnings generated for this resource.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 ResourceDetail clone()

Overrides:

clone in class Object