/** * 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 DescribeVpcsRequest : public EC2Request { public: AWS_EC2_API DescribeVpcsRequest(); // 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 "DescribeVpcs"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The filters.

  • cidr - The primary IPv4 CIDR * block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR * block for information to be returned for the VPC. Must contain the slash * followed by one or two digits (for example, /28).

  • *

    cidr-block-association.cidr-block - An IPv4 CIDR block * associated with the VPC.

  • * cidr-block-association.association-id - The association ID for an * IPv4 CIDR block associated with the VPC.

  • * cidr-block-association.state - The state of an IPv4 CIDR block * associated with the VPC.

  • dhcp-options-id - The * ID of a set of DHCP options.

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

  • * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address * pool from which the IPv6 CIDR block is allocated.

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

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

  • is-default - Indicates * whether the VPC is the default VPC.

  • owner-id - * The ID of the Amazon Web Services account that owns the VPC.

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

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

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

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline const Aws::Vector& GetVpcIds() const{ return m_vpcIds; } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline bool VpcIdsHasBeenSet() const { return m_vpcIdsHasBeenSet; } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline void SetVpcIds(const Aws::Vector& value) { m_vpcIdsHasBeenSet = true; m_vpcIds = value; } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline void SetVpcIds(Aws::Vector&& value) { m_vpcIdsHasBeenSet = true; m_vpcIds = std::move(value); } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline DescribeVpcsRequest& WithVpcIds(const Aws::Vector& value) { SetVpcIds(value); return *this;} /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline DescribeVpcsRequest& WithVpcIds(Aws::Vector&& value) { SetVpcIds(std::move(value)); return *this;} /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline DescribeVpcsRequest& AddVpcIds(const Aws::String& value) { m_vpcIdsHasBeenSet = true; m_vpcIds.push_back(value); return *this; } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline DescribeVpcsRequest& AddVpcIds(Aws::String&& value) { m_vpcIdsHasBeenSet = true; m_vpcIds.push_back(std::move(value)); return *this; } /** *

The IDs of the VPCs.

Default: Describes all your VPCs.

*/ inline DescribeVpcsRequest& AddVpcIds(const char* value) { m_vpcIdsHasBeenSet = true; m_vpcIds.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 DescribeVpcsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The token returned from a previous paginated request. Pagination continues * from the end of the items returned by the previous request.

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

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

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

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

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

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

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

The maximum number of items to return for this request. To get the next page * of items, make another request with the token returned in the output. For more * information, see Pagination.

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