/** * 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 DescribeVpnConnections.

See Also:

* AWS * API Reference

*/ class DescribeVpnConnectionsRequest : public EC2Request { public: AWS_EC2_API DescribeVpnConnectionsRequest(); // 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 "DescribeVpnConnections"; } 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.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more filters.

  • * customer-gateway-configuration - The configuration information for * the customer gateway.

  • customer-gateway-id - The * ID of a customer gateway associated with the VPN connection.

  • * state - The state of the VPN connection (pending | * available | deleting | deleted).

    *
  • option.static-routes-only - Indicates whether the * connection has static routes only. Used for devices that do not support Border * Gateway Protocol (BGP).

  • * route.destination-cidr-block - The destination CIDR block. This * corresponds to the subnet used in a customer data center.

  • * bgp-asn - The BGP Autonomous System Number (ASN) associated with a * BGP device.

  • 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 VPN connection. Currently the * only supported type is ipsec.1.

  • * vpn-connection-id - The ID of the VPN connection.

  • *

    vpn-gateway-id - The ID of a virtual private gateway associated * with the VPN connection.

  • transit-gateway-id - * The ID of a transit gateway associated with the VPN connection.

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

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline const Aws::Vector& GetVpnConnectionIds() const{ return m_vpnConnectionIds; } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline bool VpnConnectionIdsHasBeenSet() const { return m_vpnConnectionIdsHasBeenSet; } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline void SetVpnConnectionIds(const Aws::Vector& value) { m_vpnConnectionIdsHasBeenSet = true; m_vpnConnectionIds = value; } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline void SetVpnConnectionIds(Aws::Vector&& value) { m_vpnConnectionIdsHasBeenSet = true; m_vpnConnectionIds = std::move(value); } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline DescribeVpnConnectionsRequest& WithVpnConnectionIds(const Aws::Vector& value) { SetVpnConnectionIds(value); return *this;} /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline DescribeVpnConnectionsRequest& WithVpnConnectionIds(Aws::Vector&& value) { SetVpnConnectionIds(std::move(value)); return *this;} /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline DescribeVpnConnectionsRequest& AddVpnConnectionIds(const Aws::String& value) { m_vpnConnectionIdsHasBeenSet = true; m_vpnConnectionIds.push_back(value); return *this; } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

*/ inline DescribeVpnConnectionsRequest& AddVpnConnectionIds(Aws::String&& value) { m_vpnConnectionIdsHasBeenSet = true; m_vpnConnectionIds.push_back(std::move(value)); return *this; } /** *

One or more VPN connection IDs.

Default: Describes your VPN * connections.

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