class CfnNetworkInterface (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnNetworkInterface`
Java	`software.amazon.awscdk.services.ec2.CfnNetworkInterface`
Python	`aws_cdk.aws_ec2.CfnNetworkInterface`
TypeScript	`@aws-cdk/aws-ec2` » `CfnNetworkInterface`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::EC2::NetworkInterface.

Describes a network interface in an Amazon EC2 instance for AWS CloudFormation .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
const cfnNetworkInterface = new ec2.CfnNetworkInterface(this, 'MyCfnNetworkInterface', {
  subnetId: 'subnetId',

  // the properties below are optional
  description: 'description',
  groupSet: ['groupSet'],
  interfaceType: 'interfaceType',
  ipv6AddressCount: 123,
  ipv6Addresses: [{
    ipv6Address: 'ipv6Address',
  }],
  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 — - scoped id of the resource.
props CfnNetworkInterfaceProps — - resource properties.

Create a new AWS::EC2::NetworkInterface.

Construct Props

Name	Type	Description
subnetId	`string`	The ID of the subnet to associate with the network interface.
description?	`string`	A description for the network interface.
groupSet?	`string[]`	The security group IDs associated with this network interface.
interfaceType?	`string`	The type of network interface.
ipv6AddressCount?	`number`	The number of IPv6 addresses to assign to a network interface.
ipv6Addresses?	`IResolvable` `\|` `IResolvable` `\|` `InstanceIpv6AddressProperty[]`	One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
privateIpAddress?	`string`	Assigns a single private IP address to the network interface, which is used as the primary private IP address.
privateIpAddresses?	`IResolvable` `\|` `IResolvable` `\|` `PrivateIpAddressSpecificationProperty[]`	Assigns private IP addresses to the network interface.
secondaryPrivateIpAddressCount?	`number`	The number of secondary private IPv4 addresses to assign to a network interface.
sourceDestCheck?	`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?	`CfnTag[]`	An arbitrary set of tags (key-value pairs) for this network interface.

subnetId

Type: string

The ID of the subnet to associate with the network interface.

description?

Type: string (optional)

A description for the network interface.

groupSet?

Type: string[] (optional)

The security group IDs 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 .

ipv6AddressCount?

Type: number (optional)

The number of IPv6 addresses to assign to a 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.

ipv6Addresses?

Type: IResolvable | IResolvable | InstanceIpv6AddressProperty[] (optional)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

privateIpAddress?

Type: string (optional)

Assigns a single private IP address to the network interface, which is used as the primary private IP address.

If you want to specify multiple private IP address, use the PrivateIpAddresses property.

privateIpAddresses?

Type: IResolvable | IResolvable | PrivateIpAddressSpecificationProperty[] (optional)

Assigns private IP addresses 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.

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 .

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: CfnTag[] (optional)

An arbitrary set of tags (key-value pairs) for this network interface.

Properties

Name	Type	Description
attrId	`string`	The ID of the network interface.
attrPrimaryPrivateIpAddress	`string`	The primary private IP address of the network interface.
attrSecondaryPrivateIpAddresses	`string[]`	The secondary private IP addresses of the network interface.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
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.
subnetId	`string`	The ID of the subnet to associate with the network interface.
tags	`TagManager`	An arbitrary set of tags (key-value pairs) for this network interface.
description?	`string`	A description for the network interface.
groupSet?	`string[]`	The security group IDs associated with this network interface.
interfaceType?	`string`	The type of network interface.
ipv6AddressCount?	`number`	The number of IPv6 addresses to assign to a network interface.
ipv6Addresses?	`IResolvable` `\|` `IResolvable` `\|` `InstanceIpv6AddressProperty[]`	One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.
privateIpAddress?	`string`	Assigns a single private IP address to the network interface, which is used as the primary private IP address.
privateIpAddresses?	`IResolvable` `\|` `IResolvable` `\|` `PrivateIpAddressSpecificationProperty[]`	Assigns private IP addresses to the network interface.
secondaryPrivateIpAddressCount?	`number`	The number of secondary private IPv4 addresses to assign to a network interface.
sourceDestCheck?	`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.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrId

Type: string

The ID 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"] .

cfnOptions

Type: ICfnResourceOptions

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: ConstructNode

The construct tree node associated with this construct.

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.

description?

Type: string (optional)

A description for the network interface.

groupSet?

Type: string[] (optional)

The security group IDs 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 .

ipv6AddressCount?

Type: number (optional)

The number of IPv6 addresses to assign to a 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.

ipv6Addresses?

Type: IResolvable | IResolvable | InstanceIpv6AddressProperty[] (optional)

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface.

If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.

privateIpAddress?

Type: string (optional)

Assigns a single private IP address to the network interface, which is used as the primary private IP address.

If you want to specify multiple private IP address, use the PrivateIpAddresses property.

privateIpAddresses?

Type: IResolvable | IResolvable | PrivateIpAddressSpecificationProperty[] (optional)

Assigns private IP addresses to the network interface.

secondaryPrivateIpAddressCount?

Type: number (optional)

The number of secondary private IPv4 addresses to assign to 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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

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 RemovalPolicy
options RemovalPolicyOptions

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

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

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

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.

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 }