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:
  • Constructor Details

    • DescribeStackResourcesRequest

      public DescribeStackResourcesRequest()
  • Method Details

    • 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 specify PhysicalResourceId.

      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 specify PhysicalResourceId.

    • 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 specify PhysicalResourceId.

      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 specify PhysicalResourceId.

    • 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 specify PhysicalResourceId.

      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 specify PhysicalResourceId.

      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 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.

      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 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.

    • 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 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.

      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 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.

    • 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 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.

      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 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.

      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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 class AmazonWebServiceRequest
      See Also: