com.amazonaws.services.cloudformation.model

Class DescribeStackResourcesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The input for DescribeStackResources action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeStackResourcesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeStackResourcesRequest	clone()
boolean	equals(Object obj)
String	getLogicalResourceId() The logical name of the resource as 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	getStackName() The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
int	hashCode()
void	setLogicalResourceId(String logicalResourceId) The logical name of the resource as 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	setStackName(String stackName) The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeStackResourcesRequest	withLogicalResourceId(String logicalResourceId) The logical name of the resource as specified in the template.
DescribeStackResourcesRequest	withPhysicalResourceId(String physicalResourceId) The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
DescribeStackResourcesRequest	withStackName(String stackName) The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeStackResourcesRequest

public DescribeStackResourcesRequest()

Method Detail

setStackName

public void setStackName(String stackName)

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Parameters:

stackName - The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

getStackName

public String getStackName()

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Returns:

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

withStackName

public DescribeStackResourcesRequest withStackName(String stackName)

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Parameters:

stackName - The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.

• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Returns:

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

setLogicalResourceId

public void setLogicalResourceId(String logicalResourceId)

The logical name of the resource as specified in the template.

Default: There is no default value.

Parameters:

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

Default: There is no default value.

getLogicalResourceId

public String getLogicalResourceId()

The logical name of the resource as specified in the template.

Default: There is no default value.

Returns:

The logical name of the resource as specified in the template.

Default: There is no default value.

withLogicalResourceId

public DescribeStackResourcesRequest withLogicalResourceId(String logicalResourceId)

The logical name of the resource as specified in the template.

Default: There is no default value.

Parameters:

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

Default: There is no default value.

Returns:

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

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.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Parameters:

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

getPhysicalResourceId

public String getPhysicalResourceId()

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Returns:

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

withPhysicalResourceId

public DescribeStackResourcesRequest withPhysicalResourceId(String physicalResourceId)

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Parameters:

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

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

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

Overrides:

clone in class AmazonWebServiceRequest