Package software.amazon.awssdk.services.ec2.model

Interface DescribeAvailabilityZonesRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeAvailabilityZonesRequest

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

Method Summary

Modifier and Type	Method	Description
DescribeAvailabilityZonesRequest.Builder	allAvailabilityZones(Boolean allAvailabilityZones)	Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
DescribeAvailabilityZonesRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeAvailabilityZonesRequest.Builder	filters(Collection<Filter> filters)	The filters.
DescribeAvailabilityZonesRequest.Builder	filters(Consumer<Filter.Builder>... filters)	The filters.
DescribeAvailabilityZonesRequest.Builder	filters(Filter... filters)	The filters.
DescribeAvailabilityZonesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeAvailabilityZonesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeAvailabilityZonesRequest.Builder	zoneIds(String... zoneIds)	The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest.Builder	zoneIds(Collection<String> zoneIds)	The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest.Builder	zoneNames(String... zoneNames)	The names of the Availability Zones, Local Zones, and Wavelength Zones.
DescribeAvailabilityZonesRequest.Builder	zoneNames(Collection<String> zoneNames)	The names of the Availability Zones, Local Zones, and Wavelength Zones.

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

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

filters

DescribeAvailabilityZonesRequest.Builder filters(Collection<Filter> filters)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Parameters:

filters - The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Returns:

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

filters

DescribeAvailabilityZonesRequest.Builder filters(Filter... filters)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Parameters:

filters - The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

Returns:

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

filters

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

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).

• message - The Zone message.

• opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).

• parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1).

• state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone ( available).

• zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

• zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

Parameters:

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

Returns:

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

See Also:

• filters(java.util.Collection<Filter>)

zoneNames

DescribeAvailabilityZonesRequest.Builder zoneNames(Collection<String> zoneNames)

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Parameters:

zoneNames - The names of the Availability Zones, Local Zones, and Wavelength Zones.

Returns:

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

zoneNames

DescribeAvailabilityZonesRequest.Builder zoneNames(String... zoneNames)

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Parameters:

zoneNames - The names of the Availability Zones, Local Zones, and Wavelength Zones.

Returns:

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

zoneIds

DescribeAvailabilityZonesRequest.Builder zoneIds(Collection<String> zoneIds)

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Parameters:

zoneIds - The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Returns:

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

zoneIds

DescribeAvailabilityZonesRequest.Builder zoneIds(String... zoneIds)

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Parameters:

zoneIds - The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Returns:

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

allAvailabilityZones

DescribeAvailabilityZonesRequest.Builder allAvailabilityZones(Boolean allAvailabilityZones)

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Parameters:

allAvailabilityZones - Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

Returns:

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

dryRun

DescribeAvailabilityZonesRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

overrideConfiguration

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

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