software.amazon.awssdk.services.ec2.model

Interface DescribePlacementGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>, Ec2Request.Builder, SdkBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribePlacementGroupsRequest

public static interface DescribePlacementGroupsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribePlacementGroupsRequest.Builder,DescribePlacementGroupsRequest>

Method Summary

Modifier and Type	Method and Description
DescribePlacementGroupsRequest.Builder	filters(Collection<Filter> filters) The filters.
DescribePlacementGroupsRequest.Builder	filters(Consumer<Filter.Builder>... filters) The filters.
DescribePlacementGroupsRequest.Builder	filters(Filter... filters) The filters.
DescribePlacementGroupsRequest.Builder	groupIds(Collection<String> groupIds) The IDs of the placement groups.
DescribePlacementGroupsRequest.Builder	groupIds(String... groupIds) The IDs of the placement groups.
DescribePlacementGroupsRequest.Builder	groupNames(Collection<String> groupNames) The names of the placement groups.
DescribePlacementGroupsRequest.Builder	groupNames(String... groupNames) The names of the placement groups.
DescribePlacementGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribePlacementGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

filters

DescribePlacementGroupsRequest.Builder filters(Collection<Filter> filters)

The filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Parameters:

filters - The filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribePlacementGroupsRequest.Builder filters(Filter... filters)

The filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Parameters:

filters - The filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribePlacementGroupsRequest.Builder filters(Consumer<Filter.Builder>... filters)

The filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster | spread | partition).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

groupNames

DescribePlacementGroupsRequest.Builder groupNames(Collection<String> groupNames)

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Parameters:

groupNames - The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupNames

DescribePlacementGroupsRequest.Builder groupNames(String... groupNames)

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Parameters:

groupNames - The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupIds

DescribePlacementGroupsRequest.Builder groupIds(Collection<String> groupIds)

The IDs of the placement groups.

Parameters:

groupIds - The IDs of the placement groups.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupIds

DescribePlacementGroupsRequest.Builder groupIds(String... groupIds)

The IDs of the placement groups.

Parameters:

groupIds - The IDs of the placement groups.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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