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

Interface DescribeStackResourcesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>, SdkBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeStackResourcesRequest
public static interface DescribeStackResourcesRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>

  • Method Details

    • stackName

      DescribeStackResourcesRequest.Builder stackName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • logicalResourceId

      DescribeStackResourcesRequest.Builder logicalResourceId(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.

    • physicalResourceId

      DescribeStackResourcesRequest.Builder physicalResourceId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeStackResourcesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeStackResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.