Class DescribeStackResourcesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeStackResourcesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for DescribeStackResources action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeStackResourcesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeStackResourcesRequest
clone()
Creates a shallow clone of this request.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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 specifyPhysicalResourceId
.- 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 specifyPhysicalResourceId
.-
-
-
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 specifyPhysicalResourceId
.- 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 specifyPhysicalResourceId
. -
-
-
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 specifyPhysicalResourceId
.- 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 specifyPhysicalResourceId
.-
- 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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
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 specifyStackName
.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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeStackResourcesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-