Package software.amazon.awssdk.services.cloudformation.model

Class DescribeStackResourcesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.DescribeStackResourcesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeStackResourcesRequest
extends CloudFormationRequest
implements ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>

The input for DescribeStackResources action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStackResourcesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStackResourcesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 CloudFormation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStackResourcesRequest.Builder>	serializableBuilderClass()
String	stackName()	The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
DescribeStackResourcesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackName

public final String stackName()

The name or the unique stack ID that is associated with the stack, which aren't 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 don't specify StackName, you must specify PhysicalResourceId.

Returns:

The name or the unique stack ID that is associated with the stack, which aren't 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 don't specify StackName, you must specify PhysicalResourceId.

logicalResourceId

public final String logicalResourceId()

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.

physicalResourceId

public final String physicalResourceId()

The name or unique identifier that corresponds to a physical instance ID of a resource supported by 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 don't 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 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 don't specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

toBuilder

public DescribeStackResourcesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static DescribeStackResourcesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStackResourcesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo