VpcCidrOptions

class aws_cdk.aws_ec2_alpha.VpcCidrOptions(*, amazon_provided=None, cidr_block_name=None, dependencies=None, ipv4_cidr_block=None, ipv4_ipam_pool=None, ipv4_ipam_provisioned_cidrs=None, ipv4_netmask_length=None, ipv6_ipam_pool=None, ipv6_netmask_length=None)

Bases: object

(experimental) Consolidated return parameters to pass to VPC construct.

Parameters:

  • amazon_provided (Optional[bool]) – (experimental) Use amazon provided IP range. Default: false

  • cidr_block_name (Optional[str]) – (experimental) Required to set Secondary cidr block resource name in order to generate unique logical id for the resource. Default: - no name for primary addresses

  • dependencies (Optional[Sequence[CfnResource]]) – (experimental) Dependency to associate Ipv6 CIDR block. Default: - No dependency

  • ipv4_cidr_block (Optional[str]) – (experimental) IPv4 CIDR Block. Default: ‘10.0.0.0/16’

  • ipv4_ipam_pool (Optional[IIpamPool]) – (experimental) Ipv4 IPAM Pool. Default: - Only required when using IPAM Ipv4

  • ipv4_ipam_provisioned_cidrs (Optional[Sequence[str]]) – (experimental) IPv4 CIDR provisioned under pool Required to check for overlapping CIDRs after provisioning is complete under IPAM pool. Default: - no IPAM IPv4 CIDR range is provisioned using IPAM

  • ipv4_netmask_length (Union[int, float, None]) – (experimental) CIDR Mask for Vpc. Default: - Only required when using IPAM Ipv4

  • ipv6_ipam_pool (Optional[IIpamPool]) – (experimental) Ipv6 IPAM pool id for VPC range, can only be defined under public scope. Default: - no pool id

  • ipv6_netmask_length (Union[int, float, None]) – (experimental) CIDR Mask for Vpc. Default: - Only required when using AWS Ipam

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2_alpha as ec2_alpha
import aws_cdk as cdk

# cfn_resource: cdk.CfnResource
# ipam_pool: ec2_alpha.IIpamPool

vpc_cidr_options = ec2_alpha.VpcCidrOptions(
    amazon_provided=False,
    cidr_block_name="cidrBlockName",
    dependencies=[cfn_resource],
    ipv4_cidr_block="ipv4CidrBlock",
    ipv4_ipam_pool=ipam_pool,
    ipv4_ipam_provisioned_cidrs=["ipv4IpamProvisionedCidrs"],
    ipv4_netmask_length=123,
    ipv6_ipam_pool=ipam_pool,
    ipv6_netmask_length=123
)

Attributes

amazon_provided

(experimental) Use amazon provided IP range.

Default:

false

Stability:

experimental

cidr_block_name

(experimental) Required to set Secondary cidr block resource name in order to generate unique logical id for the resource.

Default:

  • no name for primary addresses

Stability:

experimental

dependencies

(experimental) Dependency to associate Ipv6 CIDR block.

Default:

  • No dependency

Stability:

experimental

ipv4_cidr_block

(experimental) IPv4 CIDR Block.

Default:

‘10.0.0.0/16’

Stability:

experimental

ipv4_ipam_pool

(experimental) Ipv4 IPAM Pool.

Default:

  • Only required when using IPAM Ipv4

Stability:

experimental

ipv4_ipam_provisioned_cidrs

(experimental) IPv4 CIDR provisioned under pool Required to check for overlapping CIDRs after provisioning is complete under IPAM pool.

Default:

  • no IPAM IPv4 CIDR range is provisioned using IPAM

Stability:

experimental

ipv4_netmask_length

(experimental) CIDR Mask for Vpc.

Default:

  • Only required when using IPAM Ipv4

Stability:

experimental

ipv6_ipam_pool

(experimental) Ipv6 IPAM pool id for VPC range, can only be defined under public scope.

Default:

  • no pool id

Stability:

experimental

ipv6_netmask_length

(experimental) CIDR Mask for Vpc.

Default:

  • Only required when using AWS Ipam

Stability:

experimental