Package software.amazon.awscdk.services.ec2

Interface CfnNetworkInterfaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNetworkInterfaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:34.959Z")
@Stability(Stable)
public interface CfnNetworkInterfaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnNetworkInterface.

Example:

 // 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.*;
 CfnNetworkInterfaceProps cfnNetworkInterfaceProps = CfnNetworkInterfaceProps.builder()
         .subnetId("subnetId")
         // the properties below are optional
         .connectionTrackingSpecification(ConnectionTrackingSpecificationProperty.builder()
                 .tcpEstablishedTimeout(123)
                 .udpStreamTimeout(123)
                 .udpTimeout(123)
                 .build())
         .description("description")
         .enablePrimaryIpv6(false)
         .groupSet(List.of("groupSet"))
         .interfaceType("interfaceType")
         .ipv4PrefixCount(123)
         .ipv4Prefixes(List.of(Ipv4PrefixSpecificationProperty.builder()
                 .ipv4Prefix("ipv4Prefix")
                 .build()))
         .ipv6AddressCount(123)
         .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                 .ipv6Address("ipv6Address")
                 .build()))
         .ipv6PrefixCount(123)
         .ipv6Prefixes(List.of(Ipv6PrefixSpecificationProperty.builder()
                 .ipv6Prefix("ipv6Prefix")
                 .build()))
         .privateIpAddress("privateIpAddress")
         .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                 .primary(false)
                 .privateIpAddress("privateIpAddress")
                 .build()))
         .secondaryPrivateIpAddressCount(123)
         .sourceDestCheck(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnNetworkInterfaceProps.Builder	A builder for CfnNetworkInterfaceProps
static final class	CfnNetworkInterfaceProps.Jsii$Proxy	An implementation for CfnNetworkInterfaceProps

Method Summary

Modifier and Type	Method	Description
static CfnNetworkInterfaceProps.Builder	builder()
default Object	getConnectionTrackingSpecification()	A connection tracking specification for the network interface.
default String	getDescription()	A description for the network interface.
default Object	getEnablePrimaryIpv6()	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.
default List<Object>	getGroupSet()	The IDs of the security groups associated with this network interface.
default String	getInterfaceType()	The type of network interface.
default Number	getIpv4PrefixCount()	The number of IPv4 prefixes to be automatically assigned to the network interface.
default Object	getIpv4Prefixes()	The IPv4 delegated prefixes that are assigned to the network interface.
default Number	getIpv6AddressCount()	The number of IPv6 addresses to assign to the network interface.
default Object	getIpv6Addresses()	The IPv6 addresses from the IPv6 CIDR block range of your subnet to assign to the network interface.
default Number	getIpv6PrefixCount()	The number of IPv6 prefixes to be automatically assigned to the network interface.
default Object	getIpv6Prefixes()	The IPv6 delegated prefixes that are assigned to the network interface.
default String	getPrivateIpAddress()	The private IPv4 address to assign to the network interface as the primary private IP address.
default Object	getPrivateIpAddresses()	The private IPv4 addresses to assign to the network interface.
default Number	getSecondaryPrivateIpAddressCount()	The number of secondary private IPv4 addresses to assign to a network interface.
default Object	getSourceDestCheck()	Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
Object	getSubnetId()	The ID of the subnet to associate with the network interface.
default List<CfnTag>	getTags()	The tags to apply to the network interface.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSubnetId

@Stability(Stable)
@NotNull
Object getSubnetId()

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

Returns union: either String or ISubnetRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-subnetid

getConnectionTrackingSpecification

@Stability(Stable)
@Nullable
default Object getConnectionTrackingSpecification()

A connection tracking specification for the network interface.

Returns union: either IResolvable or CfnNetworkInterface.ConnectionTrackingSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-connectiontrackingspecification

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the network interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-description

getEnablePrimaryIpv6

@Stability(Stable)
@Nullable
default Object getEnablePrimaryIpv6()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-enableprimaryipv6

getGroupSet

@Stability(Stable)
@Nullable
default List<Object> getGroupSet()

The IDs of the security groups associated with this network interface.

Returns union: Listinvalid input: '<'either String or ISecurityGroupRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-groupset

getInterfaceType

@Stability(Stable)
@Nullable
default String getInterfaceType()

The type of network interface.

The default is interface . The supported values are efa and trunk .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-interfacetype

getIpv4PrefixCount

@Stability(Stable)
@Nullable
default Number getIpv4PrefixCount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixcount

getIpv4Prefixes

@Stability(Stable)
@Nullable
default Object getIpv4Prefixes()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetworkInterface.Ipv4PrefixSpecificationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv4prefixes

getIpv6AddressCount

@Stability(Stable)
@Nullable
default Number getIpv6AddressCount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresscount

getIpv6Addresses

@Stability(Stable)
@Nullable
default Object getIpv6Addresses()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetworkInterface.InstanceIpv6AddressProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6addresses

getIpv6PrefixCount

@Stability(Stable)
@Nullable
default Number getIpv6PrefixCount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixcount

getIpv6Prefixes

@Stability(Stable)
@Nullable
default Object getIpv6Prefixes()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetworkInterface.Ipv6PrefixSpecificationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-ipv6prefixes

getPrivateIpAddress

@Stability(Stable)
@Nullable
default String getPrivateIpAddress()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddress

getPrivateIpAddresses

@Stability(Stable)
@Nullable
default Object getPrivateIpAddresses()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnNetworkInterface.PrivateIpAddressSpecificationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-privateipaddresses

getSecondaryPrivateIpAddressCount

@Stability(Stable)
@Nullable
default Number getSecondaryPrivateIpAddressCount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-secondaryprivateipaddresscount

getSourceDestCheck

@Stability(Stable)
@Nullable
default Object getSourceDestCheck()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-sourcedestcheck

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to apply to the network interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinterface.html#cfn-ec2-networkinterface-tags

builder

@Stability(Stable)
static CfnNetworkInterfaceProps.Builder builder()

Returns:

a CfnNetworkInterfaceProps.Builder of CfnNetworkInterfaceProps