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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::AllocateAddressRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #address ⇒ String

  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.

• #domain ⇒ String

  The network (‘vpc`).

• #dry_run ⇒ Boolean

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

• #ipam_pool_id ⇒ String

  The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.

• #network_border_group ⇒ String

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

• #public_ipv_4_pool ⇒ String

  The ID of an address pool that you own.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The tags to assign to the Elastic IP address.

Instance Attribute Details

#address ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

The network (‘vpc`).

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_pool_id ⇒ String

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*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#network_border_group ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to assign to the Elastic IP address.

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 1008

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :tag_specifications,
  :ipam_pool_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end