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.

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>
      Specified by:
      toBuilder in class CloudFormationRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.