Aws::EC2::Model::AllocateAddressRequest Class Reference

#include <AllocateAddressRequest.h>

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

Public Member Functions

AWS_EC2_API AllocateAddressRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_EC2_API Aws::String SerializePayload () const override

 

DomainType GetDomain () const

 

bool DomainHasBeenSet () const

 

void SetDomain (DomainType value)

 

AllocateAddressRequest & WithDomain (DomainType value)

 

const Aws::String & GetAddress () const

 

bool AddressHasBeenSet () const

 

template<typename AddressT = Aws::String>

void SetAddress (AddressT &&value)

 

template<typename AddressT = Aws::String>

AllocateAddressRequest & WithAddress (AddressT &&value)

 

const Aws::String & GetPublicIpv4Pool () const

 

bool PublicIpv4PoolHasBeenSet () const

 

template<typename PublicIpv4PoolT = Aws::String>

void SetPublicIpv4Pool (PublicIpv4PoolT &&value)

 

template<typename PublicIpv4PoolT = Aws::String>

AllocateAddressRequest & WithPublicIpv4Pool (PublicIpv4PoolT &&value)

 

const Aws::String & GetNetworkBorderGroup () const

 

bool NetworkBorderGroupHasBeenSet () const

 

template<typename NetworkBorderGroupT = Aws::String>

void SetNetworkBorderGroup (NetworkBorderGroupT &&value)

 

template<typename NetworkBorderGroupT = Aws::String>

AllocateAddressRequest & WithNetworkBorderGroup (NetworkBorderGroupT &&value)

 

const Aws::String & GetCustomerOwnedIpv4Pool () const

 

bool CustomerOwnedIpv4PoolHasBeenSet () const

 

template<typename CustomerOwnedIpv4PoolT = Aws::String>

void SetCustomerOwnedIpv4Pool (CustomerOwnedIpv4PoolT &&value)

 

template<typename CustomerOwnedIpv4PoolT = Aws::String>

AllocateAddressRequest & WithCustomerOwnedIpv4Pool (CustomerOwnedIpv4PoolT &&value)

 

const Aws::Vector< TagSpecification > & GetTagSpecifications () const

 

bool TagSpecificationsHasBeenSet () const

 

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

void SetTagSpecifications (TagSpecificationsT &&value)

 

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

AllocateAddressRequest & WithTagSpecifications (TagSpecificationsT &&value)

 

template<typename TagSpecificationsT = TagSpecification>

AllocateAddressRequest & AddTagSpecifications (TagSpecificationsT &&value)

 

const Aws::String & GetIpamPoolId () const

 

bool IpamPoolIdHasBeenSet () const

 

template<typename IpamPoolIdT = Aws::String>

void SetIpamPoolId (IpamPoolIdT &&value)

 

template<typename IpamPoolIdT = Aws::String>

AllocateAddressRequest & WithIpamPoolId (IpamPoolIdT &&value)

 

bool GetDryRun () const

 

bool DryRunHasBeenSet () const

 

void SetDryRun (bool value)

 

AllocateAddressRequest & WithDryRun (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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

AWS_EC2_API void DumpBodyToUrl (Aws::Http::URI &uri) const override

 

Protected Member Functions inherited from Aws::EC2::EC2Request

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 22 of file AllocateAddressRequest.h.

Constructor & Destructor Documentation

AllocateAddressRequest()

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

default

Member Function Documentation

AddressHasBeenSet()

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

inline

The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 60 of file AllocateAddressRequest.h.

AddTagSpecifications()

template<typename TagSpecificationsT = TagSpecification>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::AddTagSpecifications ( TagSpecificationsT &&  value)

inline

The tags to assign to the Elastic IP address.

Definition at line 151 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 121 of file AllocateAddressRequest.h.

DomainHasBeenSet()

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

inline

The network (vpc).

Definition at line 43 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 188 of file AllocateAddressRequest.h.

DumpBodyToUrl()

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

overrideprotectedvirtual

Reimplemented from Aws::AmazonWebServiceRequest.

GetAddress()

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

inline

The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 59 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 120 of file AllocateAddressRequest.h.

GetDomain()

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

inline

The network (vpc).

Definition at line 42 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 187 of file AllocateAddressRequest.h.

GetIpamPoolId()

const Aws::String & Aws::EC2::Model::AllocateAddressRequest::GetIpamPoolId ( ) const

inline

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

Definition at line 166 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 Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Definition at line 100 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 79 of file AllocateAddressRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file AllocateAddressRequest.h.

GetTagSpecifications()

const Aws::Vector< TagSpecification > & Aws::EC2::Model::AllocateAddressRequest::GetTagSpecifications ( ) const

inline

The tags to assign to the Elastic IP address.

Definition at line 138 of file AllocateAddressRequest.h.

IpamPoolIdHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::IpamPoolIdHasBeenSet ( ) const

inline

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

Definition at line 167 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 Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Definition at line 101 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 80 of file AllocateAddressRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetAddress()

template<typename AddressT = Aws::String>

void Aws::EC2::Model::AllocateAddressRequest::SetAddress ( AddressT &&  value)

inline

The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 62 of file AllocateAddressRequest.h.

SetCustomerOwnedIpv4Pool()

template<typename CustomerOwnedIpv4PoolT = Aws::String>

void Aws::EC2::Model::AllocateAddressRequest::SetCustomerOwnedIpv4Pool ( CustomerOwnedIpv4PoolT &&  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 123 of file AllocateAddressRequest.h.

SetDomain()

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

inline

The network (vpc).

Definition at line 44 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 189 of file AllocateAddressRequest.h.

SetIpamPoolId()

template<typename IpamPoolIdT = Aws::String>

void Aws::EC2::Model::AllocateAddressRequest::SetIpamPoolId ( IpamPoolIdT &&  value)

inline

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

Definition at line 169 of file AllocateAddressRequest.h.

SetNetworkBorderGroup()

template<typename NetworkBorderGroupT = Aws::String>

void Aws::EC2::Model::AllocateAddressRequest::SetNetworkBorderGroup ( NetworkBorderGroupT &&  value)

inline

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

Definition at line 103 of file AllocateAddressRequest.h.

SetPublicIpv4Pool()

template<typename PublicIpv4PoolT = Aws::String>

void Aws::EC2::Model::AllocateAddressRequest::SetPublicIpv4Pool ( PublicIpv4PoolT &&  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 82 of file AllocateAddressRequest.h.

SetTagSpecifications()

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

void Aws::EC2::Model::AllocateAddressRequest::SetTagSpecifications ( TagSpecificationsT &&  value)

inline

The tags to assign to the Elastic IP address.

Definition at line 141 of file AllocateAddressRequest.h.

TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::AllocateAddressRequest::TagSpecificationsHasBeenSet ( ) const

inline

The tags to assign to the Elastic IP address.

Definition at line 139 of file AllocateAddressRequest.h.

WithAddress()

template<typename AddressT = Aws::String>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithAddress ( AddressT &&  value)

inline

The Elastic IP address to recover or an IPv4 address from an address pool.

Definition at line 67 of file AllocateAddressRequest.h.

WithCustomerOwnedIpv4Pool()

template<typename CustomerOwnedIpv4PoolT = Aws::String>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithCustomerOwnedIpv4Pool ( CustomerOwnedIpv4PoolT &&  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 128 of file AllocateAddressRequest.h.

WithDomain()

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

inline

The network (vpc).

Definition at line 48 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 193 of file AllocateAddressRequest.h.

WithIpamPoolId()

template<typename IpamPoolIdT = Aws::String>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithIpamPoolId ( IpamPoolIdT &&  value)

inline

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

Definition at line 174 of file AllocateAddressRequest.h.

WithNetworkBorderGroup()

template<typename NetworkBorderGroupT = Aws::String>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithNetworkBorderGroup ( NetworkBorderGroupT &&  value)

inline

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

Definition at line 108 of file AllocateAddressRequest.h.

WithPublicIpv4Pool()

template<typename PublicIpv4PoolT = Aws::String>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithPublicIpv4Pool ( PublicIpv4PoolT &&  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 87 of file AllocateAddressRequest.h.

WithTagSpecifications()

template<typename TagSpecificationsT = Aws::Vector<TagSpecification>>

AllocateAddressRequest & Aws::EC2::Model::AllocateAddressRequest::WithTagSpecifications ( TagSpecificationsT &&  value)

inline

The tags to assign to the Elastic IP address.

Definition at line 146 of file AllocateAddressRequest.h.

---

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

• generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/AllocateAddressRequest.h