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

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 DescribeNatGatewaysRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline const Aws::Vector& GetFilter() const{ return m_filter; } /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline void SetFilter(const Aws::Vector& value) { m_filterHasBeenSet = true; m_filter = value; } /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline void SetFilter(Aws::Vector&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline DescribeNatGatewaysRequest& WithFilter(const Aws::Vector& value) { SetFilter(value); return *this;} /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline DescribeNatGatewaysRequest& WithFilter(Aws::Vector&& value) { SetFilter(std::move(value)); return *this;} /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline DescribeNatGatewaysRequest& AddFilter(const Filter& value) { m_filterHasBeenSet = true; m_filter.push_back(value); return *this; } /** *

The filters.

  • nat-gateway-id - The ID of the * NAT gateway.

  • state - The state of the NAT * gateway (pending | failed | available | * deleting | deleted).

  • * subnet-id - The ID of the subnet in which the NAT gateway * resides.

  • 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 in which the NAT gateway * resides.

*/ inline DescribeNatGatewaysRequest& AddFilter(Filter&& value) { m_filterHasBeenSet = true; m_filter.push_back(std::move(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 DescribeNatGatewaysRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The IDs of the NAT gateways.

*/ inline const Aws::Vector& GetNatGatewayIds() const{ return m_natGatewayIds; } /** *

The IDs of the NAT gateways.

*/ inline bool NatGatewayIdsHasBeenSet() const { return m_natGatewayIdsHasBeenSet; } /** *

The IDs of the NAT gateways.

*/ inline void SetNatGatewayIds(const Aws::Vector& value) { m_natGatewayIdsHasBeenSet = true; m_natGatewayIds = value; } /** *

The IDs of the NAT gateways.

*/ inline void SetNatGatewayIds(Aws::Vector&& value) { m_natGatewayIdsHasBeenSet = true; m_natGatewayIds = std::move(value); } /** *

The IDs of the NAT gateways.

*/ inline DescribeNatGatewaysRequest& WithNatGatewayIds(const Aws::Vector& value) { SetNatGatewayIds(value); return *this;} /** *

The IDs of the NAT gateways.

*/ inline DescribeNatGatewaysRequest& WithNatGatewayIds(Aws::Vector&& value) { SetNatGatewayIds(std::move(value)); return *this;} /** *

The IDs of the NAT gateways.

*/ inline DescribeNatGatewaysRequest& AddNatGatewayIds(const Aws::String& value) { m_natGatewayIdsHasBeenSet = true; m_natGatewayIds.push_back(value); return *this; } /** *

The IDs of the NAT gateways.

*/ inline DescribeNatGatewaysRequest& AddNatGatewayIds(Aws::String&& value) { m_natGatewayIdsHasBeenSet = true; m_natGatewayIds.push_back(std::move(value)); return *this; } /** *

The IDs of the NAT gateways.

*/ inline DescribeNatGatewaysRequest& AddNatGatewayIds(const char* value) { m_natGatewayIdsHasBeenSet = true; m_natGatewayIds.push_back(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 DescribeNatGatewaysRequest& 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 DescribeNatGatewaysRequest& 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 DescribeNatGatewaysRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: bool m_dryRun; bool m_dryRunHasBeenSet = false; Aws::Vector m_filter; bool m_filterHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::Vector m_natGatewayIds; bool m_natGatewayIdsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws