363 lines
18 KiB
C++
363 lines
18 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/ec2/EC2_EXPORTS.h>
|
|
#include <aws/ec2/EC2Request.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/ec2/model/Filter.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace EC2
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_EC2_API DescribeCarrierGatewaysRequest : public EC2Request
|
|
{
|
|
public:
|
|
DescribeCarrierGatewaysRequest();
|
|
|
|
// 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 "DescribeCarrierGateways"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetCarrierGatewayIds() const{ return m_carrierGatewayIds; }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline bool CarrierGatewayIdsHasBeenSet() const { return m_carrierGatewayIdsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline void SetCarrierGatewayIds(const Aws::Vector<Aws::String>& value) { m_carrierGatewayIdsHasBeenSet = true; m_carrierGatewayIds = value; }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline void SetCarrierGatewayIds(Aws::Vector<Aws::String>&& value) { m_carrierGatewayIdsHasBeenSet = true; m_carrierGatewayIds = std::move(value); }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithCarrierGatewayIds(const Aws::Vector<Aws::String>& value) { SetCarrierGatewayIds(value); return *this;}
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithCarrierGatewayIds(Aws::Vector<Aws::String>&& value) { SetCarrierGatewayIds(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& AddCarrierGatewayIds(const Aws::String& value) { m_carrierGatewayIdsHasBeenSet = true; m_carrierGatewayIds.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& AddCarrierGatewayIds(Aws::String&& value) { m_carrierGatewayIdsHasBeenSet = true; m_carrierGatewayIds.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>One or more carrier gateway IDs.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& AddCarrierGatewayIds(const char* value) { m_carrierGatewayIdsHasBeenSet = true; m_carrierGatewayIds.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>One or more filters.</p> <ul> <li> <p> <code>carrier-gateway-id</code> - The
|
|
* ID of the carrier gateway.</p> </li> <li> <p> <code>state</code> - The state of
|
|
* the carrier gateway (<code>pending</code> | <code>failed</code> |
|
|
* <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>
|
|
* </li> <li> <p> <code>owner-id</code> - The AWS account ID of the owner of the
|
|
* carrier gateway.</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value
|
|
* <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and
|
|
* <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code>
|
|
* - 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.</p>
|
|
* </li> <li> <p> <code>vpc-id</code> - The ID of the VPC associated with the
|
|
* carrier gateway.</p> </li> </ul>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of results to return with a single call. To retrieve the
|
|
* remaining results, make another call with the returned <code>nextToken</code>
|
|
* value.</p>
|
|
*/
|
|
inline int GetMaxResults() const{ return m_maxResults; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return with a single call. To retrieve the
|
|
* remaining results, make another call with the returned <code>nextToken</code>
|
|
* value.</p>
|
|
*/
|
|
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return with a single call. To retrieve the
|
|
* remaining results, make another call with the returned <code>nextToken</code>
|
|
* value.</p>
|
|
*/
|
|
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return with a single call. To retrieve the
|
|
* remaining results, make another call with the returned <code>nextToken</code>
|
|
* value.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The token for the next page of results.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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 <code>DryRunOperation</code>.
|
|
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
|
|
*/
|
|
inline bool GetDryRun() const{ return m_dryRun; }
|
|
|
|
/**
|
|
* <p>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 <code>DryRunOperation</code>.
|
|
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
|
|
*/
|
|
inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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 <code>DryRunOperation</code>.
|
|
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
|
|
*/
|
|
inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
|
|
|
|
/**
|
|
* <p>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 <code>DryRunOperation</code>.
|
|
* Otherwise, it is <code>UnauthorizedOperation</code>.</p>
|
|
*/
|
|
inline DescribeCarrierGatewaysRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::Vector<Aws::String> m_carrierGatewayIds;
|
|
bool m_carrierGatewayIdsHasBeenSet;
|
|
|
|
Aws::Vector<Filter> m_filters;
|
|
bool m_filtersHasBeenSet;
|
|
|
|
int m_maxResults;
|
|
bool m_maxResultsHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
|
|
bool m_dryRun;
|
|
bool m_dryRunHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace EC2
|
|
} // namespace Aws
|