VpcIpamPoolState class

Input properties used for looking up and filtering VpcIpamPool resources.

Constructors

VpcIpamPoolState({Input<String?>? addressFamily, Input<int?>? allocationDefaultNetmaskLength, Input<int?>? allocationMaxNetmaskLength, Input<int?>? allocationMinNetmaskLength, Input<Map<String, String>?>? allocationResourceTags, Input<String?>? arn, Input<bool?>? autoImport, Input<String?>? awsService, Input<bool?>? cascade, Input<String?>? description, Input<String?>? ipamScopeId, Input<String?>? ipamScopeType, Input<String?>? locale, Input<int?>? poolDepth, Input<String?>? publicIpSource, Input<bool?>? publiclyAdvertisable, Input<String?>? region, Input<String?>? sourceIpamPoolId, Input<VpcIpamPoolSourceResource?>? sourceResource, Input<String?>? state, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new VpcIpamPoolState. addressFamily The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool. allocationDefaultNetmaskLength 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). allocationMaxNetmaskLength The maximum netmask length that will be required for CIDR allocations in this pool. allocationMinNetmaskLength The minimum netmask length that will be required for CIDR allocations in this pool. allocationResourceTags 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. arn ARN of IPAM autoImport If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall awsService Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2. cascade Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools. description A description for the IPAM pool. ipamScopeId The ID of the scope in which you would like to create the IPAM pool. ipamScopeType Optional. locale 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. poolDepth Optional. publicIpSource 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 byoip or amazon. Default is byoip. publiclyAdvertisable Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if addressFamily = "ipv6" and publicIpSource = "byoip", default is false. This option is not available for IPv4 pool space or if publicIpSource = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. sourceIpamPoolId The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool. sourceResource Resource to use to use to configure a resource planning IPAM Pool. If configured, the locale of the parent pool must match the region that the vpc resides in. state The ID of the IPAM tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
const
VpcIpamPoolState.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
arn → Input<String?>?
ARN of IPAM
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
ipamScopeType → Input<String?>?
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
poolDepth → Input<int?>?
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 byoip or amazon. Default is byoip.
final
publiclyAdvertisable → Input<bool?>?
Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if addressFamily = "ipv6" and publicIpSource = "byoip", default is false. This option is not available for IPv4 pool space or if publicIpSource = "amazon". Setting this argument to true when 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 locale of the parent pool must match the region that the vpc resides in.
final
state → Input<String?>?
The ID of the IPAM
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
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