AWS SDK for C++  1.8.26
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::AllocateAddressRequest Class Reference

#include <AllocateAddressRequest.h>

+ Inheritance diagram for Aws::EC2::Model::AllocateAddressRequest:

Public Member Functions

 AllocateAddressRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const DomainTypeGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const DomainType &value)
 
void SetDomain (DomainType &&value)
 
AllocateAddressRequestWithDomain (const DomainType &value)
 
AllocateAddressRequestWithDomain (DomainType &&value)
 
const Aws::StringGetAddress () const
 
bool AddressHasBeenSet () const
 
void SetAddress (const Aws::String &value)
 
void SetAddress (Aws::String &&value)
 
void SetAddress (const char *value)
 
AllocateAddressRequestWithAddress (const Aws::String &value)
 
AllocateAddressRequestWithAddress (Aws::String &&value)
 
AllocateAddressRequestWithAddress (const char *value)
 
const Aws::StringGetPublicIpv4Pool () const
 
bool PublicIpv4PoolHasBeenSet () const
 
void SetPublicIpv4Pool (const Aws::String &value)
 
void SetPublicIpv4Pool (Aws::String &&value)
 
void SetPublicIpv4Pool (const char *value)
 
AllocateAddressRequestWithPublicIpv4Pool (const Aws::String &value)
 
AllocateAddressRequestWithPublicIpv4Pool (Aws::String &&value)
 
AllocateAddressRequestWithPublicIpv4Pool (const char *value)
 
const Aws::StringGetNetworkBorderGroup () const
 
bool NetworkBorderGroupHasBeenSet () const
 
void SetNetworkBorderGroup (const Aws::String &value)
 
void SetNetworkBorderGroup (Aws::String &&value)
 
void SetNetworkBorderGroup (const char *value)
 
AllocateAddressRequestWithNetworkBorderGroup (const Aws::String &value)
 
AllocateAddressRequestWithNetworkBorderGroup (Aws::String &&value)
 
AllocateAddressRequestWithNetworkBorderGroup (const char *value)
 
const Aws::StringGetCustomerOwnedIpv4Pool () const
 
bool CustomerOwnedIpv4PoolHasBeenSet () const
 
void SetCustomerOwnedIpv4Pool (const Aws::String &value)
 
void SetCustomerOwnedIpv4Pool (Aws::String &&value)
 
void SetCustomerOwnedIpv4Pool (const char *value)
 
AllocateAddressRequestWithCustomerOwnedIpv4Pool (const Aws::String &value)
 
AllocateAddressRequestWithCustomerOwnedIpv4Pool (Aws::String &&value)
 
AllocateAddressRequestWithCustomerOwnedIpv4Pool (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
AllocateAddressRequestWithDryRun (bool value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 22 of file AllocateAddressRequest.h.

Constructor & Destructor Documentation

◆ AllocateAddressRequest()

Aws::EC2::Model::AllocateAddressRequest::AllocateAddressRequest ( )

Member Function Documentation

◆ AddressHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::AddressHasBeenSet ( ) const
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 99 of file AllocateAddressRequest.h.

◆ CustomerOwnedIpv4PoolHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::CustomerOwnedIpv4PoolHasBeenSet ( ) const
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 328 of file AllocateAddressRequest.h.

◆ DomainHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::DomainHasBeenSet ( ) const
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 54 of file AllocateAddressRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 387 of file AllocateAddressRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::AllocateAddressRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAddress()

const Aws::String& Aws::EC2::Model::AllocateAddressRequest::GetAddress ( ) const
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 93 of file AllocateAddressRequest.h.

◆ GetCustomerOwnedIpv4Pool()

const Aws::String& Aws::EC2::Model::AllocateAddressRequest::GetCustomerOwnedIpv4Pool ( ) const
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 321 of file AllocateAddressRequest.h.

◆ GetDomain()

const DomainType& Aws::EC2::Model::AllocateAddressRequest::GetDomain ( ) const
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 46 of file AllocateAddressRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::AllocateAddressRequest::GetDryRun ( ) const
inline

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.

Definition at line 379 of file AllocateAddressRequest.h.

◆ GetNetworkBorderGroup()

const Aws::String& Aws::EC2::Model::AllocateAddressRequest::GetNetworkBorderGroup ( ) const
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 208 of file AllocateAddressRequest.h.

◆ GetPublicIpv4Pool()

const Aws::String& Aws::EC2::Model::AllocateAddressRequest::GetPublicIpv4Pool ( ) const
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 143 of file AllocateAddressRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::AllocateAddressRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file AllocateAddressRequest.h.

◆ NetworkBorderGroupHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::NetworkBorderGroupHasBeenSet ( ) const
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 223 of file AllocateAddressRequest.h.

◆ PublicIpv4PoolHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::PublicIpv4PoolHasBeenSet ( ) const
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 150 of file AllocateAddressRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::AllocateAddressRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAddress() [1/3]

void Aws::EC2::Model::AllocateAddressRequest::SetAddress ( const Aws::String value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 105 of file AllocateAddressRequest.h.

◆ SetAddress() [2/3]

void Aws::EC2::Model::AllocateAddressRequest::SetAddress ( Aws::String &&  value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 111 of file AllocateAddressRequest.h.

◆ SetAddress() [3/3]

void Aws::EC2::Model::AllocateAddressRequest::SetAddress ( const char *  value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 117 of file AllocateAddressRequest.h.

◆ SetCustomerOwnedIpv4Pool() [1/3]

void Aws::EC2::Model::AllocateAddressRequest::SetCustomerOwnedIpv4Pool ( const Aws::String value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 335 of file AllocateAddressRequest.h.

◆ SetCustomerOwnedIpv4Pool() [2/3]

void Aws::EC2::Model::AllocateAddressRequest::SetCustomerOwnedIpv4Pool ( Aws::String &&  value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 342 of file AllocateAddressRequest.h.

◆ SetCustomerOwnedIpv4Pool() [3/3]

void Aws::EC2::Model::AllocateAddressRequest::SetCustomerOwnedIpv4Pool ( const char *  value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 349 of file AllocateAddressRequest.h.

◆ SetDomain() [1/2]

void Aws::EC2::Model::AllocateAddressRequest::SetDomain ( const DomainType value)
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 62 of file AllocateAddressRequest.h.

◆ SetDomain() [2/2]

void Aws::EC2::Model::AllocateAddressRequest::SetDomain ( DomainType &&  value)
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 70 of file AllocateAddressRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::AllocateAddressRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 395 of file AllocateAddressRequest.h.

◆ SetNetworkBorderGroup() [1/3]

void Aws::EC2::Model::AllocateAddressRequest::SetNetworkBorderGroup ( const Aws::String value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 238 of file AllocateAddressRequest.h.

◆ SetNetworkBorderGroup() [2/3]

void Aws::EC2::Model::AllocateAddressRequest::SetNetworkBorderGroup ( Aws::String &&  value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 253 of file AllocateAddressRequest.h.

◆ SetNetworkBorderGroup() [3/3]

void Aws::EC2::Model::AllocateAddressRequest::SetNetworkBorderGroup ( const char *  value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 268 of file AllocateAddressRequest.h.

◆ SetPublicIpv4Pool() [1/3]

void Aws::EC2::Model::AllocateAddressRequest::SetPublicIpv4Pool ( const Aws::String value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 157 of file AllocateAddressRequest.h.

◆ SetPublicIpv4Pool() [2/3]

void Aws::EC2::Model::AllocateAddressRequest::SetPublicIpv4Pool ( Aws::String &&  value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 164 of file AllocateAddressRequest.h.

◆ SetPublicIpv4Pool() [3/3]

void Aws::EC2::Model::AllocateAddressRequest::SetPublicIpv4Pool ( const char *  value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 171 of file AllocateAddressRequest.h.

◆ WithAddress() [1/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithAddress ( const Aws::String value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 123 of file AllocateAddressRequest.h.

◆ WithAddress() [2/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithAddress ( Aws::String &&  value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 129 of file AllocateAddressRequest.h.

◆ WithAddress() [3/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithAddress ( const char *  value)
inline

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 135 of file AllocateAddressRequest.h.

◆ WithCustomerOwnedIpv4Pool() [1/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithCustomerOwnedIpv4Pool ( const Aws::String value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 356 of file AllocateAddressRequest.h.

◆ WithCustomerOwnedIpv4Pool() [2/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithCustomerOwnedIpv4Pool ( Aws::String &&  value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 363 of file AllocateAddressRequest.h.

◆ WithCustomerOwnedIpv4Pool() [3/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithCustomerOwnedIpv4Pool ( const char *  value)
inline

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Definition at line 370 of file AllocateAddressRequest.h.

◆ WithDomain() [1/2]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithDomain ( const DomainType value)
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 78 of file AllocateAddressRequest.h.

◆ WithDomain() [2/2]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithDomain ( DomainType &&  value)
inline

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Definition at line 86 of file AllocateAddressRequest.h.

◆ WithDryRun()

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 403 of file AllocateAddressRequest.h.

◆ WithNetworkBorderGroup() [1/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithNetworkBorderGroup ( const Aws::String value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 283 of file AllocateAddressRequest.h.

◆ WithNetworkBorderGroup() [2/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithNetworkBorderGroup ( Aws::String &&  value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 298 of file AllocateAddressRequest.h.

◆ WithNetworkBorderGroup() [3/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithNetworkBorderGroup ( const char *  value)
inline

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Definition at line 313 of file AllocateAddressRequest.h.

◆ WithPublicIpv4Pool() [1/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithPublicIpv4Pool ( const Aws::String value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 178 of file AllocateAddressRequest.h.

◆ WithPublicIpv4Pool() [2/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithPublicIpv4Pool ( Aws::String &&  value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 185 of file AllocateAddressRequest.h.

◆ WithPublicIpv4Pool() [3/3]

AllocateAddressRequest& Aws::EC2::Model::AllocateAddressRequest::WithPublicIpv4Pool ( const char *  value)
inline

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Definition at line 192 of file AllocateAddressRequest.h.


The documentation for this class was generated from the following file: