@Generated(value="software.amazon.awssdk:codegen") public final class DescribeStackResourcesRequest extends CloudFormationRequest implements ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>
The input for DescribeStackResources action.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeStackResourcesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeStackResourcesRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
logicalResourceId()
The logical name of the resource as specified in the template.
|
String |
physicalResourceId()
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS
CloudFormation.
|
static Class<? extends DescribeStackResourcesRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
|
DescribeStackResourcesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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
.
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 String logicalResourceId()
The logical name of the resource as specified in the template.
Default: There is no default value.
Default: There is no default value.
public 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.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>
toBuilder
in class CloudFormationRequest
public static DescribeStackResourcesRequest.Builder builder()
public static Class<? extends DescribeStackResourcesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.