Struct VpcIpamPoolArgs

pub struct VpcIpamPoolArgs {

    pub address_family: Output<String>,
    pub allocation_default_netmask_length: Output<Option<i32>>,
    pub allocation_max_netmask_length: Output<Option<i32>>,
    pub allocation_min_netmask_length: Output<Option<i32>>,
    pub allocation_resource_tags: Output<Option<HashMap<String, String>>>,
    pub auto_import: Output<Option<bool>>,
    pub aws_service: Output<Option<String>>,
    pub cascade: Output<Option<bool>>,
    pub description: Output<Option<String>>,
    pub ipam_scope_id: Output<String>,
    pub locale: Output<Option<String>>,
    pub public_ip_source: Output<Option<String>>,
    pub publicly_advertisable: Output<Option<bool>>,
    pub source_ipam_pool_id: Output<Option<String>>,
    pub tags: Output<Option<HashMap<String, String>>>,
}

Fields

address_family: Output<String>

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

allocation_default_netmask_length: Output<Option<i32>>

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).

allocation_max_netmask_length: Output<Option<i32>>

The maximum netmask length that will be required for CIDR allocations in this pool.

allocation_min_netmask_length: Output<Option<i32>>

The minimum netmask length that will be required for CIDR allocations in this pool.

allocation_resource_tags: Output<Option<HashMap<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.

auto_import: Output<Option<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.

aws_service: Output<Option<String>>

Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.

cascade: Output<Option<bool>>

Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.

description: Output<Option<String>>

A description for the IPAM pool.

ipam_scope_id: Output<String>

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

locale: Output<Option<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.

public_ip_source: Output<Option<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.

publicly_advertisable: Output<Option<bool>>

Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.

source_ipam_pool_id: Output<Option<String>>

The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.

tags: Output<Option<HashMap<String, String>>>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Implementations

impl VpcIpamPoolArgs

pub fn builder() -> VpcIpamPoolArgsBuilder

Create an instance of VpcIpamPoolArgs using the builder syntax

Trait Implementations

impl Clone for VpcIpamPoolArgs

fn clone(&self) -> VpcIpamPoolArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.