/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** */ class AWS_EC2_API DescribeSubnetsRequest : public EC2Request { public: DescribeSubnetsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeSubnets"; } Aws::String SerializePayload() const override; protected: void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline DescribeSubnetsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline DescribeSubnetsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline DescribeSubnetsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

One or more filters.

  • availability-zone - The * Availability Zone for the subnet. You can also use availabilityZone * as the filter name.

  • availability-zone-id - The * ID of the Availability Zone for the subnet. You can also use * availabilityZoneId as the filter name.

  • * available-ip-address-count - The number of IPv4 addresses in the * subnet that are available.

  • cidr-block - The IPv4 * CIDR block of the subnet. The CIDR block you specify must exactly match the * subnet's CIDR block for information to be returned for the subnet. You can also * use cidr or cidrBlock as the filter names.

  • *
  • default-for-az - Indicates whether this is the default * subnet for the Availability Zone. You can also use defaultForAz as * the filter name.

  • * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block * associated with the subnet.

  • * ipv6-cidr-block-association.association-id - An association ID for * an IPv6 CIDR block associated with the subnet.

  • * ipv6-cidr-block-association.state - The state of an IPv6 CIDR block * associated with the subnet.

  • owner-id - The ID of * the AWS account that owns the subnet.

  • state - * The state of the subnet (pending | available).

    *
  • subnet-arn - The Amazon Resource Name (ARN) of the * subnet.

  • subnet-id - The ID of the subnet.

    *
  • 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 assigned a tag with a * specific key, regardless of the tag value.

  • * vpc-id - The ID of the VPC for the subnet.

*/ inline DescribeSubnetsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline DescribeSubnetsRequest& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline DescribeSubnetsRequest& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline DescribeSubnetsRequest& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline DescribeSubnetsRequest& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } /** *

One or more subnet IDs.

Default: Describes all your subnets.

*/ inline DescribeSubnetsRequest& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *

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.

*/ inline bool GetDryRun() const{ return m_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.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

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.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

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.

*/ inline DescribeSubnetsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The token for the next page of results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The token for the next page of results.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The token for the next page of results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The token for the next page of results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The token for the next page of results.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The token for the next page of results.

*/ inline DescribeSubnetsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The token for the next page of results.

*/ inline DescribeSubnetsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The token for the next page of results.

*/ inline DescribeSubnetsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of results to return with a single call. To retrieve the * remaining results, make another call with the returned nextToken * value.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return with a single call. To retrieve the * remaining results, make another call with the returned nextToken * value.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return with a single call. To retrieve the * remaining results, make another call with the returned nextToken * value.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return with a single call. To retrieve the * remaining results, make another call with the returned nextToken * value.

*/ inline DescribeSubnetsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet; Aws::Vector m_subnetIds; bool m_subnetIdsHasBeenSet; bool m_dryRun; bool m_dryRunHasBeenSet; Aws::String m_nextToken; bool m_nextTokenHasBeenSet; int m_maxResults; bool m_maxResultsHasBeenSet; }; } // namespace Model } // namespace EC2 } // namespace Aws