Class: Aws::EC2::Types::ModifyIpamPoolRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_allocation_resource_tags ⇒ Array<Types::RequestIpamResourceTag>

Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.

Returns:



69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  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)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  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. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.

Returns:

  • (Integer)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  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. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.

Returns:

  • (Integer)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#auto_import ⇒ Boolean

If true, 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)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#clear_allocation_default_netmask_length ⇒ Boolean

Clear the default netmask length allocation rule for this pool.

Returns:

  • (Boolean)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the IPAM pool you want to modify.

Returns:

  • (String)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  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)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_pool_id ⇒ String

The ID of the IPAM pool you want to modify.

Returns:

  • (String)


69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#remove_allocation_resource_tags ⇒ Array<Types::RequestIpamResourceTag>

Remove tag allocation rules from a pool.

Returns:



69292
69293
69294
69295
69296
69297
69298
69299
69300
69301
69302
69303
69304
69305
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 69292

class ModifyIpamPoolRequest < Struct.new(
  :dry_run,
  :ipam_pool_id,
  :description,
  :auto_import,
  :allocation_min_netmask_length,
  :allocation_max_netmask_length,
  :allocation_default_netmask_length,
  :clear_allocation_default_netmask_length,
  :add_allocation_resource_tags,
  :remove_allocation_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end