public class DescribeStackResourcesRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
The input for DescribeStackResources action.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
logicalResourceId
The logical name of the resource as specified in the template.
|
private java.lang.String |
physicalResourceId
The name or unique identifier that corresponds to a physical instance ID
of a resource supported by AWS CloudFormation.
|
private java.lang.String |
stackName
The name or the unique stack ID that is associated with the stack, which
are not always interchangeable:
|
NOOP
Constructor and Description |
---|
DescribeStackResourcesRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeStackResourcesRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getLogicalResourceId()
The logical name of the resource as specified in the template.
|
java.lang.String |
getPhysicalResourceId()
The name or unique identifier that corresponds to a physical instance ID
of a resource supported by AWS CloudFormation.
|
java.lang.String |
getStackName()
The name or the unique stack ID that is associated with the stack, which
are not always interchangeable:
|
int |
hashCode() |
void |
setLogicalResourceId(java.lang.String logicalResourceId)
The logical name of the resource as specified in the template.
|
void |
setPhysicalResourceId(java.lang.String physicalResourceId)
The name or unique identifier that corresponds to a physical instance ID
of a resource supported by AWS CloudFormation.
|
void |
setStackName(java.lang.String stackName)
The name or the unique stack ID that is associated with the stack, which
are not always interchangeable:
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeStackResourcesRequest |
withLogicalResourceId(java.lang.String logicalResourceId)
The logical name of the resource as specified in the template.
|
DescribeStackResourcesRequest |
withPhysicalResourceId(java.lang.String physicalResourceId)
The name or unique identifier that corresponds to a physical instance ID
of a resource supported by AWS CloudFormation.
|
DescribeStackResourcesRequest |
withStackName(java.lang.String stackName)
The name or the unique stack ID that is associated with the stack, which
are not always interchangeable:
|
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
private java.lang.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
.
private java.lang.String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
private java.lang.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.
public void setStackName(java.lang.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
.
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
.
public java.lang.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
.
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
.
public DescribeStackResourcesRequest withStackName(java.lang.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
.
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
.
public void setLogicalResourceId(java.lang.String logicalResourceId)
The logical name of the resource as specified in the template.
Default: There is no default value.
logicalResourceId
- The logical name of the resource as specified in the template.
Default: There is no default value.
public java.lang.String getLogicalResourceId()
The logical name of the resource as specified in the template.
Default: There is no default value.
Default: There is no default value.
public DescribeStackResourcesRequest withLogicalResourceId(java.lang.String logicalResourceId)
The logical name of the resource as specified in the template.
Default: There is no default value.
logicalResourceId
- The logical name of the resource as specified in the template.
Default: There is no default value.
public void setPhysicalResourceId(java.lang.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.
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.
public java.lang.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.
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.
public DescribeStackResourcesRequest withPhysicalResourceId(java.lang.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.
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeStackResourcesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()