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: "PublicIpAddress",
  public_ipv_4_pool: "Ipv4PoolEc2Id",
  network_border_group: "String",
  customer_owned_ipv_4_pool: "String",
  dry_run: false,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

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)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  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)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

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

#domainString

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.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  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)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

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

#network_border_groupString

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.

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 receive an InvalidParameterCombination error.

Returns:

  • (String)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

class AllocateAddressRequest < Struct.new(
  :domain,
  :address,
  :public_ipv_4_pool,
  :network_border_group,
  :customer_owned_ipv_4_pool,
  :dry_run,
  :tag_specifications)
  SENSITIVE = []
  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)


623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

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

#tag_specificationsArray<Types::TagSpecification>

The tags to assign to the Elastic IP address.

Returns:



623
624
625
626
627
628
629
630
631
632
633
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 623

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