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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_familyString

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

Returns:

  • (String)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_lengthInteger

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_lengthInteger

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_lengthInteger

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_tagsArray<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:



8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_importBoolean

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_serviceString

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_tokenString

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/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

  • (String)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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

#descriptionString

A description for the IPAM pool.

Returns:

  • (String)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_runBoolean

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_idString

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

Returns:

  • (String)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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

#localeString

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. 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, such as us-east-1.

Returns:

  • (String)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_sourceString

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_advertisableBoolean

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

Returns:

  • (Boolean)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_idString

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)


8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_resourceTypes::IpamPoolSourceResourceRequest

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



8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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_specificationsArray<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:



8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
# File 'lib/aws-sdk-ec2/types.rb', line 8570

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