Aws::EC2::Model::Address Class Reference

#include <Address.h>

Public Member Functions

AWS_EC2_API Address ()=default

 

AWS_EC2_API Address (const Aws::Utils::Xml::XmlNode &xmlNode)

 

AWS_EC2_API Address & operator= (const Aws::Utils::Xml::XmlNode &xmlNode)

 

AWS_EC2_API void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const

 

AWS_EC2_API void OutputToStream (Aws::OStream &oStream, const char *location) const

 

const Aws::String & GetAllocationId () const

 

bool AllocationIdHasBeenSet () const

 

template<typename AllocationIdT = Aws::String>

void SetAllocationId (AllocationIdT &&value)

 

template<typename AllocationIdT = Aws::String>

Address & WithAllocationId (AllocationIdT &&value)

 

const Aws::String & GetAssociationId () const

 

bool AssociationIdHasBeenSet () const

 

template<typename AssociationIdT = Aws::String>

void SetAssociationId (AssociationIdT &&value)

 

template<typename AssociationIdT = Aws::String>

Address & WithAssociationId (AssociationIdT &&value)

 

DomainType GetDomain () const

 

bool DomainHasBeenSet () const

 

void SetDomain (DomainType value)

 

Address & WithDomain (DomainType value)

 

const Aws::String & GetNetworkInterfaceId () const

 

bool NetworkInterfaceIdHasBeenSet () const

 

template<typename NetworkInterfaceIdT = Aws::String>

void SetNetworkInterfaceId (NetworkInterfaceIdT &&value)

 

template<typename NetworkInterfaceIdT = Aws::String>

Address & WithNetworkInterfaceId (NetworkInterfaceIdT &&value)

 

const Aws::String & GetNetworkInterfaceOwnerId () const

 

bool NetworkInterfaceOwnerIdHasBeenSet () const

 

template<typename NetworkInterfaceOwnerIdT = Aws::String>

void SetNetworkInterfaceOwnerId (NetworkInterfaceOwnerIdT &&value)

 

template<typename NetworkInterfaceOwnerIdT = Aws::String>

Address & WithNetworkInterfaceOwnerId (NetworkInterfaceOwnerIdT &&value)

 

const Aws::String & GetPrivateIpAddress () const

 

bool PrivateIpAddressHasBeenSet () const

 

template<typename PrivateIpAddressT = Aws::String>

void SetPrivateIpAddress (PrivateIpAddressT &&value)

 

template<typename PrivateIpAddressT = Aws::String>

Address & WithPrivateIpAddress (PrivateIpAddressT &&value)

 

const Aws::Vector< Tag > & GetTags () const

 

bool TagsHasBeenSet () const

 

template<typename TagsT = Aws::Vector<Tag>>

void SetTags (TagsT &&value)

 

template<typename TagsT = Aws::Vector<Tag>>

Address & WithTags (TagsT &&value)

 

template<typename TagsT = Tag>

Address & AddTags (TagsT &&value)

 

const Aws::String & GetPublicIpv4Pool () const

 

bool PublicIpv4PoolHasBeenSet () const

 

template<typename PublicIpv4PoolT = Aws::String>

void SetPublicIpv4Pool (PublicIpv4PoolT &&value)

 

template<typename PublicIpv4PoolT = Aws::String>

Address & 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>

Address & WithNetworkBorderGroup (NetworkBorderGroupT &&value)

 

const Aws::String & GetCustomerOwnedIp () const

 

bool CustomerOwnedIpHasBeenSet () const

 

template<typename CustomerOwnedIpT = Aws::String>

void SetCustomerOwnedIp (CustomerOwnedIpT &&value)

 

template<typename CustomerOwnedIpT = Aws::String>

Address & WithCustomerOwnedIp (CustomerOwnedIpT &&value)

 

const Aws::String & GetCustomerOwnedIpv4Pool () const

 

bool CustomerOwnedIpv4PoolHasBeenSet () const

 

template<typename CustomerOwnedIpv4PoolT = Aws::String>

void SetCustomerOwnedIpv4Pool (CustomerOwnedIpv4PoolT &&value)

 

template<typename CustomerOwnedIpv4PoolT = Aws::String>

Address & WithCustomerOwnedIpv4Pool (CustomerOwnedIpv4PoolT &&value)

 

const Aws::String & GetCarrierIp () const

 

bool CarrierIpHasBeenSet () const

 

template<typename CarrierIpT = Aws::String>

void SetCarrierIp (CarrierIpT &&value)

 

template<typename CarrierIpT = Aws::String>

Address & WithCarrierIp (CarrierIpT &&value)

 

const Aws::String & GetSubnetId () const

 

bool SubnetIdHasBeenSet () const

 

template<typename SubnetIdT = Aws::String>

void SetSubnetId (SubnetIdT &&value)

 

template<typename SubnetIdT = Aws::String>

Address & WithSubnetId (SubnetIdT &&value)

 

ServiceManaged GetServiceManaged () const

 

bool ServiceManagedHasBeenSet () const

 

void SetServiceManaged (ServiceManaged value)

 

Address & WithServiceManaged (ServiceManaged value)

 

const Aws::String & GetInstanceId () const

 

bool InstanceIdHasBeenSet () const

 

template<typename InstanceIdT = Aws::String>

void SetInstanceId (InstanceIdT &&value)

 

template<typename InstanceIdT = Aws::String>

Address & WithInstanceId (InstanceIdT &&value)

 

const Aws::String & GetPublicIp () const

 

bool PublicIpHasBeenSet () const

 

template<typename PublicIpT = Aws::String>

void SetPublicIp (PublicIpT &&value)

 

template<typename PublicIpT = Aws::String>

Address & WithPublicIp (PublicIpT &&value)

 

Detailed Description

Describes an Elastic IP address, or a carrier IP address.

See Also:

AWS API Reference

Definition at line 32 of file Address.h.

Constructor & Destructor Documentation

Address() [1/2]

AWS_EC2_API Aws::EC2::Model::Address::Address ( )

default

Address() [2/2]

AWS_EC2_API Aws::EC2::Model::Address::Address ( const Aws::Utils::Xml::XmlNode &  xmlNode)

Member Function Documentation

AddTags()

template<typename TagsT = Tag>

Address & Aws::EC2::Model::Address::AddTags ( TagsT &&  value)

inline

Any tags assigned to the Elastic IP address.

Definition at line 165 of file Address.h.

AllocationIdHasBeenSet()

bool Aws::EC2::Model::Address::AllocationIdHasBeenSet ( ) const

inline

The ID representing the allocation of the address.

Definition at line 46 of file Address.h.

AssociationIdHasBeenSet()

bool Aws::EC2::Model::Address::AssociationIdHasBeenSet ( ) const

inline

The ID representing the association of the address with an instance.

Definition at line 64 of file Address.h.

CarrierIpHasBeenSet()

bool Aws::EC2::Model::Address::CarrierIpHasBeenSet ( ) const

inline

The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

Definition at line 252 of file Address.h.

CustomerOwnedIpHasBeenSet()

bool Aws::EC2::Model::Address::CustomerOwnedIpHasBeenSet ( ) const

inline

The customer-owned IP address.

Definition at line 214 of file Address.h.

CustomerOwnedIpv4PoolHasBeenSet()

bool Aws::EC2::Model::Address::CustomerOwnedIpv4PoolHasBeenSet ( ) const

inline

The ID of the customer-owned address pool.

Definition at line 232 of file Address.h.

DomainHasBeenSet()

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

inline

The network (vpc).

Definition at line 82 of file Address.h.

GetAllocationId()

const Aws::String & Aws::EC2::Model::Address::GetAllocationId ( ) const

inline

The ID representing the allocation of the address.

Definition at line 45 of file Address.h.

GetAssociationId()

const Aws::String & Aws::EC2::Model::Address::GetAssociationId ( ) const

inline

The ID representing the association of the address with an instance.

Definition at line 63 of file Address.h.

GetCarrierIp()

const Aws::String & Aws::EC2::Model::Address::GetCarrierIp ( ) const

inline

The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

Definition at line 251 of file Address.h.

GetCustomerOwnedIp()

const Aws::String & Aws::EC2::Model::Address::GetCustomerOwnedIp ( ) const

inline

The customer-owned IP address.

Definition at line 213 of file Address.h.

GetCustomerOwnedIpv4Pool()

const Aws::String & Aws::EC2::Model::Address::GetCustomerOwnedIpv4Pool ( ) const

inline

The ID of the customer-owned address pool.

Definition at line 231 of file Address.h.

GetDomain()

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

inline

The network (vpc).

Definition at line 81 of file Address.h.

GetInstanceId()

const Aws::String & Aws::EC2::Model::Address::GetInstanceId ( ) const

inline

The ID of the instance that the address is associated with (if any).

Definition at line 304 of file Address.h.

GetNetworkBorderGroup()

const Aws::String & Aws::EC2::Model::Address::GetNetworkBorderGroup ( ) const

inline

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

Definition at line 195 of file Address.h.

GetNetworkInterfaceId()

const Aws::String & Aws::EC2::Model::Address::GetNetworkInterfaceId ( ) const

inline

The ID of the network interface.

Definition at line 97 of file Address.h.

GetNetworkInterfaceOwnerId()

const Aws::String & Aws::EC2::Model::Address::GetNetworkInterfaceOwnerId ( ) const

inline

The ID of the Amazon Web Services account that owns the network interface.

Definition at line 116 of file Address.h.

GetPrivateIpAddress()

const Aws::String & Aws::EC2::Model::Address::GetPrivateIpAddress ( ) const

inline

The private IP address associated with the Elastic IP address.

Definition at line 134 of file Address.h.

GetPublicIp()

const Aws::String & Aws::EC2::Model::Address::GetPublicIp ( ) const

inline

The Elastic IP address.

Definition at line 322 of file Address.h.

GetPublicIpv4Pool()

const Aws::String & Aws::EC2::Model::Address::GetPublicIpv4Pool ( ) const

inline

The ID of an address pool.

Definition at line 176 of file Address.h.

GetServiceManaged()

ServiceManaged Aws::EC2::Model::Address::GetServiceManaged ( ) const

inline

The service that manages the elastic IP address.

The only option supported today is alb.

Definition at line 288 of file Address.h.

GetSubnetId()

const Aws::String & Aws::EC2::Model::Address::GetSubnetId ( ) const

inline

The ID of the subnet where the IP address is allocated.

Definition at line 269 of file Address.h.

GetTags()

const Aws::Vector< Tag > & Aws::EC2::Model::Address::GetTags ( ) const

inline

Any tags assigned to the Elastic IP address.

Definition at line 152 of file Address.h.

InstanceIdHasBeenSet()

bool Aws::EC2::Model::Address::InstanceIdHasBeenSet ( ) const

inline

The ID of the instance that the address is associated with (if any).

Definition at line 305 of file Address.h.

NetworkBorderGroupHasBeenSet()

bool Aws::EC2::Model::Address::NetworkBorderGroupHasBeenSet ( ) const

inline

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

Definition at line 196 of file Address.h.

NetworkInterfaceIdHasBeenSet()

bool Aws::EC2::Model::Address::NetworkInterfaceIdHasBeenSet ( ) const

inline

The ID of the network interface.

Definition at line 98 of file Address.h.

NetworkInterfaceOwnerIdHasBeenSet()

bool Aws::EC2::Model::Address::NetworkInterfaceOwnerIdHasBeenSet ( ) const

inline

The ID of the Amazon Web Services account that owns the network interface.

Definition at line 117 of file Address.h.

operator=()

AWS_EC2_API Address & Aws::EC2::Model::Address::operator= ( const Aws::Utils::Xml::XmlNode &  xmlNode)

OutputToStream() [1/2]

AWS_EC2_API void Aws::EC2::Model::Address::OutputToStream ( Aws::OStream &  oStream,

const char *  location 

) const

OutputToStream() [2/2]

AWS_EC2_API void Aws::EC2::Model::Address::OutputToStream ( Aws::OStream &  ostream,

const char *  location,

unsigned  index,

const char *  locationValue 

) const

PrivateIpAddressHasBeenSet()

bool Aws::EC2::Model::Address::PrivateIpAddressHasBeenSet ( ) const

inline

The private IP address associated with the Elastic IP address.

Definition at line 135 of file Address.h.

PublicIpHasBeenSet()

bool Aws::EC2::Model::Address::PublicIpHasBeenSet ( ) const

inline

The Elastic IP address.

Definition at line 323 of file Address.h.

PublicIpv4PoolHasBeenSet()

bool Aws::EC2::Model::Address::PublicIpv4PoolHasBeenSet ( ) const

inline

The ID of an address pool.

Definition at line 177 of file Address.h.

ServiceManagedHasBeenSet()

bool Aws::EC2::Model::Address::ServiceManagedHasBeenSet ( ) const

inline

The service that manages the elastic IP address.

The only option supported today is alb.

Definition at line 289 of file Address.h.

SetAllocationId()

template<typename AllocationIdT = Aws::String>

void Aws::EC2::Model::Address::SetAllocationId ( AllocationIdT &&  value)

inline

The ID representing the allocation of the address.

Definition at line 48 of file Address.h.

SetAssociationId()

template<typename AssociationIdT = Aws::String>

void Aws::EC2::Model::Address::SetAssociationId ( AssociationIdT &&  value)

inline

The ID representing the association of the address with an instance.

Definition at line 66 of file Address.h.

SetCarrierIp()

template<typename CarrierIpT = Aws::String>

void Aws::EC2::Model::Address::SetCarrierIp ( CarrierIpT &&  value)

inline

The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

Definition at line 254 of file Address.h.

SetCustomerOwnedIp()

template<typename CustomerOwnedIpT = Aws::String>

void Aws::EC2::Model::Address::SetCustomerOwnedIp ( CustomerOwnedIpT &&  value)

inline

The customer-owned IP address.

Definition at line 216 of file Address.h.

SetCustomerOwnedIpv4Pool()

template<typename CustomerOwnedIpv4PoolT = Aws::String>

void Aws::EC2::Model::Address::SetCustomerOwnedIpv4Pool ( CustomerOwnedIpv4PoolT &&  value)

inline

The ID of the customer-owned address pool.

Definition at line 234 of file Address.h.

SetDomain()

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

inline

The network (vpc).

Definition at line 83 of file Address.h.

SetInstanceId()

template<typename InstanceIdT = Aws::String>

void Aws::EC2::Model::Address::SetInstanceId ( InstanceIdT &&  value)

inline

The ID of the instance that the address is associated with (if any).

Definition at line 307 of file Address.h.

SetNetworkBorderGroup()

template<typename NetworkBorderGroupT = Aws::String>

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

inline

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

Definition at line 198 of file Address.h.

SetNetworkInterfaceId()

template<typename NetworkInterfaceIdT = Aws::String>

void Aws::EC2::Model::Address::SetNetworkInterfaceId ( NetworkInterfaceIdT &&  value)

inline

The ID of the network interface.

Definition at line 100 of file Address.h.

SetNetworkInterfaceOwnerId()

template<typename NetworkInterfaceOwnerIdT = Aws::String>

void Aws::EC2::Model::Address::SetNetworkInterfaceOwnerId ( NetworkInterfaceOwnerIdT &&  value)

inline

The ID of the Amazon Web Services account that owns the network interface.

Definition at line 119 of file Address.h.

SetPrivateIpAddress()

template<typename PrivateIpAddressT = Aws::String>

void Aws::EC2::Model::Address::SetPrivateIpAddress ( PrivateIpAddressT &&  value)

inline

The private IP address associated with the Elastic IP address.

Definition at line 137 of file Address.h.

SetPublicIp()

template<typename PublicIpT = Aws::String>

void Aws::EC2::Model::Address::SetPublicIp ( PublicIpT &&  value)

inline

The Elastic IP address.

Definition at line 325 of file Address.h.

SetPublicIpv4Pool()

template<typename PublicIpv4PoolT = Aws::String>

void Aws::EC2::Model::Address::SetPublicIpv4Pool ( PublicIpv4PoolT &&  value)

inline

The ID of an address pool.

Definition at line 179 of file Address.h.

SetServiceManaged()

void Aws::EC2::Model::Address::SetServiceManaged ( ServiceManaged  value)

inline

The service that manages the elastic IP address.

The only option supported today is alb.

Definition at line 290 of file Address.h.

SetSubnetId()

template<typename SubnetIdT = Aws::String>

void Aws::EC2::Model::Address::SetSubnetId ( SubnetIdT &&  value)

inline

The ID of the subnet where the IP address is allocated.

Definition at line 272 of file Address.h.

SetTags()

template<typename TagsT = Aws::Vector<Tag>>

void Aws::EC2::Model::Address::SetTags ( TagsT &&  value)

inline

Any tags assigned to the Elastic IP address.

Definition at line 155 of file Address.h.

SubnetIdHasBeenSet()

bool Aws::EC2::Model::Address::SubnetIdHasBeenSet ( ) const

inline

The ID of the subnet where the IP address is allocated.

Definition at line 270 of file Address.h.

TagsHasBeenSet()

bool Aws::EC2::Model::Address::TagsHasBeenSet ( ) const

inline

Any tags assigned to the Elastic IP address.

Definition at line 153 of file Address.h.

WithAllocationId()

template<typename AllocationIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithAllocationId ( AllocationIdT &&  value)

inline

The ID representing the allocation of the address.

Definition at line 53 of file Address.h.

WithAssociationId()

template<typename AssociationIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithAssociationId ( AssociationIdT &&  value)

inline

The ID representing the association of the address with an instance.

Definition at line 71 of file Address.h.

WithCarrierIp()

template<typename CarrierIpT = Aws::String>

Address & Aws::EC2::Model::Address::WithCarrierIp ( CarrierIpT &&  value)

inline

The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

Definition at line 259 of file Address.h.

WithCustomerOwnedIp()

template<typename CustomerOwnedIpT = Aws::String>

Address & Aws::EC2::Model::Address::WithCustomerOwnedIp ( CustomerOwnedIpT &&  value)

inline

The customer-owned IP address.

Definition at line 221 of file Address.h.

WithCustomerOwnedIpv4Pool()

template<typename CustomerOwnedIpv4PoolT = Aws::String>

Address & Aws::EC2::Model::Address::WithCustomerOwnedIpv4Pool ( CustomerOwnedIpv4PoolT &&  value)

inline

The ID of the customer-owned address pool.

Definition at line 239 of file Address.h.

WithDomain()

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

inline

The network (vpc).

Definition at line 87 of file Address.h.

WithInstanceId()

template<typename InstanceIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithInstanceId ( InstanceIdT &&  value)

inline

The ID of the instance that the address is associated with (if any).

Definition at line 312 of file Address.h.

WithNetworkBorderGroup()

template<typename NetworkBorderGroupT = Aws::String>

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

inline

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

Definition at line 203 of file Address.h.

WithNetworkInterfaceId()

template<typename NetworkInterfaceIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithNetworkInterfaceId ( NetworkInterfaceIdT &&  value)

inline

The ID of the network interface.

Definition at line 105 of file Address.h.

WithNetworkInterfaceOwnerId()

template<typename NetworkInterfaceOwnerIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithNetworkInterfaceOwnerId ( NetworkInterfaceOwnerIdT &&  value)

inline

The ID of the Amazon Web Services account that owns the network interface.

Definition at line 124 of file Address.h.

WithPrivateIpAddress()

template<typename PrivateIpAddressT = Aws::String>

Address & Aws::EC2::Model::Address::WithPrivateIpAddress ( PrivateIpAddressT &&  value)

inline

The private IP address associated with the Elastic IP address.

Definition at line 142 of file Address.h.

WithPublicIp()

template<typename PublicIpT = Aws::String>

Address & Aws::EC2::Model::Address::WithPublicIp ( PublicIpT &&  value)

inline

The Elastic IP address.

Definition at line 330 of file Address.h.

WithPublicIpv4Pool()

template<typename PublicIpv4PoolT = Aws::String>

Address & Aws::EC2::Model::Address::WithPublicIpv4Pool ( PublicIpv4PoolT &&  value)

inline

The ID of an address pool.

Definition at line 184 of file Address.h.

WithServiceManaged()

Address & Aws::EC2::Model::Address::WithServiceManaged ( ServiceManaged  value)

inline

The service that manages the elastic IP address.

The only option supported today is alb.

Definition at line 294 of file Address.h.

WithSubnetId()

template<typename SubnetIdT = Aws::String>

Address & Aws::EC2::Model::Address::WithSubnetId ( SubnetIdT &&  value)

inline

The ID of the subnet where the IP address is allocated.

Definition at line 277 of file Address.h.

WithTags()

template<typename TagsT = Aws::Vector<Tag>>

Address & Aws::EC2::Model::Address::WithTags ( TagsT &&  value)

inline

Any tags assigned to the Elastic IP address.

Definition at line 160 of file Address.h.

---

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

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