software.amazon.awssdk.services.cloudformation.model

Interface DescribeStackResourcesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CloudFormationRequest.Builder, CopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>, SdkBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>, SdkRequest.Builder

Enclosing class:

DescribeStackResourcesRequest

public static interface DescribeStackResourcesRequest.Builder
extends CloudFormationRequest.Builder, CopyableBuilder<DescribeStackResourcesRequest.Builder,DescribeStackResourcesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeStackResourcesRequest.Builder	logicalResourceId(String logicalResourceId) The logical name of the resource as specified in the template.
DescribeStackResourcesRequest.Builder	physicalResourceId(String physicalResourceId) The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
DescribeStackResourcesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeStackResourcesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
DescribeStackResourcesRequest.Builder	stackName(String stackName) The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

stackName

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

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

requestOverrideConfig

DescribeStackResourcesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeStackResourcesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.