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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass AllocateAddressRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

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

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end

#customer_owned_ipv_4_poolString

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)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end

#domainString

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Returns:

  • (String)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end

#network_border_groupString

The location from which the IP address is advertised. Use this parameter to limit the address to this location.

Use DescribeVpcs 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)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end

#public_ipv_4_poolString

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)


469
470
471
472
473
474
475
476
477
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 469

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run)
  include Aws::Structure
end