252 lines
11 KiB
C++
252 lines
11 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/ec2/model/Filter.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace EC2
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_EC2_API DescribeRegionsRequest : public EC2Request
|
|
{
|
|
public:
|
|
DescribeRegionsRequest();
|
|
|
|
// 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 "DescribeRegions"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline DescribeRegionsRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline DescribeRegionsRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline DescribeRegionsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the
|
|
* Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li>
|
|
* <p> <code>opt-in-status</code> - The opt-in status of the Region
|
|
* (<code>opt-in-not-required</code> | <code>opted-in</code> |
|
|
* <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The
|
|
* name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>
|
|
*/
|
|
inline DescribeRegionsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetRegionNames() const{ return m_regionNames; }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline bool RegionNamesHasBeenSet() const { return m_regionNamesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline void SetRegionNames(const Aws::Vector<Aws::String>& value) { m_regionNamesHasBeenSet = true; m_regionNames = value; }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline void SetRegionNames(Aws::Vector<Aws::String>&& value) { m_regionNamesHasBeenSet = true; m_regionNames = std::move(value); }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& WithRegionNames(const Aws::Vector<Aws::String>& value) { SetRegionNames(value); return *this;}
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& WithRegionNames(Aws::Vector<Aws::String>&& value) { SetRegionNames(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& AddRegionNames(const Aws::String& value) { m_regionNamesHasBeenSet = true; m_regionNames.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& AddRegionNames(Aws::String&& value) { m_regionNamesHasBeenSet = true; m_regionNames.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>The names of the Regions. You can specify any Regions, whether they are
|
|
* enabled and disabled for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& AddRegionNames(const char* value) { m_regionNamesHasBeenSet = true; m_regionNames.push_back(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 DescribeRegionsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Indicates whether to display all Regions, including Regions that are disabled
|
|
* for your account.</p>
|
|
*/
|
|
inline bool GetAllRegions() const{ return m_allRegions; }
|
|
|
|
/**
|
|
* <p>Indicates whether to display all Regions, including Regions that are disabled
|
|
* for your account.</p>
|
|
*/
|
|
inline bool AllRegionsHasBeenSet() const { return m_allRegionsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates whether to display all Regions, including Regions that are disabled
|
|
* for your account.</p>
|
|
*/
|
|
inline void SetAllRegions(bool value) { m_allRegionsHasBeenSet = true; m_allRegions = value; }
|
|
|
|
/**
|
|
* <p>Indicates whether to display all Regions, including Regions that are disabled
|
|
* for your account.</p>
|
|
*/
|
|
inline DescribeRegionsRequest& WithAllRegions(bool value) { SetAllRegions(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::Vector<Filter> m_filters;
|
|
bool m_filtersHasBeenSet;
|
|
|
|
Aws::Vector<Aws::String> m_regionNames;
|
|
bool m_regionNamesHasBeenSet;
|
|
|
|
bool m_dryRun;
|
|
bool m_dryRunHasBeenSet;
|
|
|
|
bool m_allRegions;
|
|
bool m_allRegionsHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace EC2
|
|
} // namespace Aws
|