Class: Aws::EC2::Types::CreateIpamPoolRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::CreateIpamPoolRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#address_family ⇒ String

The IP protocol assigned to this IPAM pool.
#allocation_default_netmask_length ⇒ Integer

The default netmask length for allocations added to this pool.
#allocation_max_netmask_length ⇒ Integer

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
#allocation_min_netmask_length ⇒ Integer

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
#allocation_resource_tags ⇒ Array<Types::RequestIpamResourceTag>

Tags that are required for resources that use CIDRs from this IPAM pool.
#auto_import ⇒ Boolean

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
#aws_service ⇒ String

Limits which service in Amazon Web Services that the pool can be used in.
#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#description ⇒ String

A description for the IPAM pool.
#dry_run ⇒ Boolean

A check for whether you have the required permissions for the action without actually making the request and provides an error response.
#ipam_scope_id ⇒ String

The ID of the scope in which you would like to create the IPAM pool.
#locale ⇒ String

The locale for the pool should be one of the following:.
#public_ip_source ⇒ String

The IP address source for pools in the public scope.
#publicly_advertisable ⇒ Boolean

Determines if the pool is publicly advertisable.
#source_ipam_pool_id ⇒ String

The ID of the source IPAM pool.
#source_resource ⇒ Types::IpamPoolSourceResourceRequest

The resource used to provision CIDRs to a resource planning pool.
#tag_specifications ⇒ Array<Types::TagSpecification>

The key/value combination of a tag assigned to the resource.

Instance Attribute Details

#address_family ⇒ `String`

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#allocation_default_netmask_length ⇒ `Integer`

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Returns:

(Integer)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#allocation_max_netmask_length ⇒ `Integer`

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

(Integer)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#allocation_min_netmask_length ⇒ `Integer`

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

(Integer)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#allocation_resource_tags ⇒ `Array<Types::RequestIpamResourceTag>`

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Returns:

(Array<Types::RequestIpamResourceTag>)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#auto_import ⇒ `Boolean`

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool’s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

(Boolean)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#aws_service ⇒ `String`

Limits which service in Amazon Web Services that the pool can be used in. “ec2”, for example, allows users to use space for Elastic IP addresses and VPCs.

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description for the IPAM pool.

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

A check for 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 8796

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_scope_id ⇒ `String`

The ID of the scope in which you would like to create the IPAM pool.

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ `String`

The locale for the pool should be one of the following:

An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations ([supported Local Zones]). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM’s home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#public_ip_source ⇒ `String`

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is ‘byoip`. For more information, see [Create IPv6 pools] in the *Amazon VPC IPAM User Guide*. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is `amazon`. For information on increasing the default limit, see [ Quotas for your IPAM] in the *Amazon VPC IPAM User Guide*.

[1]: docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html [2]: docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_advertisable ⇒ `Boolean`

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ‘ipv4`.

Returns:

(Boolean)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#source_ipam_pool_id ⇒ `String`

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool’s CIDR range.

Returns:

(String)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#source_resource ⇒ `Types::IpamPoolSourceResourceRequest`

The resource used to provision CIDRs to a resource planning pool.

Returns:

(Types::IpamPoolSourceResourceRequest)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key ‘Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

Returns:

(Array<Types::TagSpecification>)

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

class CreateIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_scope_id,
  :locale,
  :source_ipam_pool_id,
  :description,
  :address_family,
  :auto_import,
  :publicly_advertisable,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :allocation_resource_tags,
  :tag_specifications,
  :client_token,
  :aws_service,
  :public_ip_source,
  :source_resource)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::CreateIpamPoolRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#address_family ⇒ String

#allocation_default_netmask_length ⇒ Integer

#allocation_max_netmask_length ⇒ Integer

#allocation_min_netmask_length ⇒ Integer

#allocation_resource_tags ⇒ Array<Types::RequestIpamResourceTag>

#auto_import ⇒ Boolean

#aws_service ⇒ String

#client_token ⇒ String

#description ⇒ String

#dry_run ⇒ Boolean

#ipam_scope_id ⇒ String

#locale ⇒ String

#public_ip_source ⇒ String

#publicly_advertisable ⇒ Boolean

#source_ipam_pool_id ⇒ String

#source_resource ⇒ Types::IpamPoolSourceResourceRequest

#tag_specifications ⇒ Array<Types::TagSpecification>

#address_family ⇒ `String`

#allocation_default_netmask_length ⇒ `Integer`

#allocation_max_netmask_length ⇒ `Integer`

#allocation_min_netmask_length ⇒ `Integer`

#allocation_resource_tags ⇒ `Array<Types::RequestIpamResourceTag>`

#auto_import ⇒ `Boolean`

#aws_service ⇒ `String`

#client_token ⇒ `String`

#description ⇒ `String`

#dry_run ⇒ `Boolean`

#ipam_scope_id ⇒ `String`

#locale ⇒ `String`

#public_ip_source ⇒ `String`

#publicly_advertisable ⇒ `Boolean`

#source_ipam_pool_id ⇒ `String`

#source_resource ⇒ `Types::IpamPoolSourceResourceRequest`

#tag_specifications ⇒ `Array<Types::TagSpecification>`