class CfnNetworkInterface (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnNetworkInterface |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnNetworkInterface |
![]() | software.amazon.awscdk.services.ec2.CfnNetworkInterface |
![]() | aws_cdk.aws_ec2.CfnNetworkInterface |
![]() | aws-cdk-lib » aws_ec2 » CfnNetworkInterface |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnNetworkInterface = new ec2.CfnNetworkInterface(this, 'MyCfnNetworkInterface', {
subnetId: 'subnetId',
// the properties below are optional
connectionTrackingSpecification: {
tcpEstablishedTimeout: 123,
udpStreamTimeout: 123,
udpTimeout: 123,
},
description: 'description',
enablePrimaryIpv6: false,
groupSet: ['groupSet'],
interfaceType: 'interfaceType',
ipv4PrefixCount: 123,
ipv4Prefixes: [{
ipv4Prefix: 'ipv4Prefix',
}],
ipv6AddressCount: 123,
ipv6Addresses: [{
ipv6Address: 'ipv6Address',
}],
ipv6PrefixCount: 123,
ipv6Prefixes: [{
ipv6Prefix: 'ipv6Prefix',
}],
privateIpAddress: 'privateIpAddress',
privateIpAddresses: [{
primary: false,
privateIpAddress: 'privateIpAddress',
}],
secondaryPrivateIpAddressCount: 123,
sourceDestCheck: false,
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnNetworkInterface(scope: Construct, id: string, props: CfnNetworkInterfaceProps)
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.Network Interface Props
Construct Props
Name | Type | Description |
---|---|---|
subnet | string | The ID of the subnet to associate with the network interface. |
connection | IResolvable | Connection | A connection tracking specification for the network interface. |
description? | string | A description for the network interface. |
enable | boolean | IResolvable | If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. |
group | string[] | The IDs of the security groups associated with this network interface. |
interface | string | The type of network interface. |
ipv4 | number | The number of IPv4 prefixes to be automatically assigned to the network interface. |
ipv4 | IResolvable | IResolvable | Ipv4 [] | The IPv4 delegated prefixes that are assigned to the network interface. |
ipv6 | number | The number of IPv6 addresses to assign to the network interface. |
ipv6 | IResolvable | IResolvable | Instance [] | The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface. |
ipv6 | number | The number of IPv6 prefixes to be automatically assigned to the network interface. |
ipv6 | IResolvable | IResolvable | Ipv6 [] | The IPv6 delegated prefixes that are assigned to the network interface. |
private | string | The private IPv4 address to assign to the network interface as the primary private IP address. |
private | IResolvable | IResolvable | Private [] | The private IPv4 addresses to assign to the network interface. |
secondary | number | The number of secondary private IPv4 addresses to assign to a network interface. |
source | boolean | IResolvable | Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. |
tags? | Cfn [] | The tags to apply to the network interface. |
subnetId
Type:
string
The ID of the subnet to associate with the network interface.
connectionTrackingSpecification?
Type:
IResolvable
|
Connection
(optional)
A connection tracking specification for the network interface.
description?
Type:
string
(optional)
A description for the network interface.
enablePrimaryIpv6?
Type:
boolean |
IResolvable
(optional)
If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address.
A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
groupSet?
Type:
string[]
(optional)
The IDs of the security groups associated with this network interface.
interfaceType?
Type:
string
(optional)
The type of network interface.
The default is interface
. The supported values are efa
and trunk
.
ipv4PrefixCount?
Type:
number
(optional)
The number of IPv4 prefixes to be automatically assigned to the network interface.
When creating a network interface, you can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv4Prefixes?
Type:
IResolvable
|
IResolvable
|
Ipv4
[]
(optional)
The IPv4 delegated prefixes that are assigned to the network interface.
When creating a network interface, you can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
ipv6AddressCount?
Type:
number
(optional)
The number of IPv6 addresses to assign to the network interface.
Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses
property and don't specify this property.
When creating a network interface, you can't specify a count of IPv6 addresses if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
ipv6Addresses?
Type:
IResolvable
|
IResolvable
|
Instance
[]
(optional)
The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.
If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount
property and don't specify this property.
When creating a network interface, you can't specify IPv6 addresses if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
ipv6PrefixCount?
Type:
number
(optional)
The number of IPv6 prefixes to be automatically assigned to the network interface.
When creating a network interface, you can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
ipv6Prefixes?
Type:
IResolvable
|
IResolvable
|
Ipv6
[]
(optional)
The IPv6 delegated prefixes that are assigned to the network interface.
When creating a network interface, you can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.
privateIpAddress?
Type:
string
(optional)
The private IPv4 address to assign to the network interface as the primary private IP address.
If you want to specify multiple private IP addresses, use the PrivateIpAddresses
property.
privateIpAddresses?
Type:
IResolvable
|
IResolvable
|
Private
[]
(optional)
The private IPv4 addresses to assign to the network interface.
You can specify a primary private IP address by setting the value of the Primary
property to true
in the PrivateIpAddressSpecification
property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount
property and do not specify this property.
When creating a network interface, you can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
secondaryPrivateIpAddressCount?
Type:
number
(optional)
The number of secondary private IPv4 addresses to assign to a network interface.
When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
.
When creating a Network Interface, you can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
sourceDestCheck?
Type:
boolean |
IResolvable
(optional)
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
tags?
Type:
Cfn
[]
(optional)
The tags to apply to the network interface.
Properties
Name | Type | Description |
---|---|---|
attr | string | The ID of the network interface. |
attr | string | The primary IPv6 address of the network interface. |
attr | string | The primary private IP address of the network interface. |
attr | string[] | The secondary private IP addresses of the network interface. |
attr | string | The ID of the VPC. |
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. |
subnet | string | The ID of the subnet to associate with the network interface. |
tags | Tag | Tag Manager which manages the tags for this resource. |
connection | IResolvable | Connection | A connection tracking specification for the network interface. |
description? | string | A description for the network interface. |
enable | boolean | IResolvable | If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. |
group | string[] | The IDs of the security groups associated with this network interface. |
interface | string | The type of network interface. |
ipv4 | number | The number of IPv4 prefixes to be automatically assigned to the network interface. |
ipv4 | IResolvable | IResolvable | Ipv4 [] | The IPv4 delegated prefixes that are assigned to the network interface. |
ipv6 | number | The number of IPv6 addresses to assign to the network interface. |
ipv6 | IResolvable | IResolvable | Instance [] | The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface. |
ipv6 | number | The number of IPv6 prefixes to be automatically assigned to the network interface. |
ipv6 | IResolvable | IResolvable | Ipv6 [] | The IPv6 delegated prefixes that are assigned to the network interface. |
private | string | The private IPv4 address to assign to the network interface as the primary private IP address. |
private | IResolvable | IResolvable | Private [] | The private IPv4 addresses to assign to the network interface. |
secondary | number | The number of secondary private IPv4 addresses to assign to a network interface. |
source | boolean | IResolvable | Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. |
tags | Cfn [] | The tags to apply to the network interface. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrId
Type:
string
The ID of the network interface.
attrPrimaryIpv6Address
Type:
string
The primary IPv6 address of the network interface.
attrPrimaryPrivateIpAddress
Type:
string
The primary private IP address of the network interface.
For example, 10.0.0.192
.
attrSecondaryPrivateIpAddresses
Type:
string[]
The secondary private IP addresses of the network interface.
For example, ["10.0.0.161", "10.0.0.162", "10.0.0.163"]
.
attrVpcId
Type:
string
The ID of the VPC.
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).
subnetId
Type:
string
The ID of the subnet to associate with the network interface.
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
connectionTrackingSpecification?
Type:
IResolvable
|
Connection
(optional)
A connection tracking specification for the network interface.
description?
Type:
string
(optional)
A description for the network interface.
enablePrimaryIpv6?
Type:
boolean |
IResolvable
(optional)
If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address.
groupSet?
Type:
string[]
(optional)
The IDs of the security groups associated with this network interface.
interfaceType?
Type:
string
(optional)
The type of network interface.
ipv4PrefixCount?
Type:
number
(optional)
The number of IPv4 prefixes to be automatically assigned to the network interface.
ipv4Prefixes?
Type:
IResolvable
|
IResolvable
|
Ipv4
[]
(optional)
The IPv4 delegated prefixes that are assigned to the network interface.
ipv6AddressCount?
Type:
number
(optional)
The number of IPv6 addresses to assign to the network interface.
ipv6Addresses?
Type:
IResolvable
|
IResolvable
|
Instance
[]
(optional)
The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.
ipv6PrefixCount?
Type:
number
(optional)
The number of IPv6 prefixes to be automatically assigned to the network interface.
ipv6Prefixes?
Type:
IResolvable
|
IResolvable
|
Ipv6
[]
(optional)
The IPv6 delegated prefixes that are assigned to the network interface.
privateIpAddress?
Type:
string
(optional)
The private IPv4 address to assign to the network interface as the primary private IP address.
privateIpAddresses?
Type:
IResolvable
|
IResolvable
|
Private
[]
(optional)
The private IPv4 addresses to assign to the network interface.
secondaryPrivateIpAddressCount?
Type:
number
(optional)
The number of secondary private IPv4 addresses to assign to a network interface.
sourceDestCheck?
Type:
boolean |
IResolvable
(optional)
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
tagsRaw?
Type:
Cfn
[]
(optional)
The tags to apply to the network interface.
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 }