/** * 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 { /** *

Contains the parameters for DescribeVpnGateways.

See Also:

* AWS * API Reference

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more filters.

  • amazon-side-asn - The * Autonomous System Number (ASN) for the Amazon side of the gateway.

  • *
  • attachment.state - The current state of the attachment * between the gateway and the VPC (attaching | attached * | detaching | detached).

  • * attachment.vpc-id - The ID of an attached VPC.

  • * availability-zone - The Availability Zone for the virtual private * gateway (if applicable).

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

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

  • type * - The type of virtual private gateway. Currently the only supported type is * ipsec.1.

  • vpn-gateway-id - The ID of * the virtual private gateway.

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

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline const Aws::Vector& GetVpnGatewayIds() const{ return m_vpnGatewayIds; } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline bool VpnGatewayIdsHasBeenSet() const { return m_vpnGatewayIdsHasBeenSet; } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline void SetVpnGatewayIds(const Aws::Vector& value) { m_vpnGatewayIdsHasBeenSet = true; m_vpnGatewayIds = value; } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline void SetVpnGatewayIds(Aws::Vector&& value) { m_vpnGatewayIdsHasBeenSet = true; m_vpnGatewayIds = std::move(value); } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline DescribeVpnGatewaysRequest& WithVpnGatewayIds(const Aws::Vector& value) { SetVpnGatewayIds(value); return *this;} /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline DescribeVpnGatewaysRequest& WithVpnGatewayIds(Aws::Vector&& value) { SetVpnGatewayIds(std::move(value)); return *this;} /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline DescribeVpnGatewaysRequest& AddVpnGatewayIds(const Aws::String& value) { m_vpnGatewayIdsHasBeenSet = true; m_vpnGatewayIds.push_back(value); return *this; } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline DescribeVpnGatewaysRequest& AddVpnGatewayIds(Aws::String&& value) { m_vpnGatewayIdsHasBeenSet = true; m_vpnGatewayIds.push_back(std::move(value)); return *this; } /** *

One or more virtual private gateway IDs.

Default: Describes all your * virtual private gateways.

*/ inline DescribeVpnGatewaysRequest& AddVpnGatewayIds(const char* value) { m_vpnGatewayIdsHasBeenSet = true; m_vpnGatewayIds.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 DescribeVpnGatewaysRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::Vector m_vpnGatewayIds; bool m_vpnGatewayIdsHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws