You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::AllocateAddressRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AllocateAddressRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain: "vpc", # accepts vpc, standard
  address: "PublicIpAddress",
  public_ipv_4_pool: "Ipv4PoolEc2Id",
  network_border_group: "String",
  customer_owned_ipv_4_pool: "String",
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String

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

Returns:

  • (String) —

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

#customer_owned_ipv_4_pool ⇒ String

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.

Returns:

  • (String) —

    The ID of a customer-owned address pool.

#domain ⇒ String

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.

Possible values:

  • vpc
  • standard

Returns:

  • (String) —

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

#dry_run ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#network_border_group ⇒ String

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.

Returns:

  • (String) —

    A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

#public_ipv_4_pool ⇒ String

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.

Returns:

  • (String) —

    The ID of an address pool that you own.