Skip to content
v2.278.0

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

VpcCidrOptions Struct ​

Consolidated return parameters to pass to VPC construct.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2_alpha from '@aws-cdk/aws-ec2-alpha';
import * as cdk from 'aws-cdk-lib';

declare const cfnResource: cdk.CfnResource;
declare const ipamPool: ec2_alpha.IIpamPool;
const vpcCidrOptions: ec2_alpha.VpcCidrOptions = {
  amazonProvided: false,
  cidrBlockName: 'cidrBlockName',
  dependencies: [cfnResource],
  ipv4CidrBlock: 'ipv4CidrBlock',
  ipv4IpamPool: ipamPool,
  ipv4IpamProvisionedCidrs: ['ipv4IpamProvisionedCidrs'],
  ipv4NetmaskLength: 123,
  ipv6CidrBlock: 'ipv6CidrBlock',
  ipv6IpamPool: ipamPool,
  ipv6NetmaskLength: 123,
  ipv6PoolId: 'ipv6PoolId',
};
python
# 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_cidr_block="ipv6CidrBlock",
    ipv6_ipam_pool=ipam_pool,
    ipv6_netmask_length=123,
    ipv6_pool_id="ipv6PoolId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.alpha.*;
import software.amazon.awscdk.*;

CfnResource cfnResource;
IIpamPool ipamPool;

VpcCidrOptions vpcCidrOptions = VpcCidrOptions.builder()
        .amazonProvided(false)
        .cidrBlockName("cidrBlockName")
        .dependencies(List.of(cfnResource))
        .ipv4CidrBlock("ipv4CidrBlock")
        .ipv4IpamPool(ipamPool)
        .ipv4IpamProvisionedCidrs(List.of("ipv4IpamProvisionedCidrs"))
        .ipv4NetmaskLength(123)
        .ipv6CidrBlock("ipv6CidrBlock")
        .ipv6IpamPool(ipamPool)
        .ipv6NetmaskLength(123)
        .ipv6PoolId("ipv6PoolId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ec2.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ec2.Alpha;
using Amazon.CDK;

CfnResource cfnResource;
IIpamPool ipamPool;

var vpcCidrOptions = new VpcCidrOptions {
    AmazonProvided = false,
    CidrBlockName = "cidrBlockName",
    Dependencies = new [] { cfnResource },
    Ipv4CidrBlock = "ipv4CidrBlock",
    Ipv4IpamPool = ipamPool,
    Ipv4IpamProvisionedCidrs = new [] { "ipv4IpamProvisionedCidrs" },
    Ipv4NetmaskLength = 123,
    Ipv6CidrBlock = "ipv6CidrBlock",
    Ipv6IpamPool = ipamPool,
    Ipv6NetmaskLength = 123,
    Ipv6PoolId = "ipv6PoolId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsec2alpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import ec2_alpha "github.com/aws/aws-cdk-go/awsec2alpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"

var cfnResource CfnResource
var ipamPool IIpamPool

vpcCidrOptions := &VpcCidrOptions{
	AmazonProvided: jsii.Boolean(false),
	CidrBlockName: jsii.String("cidrBlockName"),
	Dependencies: []CfnResource{
		cfnResource,
	},
	Ipv4CidrBlock: jsii.String("ipv4CidrBlock"),
	Ipv4IpamPool: ipamPool,
	Ipv4IpamProvisionedCidrs: []*string{
		jsii.String("ipv4IpamProvisionedCidrs"),
	},
	Ipv4NetmaskLength: jsii.Number(123),
	Ipv6CidrBlock: jsii.String("ipv6CidrBlock"),
	Ipv6IpamPool: ipamPool,
	Ipv6NetmaskLength: jsii.Number(123),
	Ipv6PoolId: jsii.String("ipv6PoolId"),
}

Properties ​

amazonProvidedoptionalbooleanamazon_providedoptionalboolamazonProvidedoptionalBooleanAmazonProvidedoptionalboolAmazonProvidedoptional*bool = false #
Use amazon provided IP range.
cidrBlockNameoptionalstringcidr_block_nameoptionalstrcidrBlockNameoptionalStringCidrBlockNameoptionalstringCidrBlockNameoptional*string #
Required to set Secondary cidr block resource name in order to generate unique logical id for the resource.

Default: no name for primary addresses

dependenciesoptionalCfnResource[]dependenciesoptionaltyping.List[CfnResource]dependenciesoptionalList<CfnResource>DependenciesoptionalCfnResource[]Dependenciesoptional*[]CfnResource #
Dependency to associate Ipv6 CIDR block.

Default: No dependency

ipv4CidrBlockoptionalstringipv4_cidr_blockoptionalstripv4CidrBlockoptionalStringIpv4CidrBlockoptionalstringIpv4CidrBlockoptional*string = '10.0.0.0/16' #
IPv4 CIDR Block.
ipv4IpamPooloptionalIIpamPoolipv4_ipam_pooloptionalIIpamPoolipv4IpamPooloptionalIIpamPoolIpv4IpamPooloptionalIIpamPoolIpv4IpamPooloptionalIIpamPool #
Ipv4 IPAM Pool.

Default: Only required when using IPAM Ipv4

ipv4IpamProvisionedCidrsoptionalstring[]ipv4_ipam_provisioned_cidrsoptionaltyping.List[str]ipv4IpamProvisionedCidrsoptionalList<String>Ipv4IpamProvisionedCidrsoptionalstring[]Ipv4IpamProvisionedCidrsoptional*[]*string #
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

ipv4NetmaskLengthoptionalnumberipv4_netmask_lengthoptionalint | floatipv4NetmaskLengthoptionalNumberIpv4NetmaskLengthoptionaldoubleIpv4NetmaskLengthoptional*float64 #
CIDR Mask for Vpc.

Default: Only required when using IPAM Ipv4

ipv6CidrBlockoptionalstringipv6_cidr_blockoptionalstripv6CidrBlockoptionalStringIpv6CidrBlockoptionalstringIpv6CidrBlockoptional*string = None #
IPv6 CIDR block from the BOYIP IPv6 address pool.
ipv6IpamPooloptionalIIpamPoolipv6_ipam_pooloptionalIIpamPoolipv6IpamPooloptionalIIpamPoolIpv6IpamPooloptionalIIpamPoolIpv6IpamPooloptionalIIpamPool #
Ipv6 IPAM pool id for VPC range, can only be defined under public scope.

Default: no pool id

ipv6NetmaskLengthoptionalnumberipv6_netmask_lengthoptionalint | floatipv6NetmaskLengthoptionalNumberIpv6NetmaskLengthoptionaldoubleIpv6NetmaskLengthoptional*float64 #
CIDR Mask for Vpc.

Default: Only required when using AWS Ipam

ipv6PoolIdoptionalstringipv6_pool_idoptionalstripv6PoolIdoptionalStringIpv6PoolIdoptionalstringIpv6PoolIdoptional*string = None #
ID of the BYOIP IPv6 address pool from which to allocate the IPv6 CIDR block.