class CfnVPCCidrBlock (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnVPCCidrBlock |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPCCidrBlock |
![]() | software.amazon.awscdk.services.ec2.CfnVPCCidrBlock |
![]() | aws_cdk.aws_ec2.CfnVPCCidrBlock |
![]() | aws-cdk-lib » aws_ec2 » CfnVPCCidrBlock |
Implements
IConstruct
, IDependable
, IInspectable
Associates a CIDR block with your VPC.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
For more information, see VPC CIDR blocks in the Amazon VPC User Guide .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html
Example
import { KubectlV32Layer } from '@aws-cdk/lambda-layer-kubectl-v32';
declare const vpc: ec2.Vpc;
function associateSubnetWithV6Cidr(vpc: ec2.Vpc, count: number, subnet: ec2.ISubnet) {
const cfnSubnet = subnet.node.defaultChild as ec2.CfnSubnet;
cfnSubnet.ipv6CidrBlock = Fn.select(count, Fn.cidr(Fn.select(0, vpc.vpcIpv6CidrBlocks), 256, (128 - 64).toString()));
cfnSubnet.assignIpv6AddressOnCreation = true;
}
// make an ipv6 cidr
const ipv6cidr = new ec2.CfnVPCCidrBlock(this, 'CIDR6', {
vpcId: vpc.vpcId,
amazonProvidedIpv6CidrBlock: true,
});
// connect the ipv6 cidr to all vpc subnets
let subnetcount = 0;
const subnets = vpc.publicSubnets.concat(vpc.privateSubnets);
for (let subnet of subnets) {
// Wait for the ipv6 cidr to complete
subnet.node.addDependency(ipv6cidr);
associateSubnetWithV6Cidr(vpc, subnetcount, subnet);
subnetcount = subnetcount + 1;
}
const cluster = new eks.Cluster(this, 'hello-eks', {
version: eks.KubernetesVersion.V1_32,
vpc: vpc,
ipFamily: eks.IpFamily.IP_V6,
vpcSubnets: [{ subnets: vpc.publicSubnets }],
kubectlLayer: new KubectlV32Layer(this, 'kubectl'),
});
Initializer
new CfnVPCCidrBlock(scope: Construct, id: string, props: CfnVPCCidrBlockProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.VPCCidr Block Props
Construct Props
Name | Type | Description |
---|---|---|
vpc | string | The ID of the VPC. |
amazon | boolean | IResolvable | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. |
cidr | string | An IPv4 CIDR block to associate with the VPC. |
ipv4 | string | Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. |
ipv4 | number | The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. |
ipv6 | string | An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request. |
ipv6 | string | The name of the location from which we advertise the IPV6 CIDR block. |
ipv6 | string | Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. |
ipv6 | number | The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. |
ipv6 | string | The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. |
vpcId
Type:
string
The ID of the VPC.
amazonProvidedIpv6CidrBlock?
Type:
boolean |
IResolvable
(optional)
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.
You cannot specify the range of IPv6 addresses or the size of the CIDR block.
cidrBlock?
Type:
string
(optional)
An IPv4 CIDR block to associate with the VPC.
ipv4IpamPoolId?
Type:
string
(optional)
Associate a CIDR allocated from an IPv4 IPAM pool to a VPC.
For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide .
ipv4NetmaskLength?
Type:
number
(optional)
The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide .
ipv6CidrBlock?
Type:
string
(optional)
An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool
in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
ipv6CidrBlockNetworkBorderGroup?
Type:
string
(optional)
The name of the location from which we advertise the IPV6 CIDR block.
ipv6IpamPoolId?
Type:
string
(optional)
Associates a CIDR allocated from an IPv6 IPAM pool to a VPC.
For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide .
ipv6NetmaskLength?
Type:
number
(optional)
The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide .
ipv6Pool?
Type:
string
(optional)
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Id of the VPC associated CIDR Block. |
attr | string | The source that allocated the IP address space. |
attr | string | Public IPv6 addresses are those advertised on the internet from AWS . |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
vpc | string | The ID of the VPC. |
amazon | boolean | IResolvable | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. |
cidr | string | An IPv4 CIDR block to associate with the VPC. |
ipv4 | string | Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. |
ipv4 | number | The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. |
ipv6 | string | An IPv6 CIDR block from the IPv6 address pool. |
ipv6 | string | The name of the location from which we advertise the IPV6 CIDR block. |
ipv6 | string | Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. |
ipv6 | number | The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. |
ipv6 | string | The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrId
Type:
string
The Id of the VPC associated CIDR Block.
attrIpSource
Type:
string
The source that allocated the IP address space.
byoip
or amazon
indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none
indicates private space.
attrIpv6AddressAttribute
Type:
string
Public IPv6 addresses are those advertised on the internet from AWS .
Private IP addresses are not and cannot be advertised on the internet from AWS .
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
vpcId
Type:
string
The ID of the VPC.
amazonProvidedIpv6CidrBlock?
Type:
boolean |
IResolvable
(optional)
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.
cidrBlock?
Type:
string
(optional)
An IPv4 CIDR block to associate with the VPC.
ipv4IpamPoolId?
Type:
string
(optional)
Associate a CIDR allocated from an IPv4 IPAM pool to a VPC.
ipv4NetmaskLength?
Type:
number
(optional)
The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
ipv6CidrBlock?
Type:
string
(optional)
An IPv6 CIDR block from the IPv6 address pool.
You must also specify Ipv6Pool
in the request.
ipv6CidrBlockNetworkBorderGroup?
Type:
string
(optional)
The name of the location from which we advertise the IPV6 CIDR block.
ipv6IpamPoolId?
Type:
string
(optional)
Associates a CIDR allocated from an IPv6 IPAM pool to a VPC.
ipv6NetmaskLength?
Type:
number
(optional)
The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
ipv6Pool?
Type:
string
(optional)
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }