/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeAvailabilityZonesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest
* The filters.
*
*
*
*
*
*
*
*
*
*
*
* The names of the Availability Zones, Local Zones, and Wavelength Zones.
*
* The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
*
* 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.
*
* The filters.
*
*
*
*
*
*
*
*
*
*
*
*
*/
private com.amazonaws.internal.SdkInternalListgroup-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-bos-wlz-1
).
* message
- The Zone message.
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
* plane operations, such as API calls.
* parent-zoneName
- 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
).
*
*
*
* @return 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-bos-wlz-1
).
* message
- The Zone message.
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
* plane operations, such as API calls.
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone
* control plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
* plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone
* control plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
* plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *
* * @param 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone
* control plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control
* plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* 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-bos-wlz-1
).
*
* message
- The Zone message.
*
* opt-in-status
- The opt-in status (opted-in
| not-opted-in
|
* opt-in-not-required
).
*
* parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone
* control plane operations, such as API calls.
*
* parent-zoneName
- 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
).
*
* The names of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @return The names of the Availability Zones, Local Zones, and Wavelength Zones. */ public java.util.List* The names of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @param zoneNames * The names of the Availability Zones, Local Zones, and Wavelength Zones. */ public void setZoneNames(java.util.Collection* The names of the Availability Zones, Local Zones, and Wavelength Zones. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setZoneNames(java.util.Collection)} or {@link #withZoneNames(java.util.Collection)} if you want to * override the existing values. *
* * @param zoneNames * The names of the Availability Zones, Local Zones, and Wavelength Zones. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeAvailabilityZonesRequest withZoneNames(String... zoneNames) { if (this.zoneNames == null) { setZoneNames(new com.amazonaws.internal.SdkInternalList* The names of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @param zoneNames * The names of the Availability Zones, Local Zones, and Wavelength Zones. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeAvailabilityZonesRequest withZoneNames(java.util.Collection* The IDs of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @return The IDs of the Availability Zones, Local Zones, and Wavelength Zones. */ public java.util.List* The IDs of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @param zoneIds * The IDs of the Availability Zones, Local Zones, and Wavelength Zones. */ public void setZoneIds(java.util.Collection* The IDs of the Availability Zones, Local Zones, and Wavelength Zones. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setZoneIds(java.util.Collection)} or {@link #withZoneIds(java.util.Collection)} if you want to override * the existing values. *
* * @param zoneIds * The IDs of the Availability Zones, Local Zones, and Wavelength Zones. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeAvailabilityZonesRequest withZoneIds(String... zoneIds) { if (this.zoneIds == null) { setZoneIds(new com.amazonaws.internal.SdkInternalList* The IDs of the Availability Zones, Local Zones, and Wavelength Zones. *
* * @param zoneIds * The IDs of the Availability Zones, Local Zones, and Wavelength Zones. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeAvailabilityZonesRequest withZoneIds(java.util.Collection* 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. *
* * @param 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. */ public void setAllAvailabilityZones(Boolean allAvailabilityZones) { this.allAvailabilityZones = 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. *
* * @return 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. */ public Boolean getAllAvailabilityZones() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeAvailabilityZonesRequest withAllAvailabilityZones(Boolean allAvailabilityZones) { setAllAvailabilityZones(allAvailabilityZones); return this; } /** *
* 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. *
* * @return 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.
*/
public Boolean isAllAvailabilityZones() {
return this.allAvailabilityZones;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request