VpcIpamPoolArgs class
The set of arguments for VpcIpamPool. The set of arguments for VpcIpamPool.
Constructors
-
VpcIpamPoolArgs({required Input<
String> addressFamily, Input<int?> ? allocationDefaultNetmaskLength, Input<int?> ? allocationMaxNetmaskLength, Input<int?> ? allocationMinNetmaskLength, Input<Map< ? allocationResourceTags, Input<String, String> ?>bool?> ? autoImport, Input<String?> ? awsService, Input<bool?> ? cascade, Input<String?> ? description, required Input<String> ipamScopeId, Input<String?> ? locale, Input<String?> ? publicIpSource, Input<bool?> ? publiclyAdvertisable, Input<String?> ? region, Input<String?> ? sourceIpamPoolId, Input<VpcIpamPoolSourceResource?> ? sourceResource, Input<Map< ? tags})String, String> ?> -
Creates a new VpcIpamPoolArgs.
addressFamilyThe IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.allocationDefaultNetmaskLengthA 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 (unless you provide a different netmask value when you create the new allocation).allocationMaxNetmaskLengthThe maximum netmask length that will be required for CIDR allocations in this pool.allocationMinNetmaskLengthThe minimum netmask length that will be required for CIDR allocations in this pool.allocationResourceTagsTags 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.autoImportIf you include this argument, IPAM automatically imports any VPCs you have in your scope that fallawsServiceLimits which AWS service the pool can be used in. Only useable on public scopes. Valid Values:ec2.cascadeEnables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.descriptionA description for the IPAM pool.ipamScopeIdThe ID of the scope in which you would like to create the IPAM pool.localeThe locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such asus-east-1.publicIpSourceThe IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values arebyoiporamazon. Default isbyoip.publiclyAdvertisableDefines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required ifaddressFamily = "ipv6"andpublicIpSource = "byoip", default isfalse. This option is not available for IPv4 pool space or ifpublicIpSource = "amazon". Setting this argument totruewhen it is not available may result in erroneous differences being reported.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sourceIpamPoolIdThe ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.sourceResourceResource to use to use to configure a resource planning IPAM Pool. If configured, thelocaleof the parent pool must match the region that the vpc resides in.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.const -
VpcIpamPoolArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
addressFamily
→ Input<
String> -
The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
final
-
allocationDefaultNetmaskLength
→ Input<
int?> ? -
A 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 (unless you provide a different netmask value when you create the new allocation).
final
-
allocationMaxNetmaskLength
→ Input<
int?> ? -
The maximum netmask length that will be required for CIDR allocations in this pool.
final
-
allocationMinNetmaskLength
→ Input<
int?> ? -
The minimum netmask length that will be required for CIDR allocations in this pool.
final
-
allocationResourceTags
→ Input<
Map< ?String, String> ?> -
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.
final
-
autoImport
→ Input<
bool?> ? -
If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall
within the CIDR range in the pool.
final
-
awsService
→ Input<
String?> ? -
Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values:
ec2.final -
cascade
→ Input<
bool?> ? -
Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
final
-
description
→ Input<
String?> ? -
A description for the IPAM pool.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
ipamScopeId
→ Input<
String> -
The ID of the scope in which you would like to create the IPAM pool.
final
-
locale
→ Input<
String?> ? -
The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as
us-east-1.final -
publicIpSource
→ Input<
String?> ? -
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are
byoiporamazon. Default isbyoip.final -
publiclyAdvertisable
→ Input<
bool?> ? -
Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if
addressFamily = "ipv6"andpublicIpSource = "byoip", default isfalse. This option is not available for IPv4 pool space or ifpublicIpSource = "amazon". Setting this argument totruewhen it is not available may result in erroneous differences being reported.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceIpamPoolId
→ Input<
String?> ? -
The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
final
-
sourceResource
→ Input<
VpcIpamPoolSourceResource?> ? -
Resource to use to use to configure a resource planning IPAM Pool. If configured, the
localeof the parent pool must match the region that the vpc resides in.final -
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited