published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
A network interface is a virtual network interface. In a private network, it serves as a network interface attached to cloud servers, load balancers, and other cloud resources. Each network interface has a primary private IP address. You can manually assign multiple auxiliary private IP addresses if needed.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
eniDemo:
type: volcenginecc:vpc:Eni
name: EniDemo
properties:
networkInterfaceName: EniDemo
subnetId: vpc_subnet-xxxx
securityGroupIds:
- vpc_security_group-xxxx
instanceId: i-ye498lwge85i3z3kxxxx
projectName: default
primaryIpAddress:
private_ip_address: 192.168.x.130
associated_elastic_ip:
allocationId: eip-2f80zqjduo6ps4f4pzzcxxxxx
secondaryPrivateIpAddressCount: 2
tags:
- key: env
value: test
Create Eni Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Eni(name: string, args?: EniArgs, opts?: CustomResourceOptions);@overload
def Eni(resource_name: str,
args: Optional[EniArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Eni(resource_name: str,
opts: Optional[ResourceOptions] = None,
delete_on_termination: Optional[bool] = None,
description: Optional[str] = None,
instance_id: Optional[str] = None,
ipv6_address_count: Optional[int] = None,
ipv6_sets: Optional[Sequence[str]] = None,
network_interface_name: Optional[str] = None,
port_security_enabled: Optional[bool] = None,
primary_ip_address: Optional[EniPrimaryIpAddressArgs] = None,
private_ip_sets: Optional[Sequence[EniPrivateIpSetArgs]] = None,
project_name: Optional[str] = None,
secondary_private_ip_address_count: Optional[int] = None,
security_group_ids: Optional[Sequence[str]] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[EniTagArgs]] = None)func NewEni(ctx *Context, name string, args *EniArgs, opts ...ResourceOption) (*Eni, error)public Eni(string name, EniArgs? args = null, CustomResourceOptions? opts = null)type: volcenginecc:vpc:Eni
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EniArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EniArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EniArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EniArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EniArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Eni Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Eni resource accepts the following input properties:
- Delete
On boolTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- Description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- Instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- Ipv6Address
Count int - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- Ipv6Sets List<string>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- Network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- Port
Security boolEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- Primary
Ip Volcengine.Address Eni Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- Private
Ip List<Volcengine.Sets Eni Private Ip Set> - Project
Name string - Name of the project to which the NIC belongs
- Secondary
Private intIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- Security
Group List<string>Ids - ID of one or more security groups joined by the auxiliary network interface.
- Subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
List<Volcengine.
Eni Tag>
- Delete
On boolTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- Description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- Instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- Ipv6Address
Count int - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- Ipv6Sets []string
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- Network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- Port
Security boolEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- Primary
Ip EniAddress Primary Ip Address Args - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- Private
Ip []EniSets Private Ip Set Args - Project
Name string - Name of the project to which the NIC belongs
- Secondary
Private intIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- Security
Group []stringIds - ID of one or more security groups joined by the auxiliary network interface.
- Subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
[]Eni
Tag Args
- delete
On BooleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description String
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id String - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count Integer - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets List<String>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- network
Interface StringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security BooleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip EniAddress Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip List<EniSets Private Ip Set> - project
Name String - Name of the project to which the NIC belongs
- secondary
Private IntegerIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group List<String>Ids - ID of one or more security groups joined by the auxiliary network interface.
- subnet
Id String - ID of the subnet where the auxiliary network interface resides.
-
List<Eni
Tag>
- delete
On booleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count number - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets string[]
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security booleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip EniAddress Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip EniSets Private Ip Set[] - project
Name string - Name of the project to which the NIC belongs
- secondary
Private numberIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group string[]Ids - ID of one or more security groups joined by the auxiliary network interface.
- subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
Eni
Tag[]
- delete_
on_ booltermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description str
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance_
id str - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6_
address_ intcount - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6_
sets Sequence[str] - IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- network_
interface_ strname - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port_
security_ boolenabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary_
ip_ Eniaddress Primary Ip Address Args - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private_
ip_ Sequence[Enisets Private Ip Set Args] - project_
name str - Name of the project to which the NIC belongs
- secondary_
private_ intip_ address_ count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security_
group_ Sequence[str]ids - ID of one or more security groups joined by the auxiliary network interface.
- subnet_
id str - ID of the subnet where the auxiliary network interface resides.
-
Sequence[Eni
Tag Args]
- delete
On BooleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description String
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id String - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count Number - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets List<String>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- network
Interface StringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security BooleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip Property MapAddress - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip List<Property Map>Sets - project
Name String - Name of the project to which the NIC belongs
- secondary
Private NumberIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group List<String>Ids - ID of one or more security groups joined by the auxiliary network interface.
- subnet
Id String - ID of the subnet where the auxiliary network interface resides.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Eni resource produces the following output properties:
- Account
Id string - NIC owner ID
- Created
Time string - NIC creation time
- Id string
- The provider-assigned unique ID for this managed resource.
- Mac
Address string - MAC address of the network interface.
- Network
Interface stringId - Network interface ID.
- Service
Managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- Status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- Type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- Updated
Time string - NIC update time
- Vpc
Id string - ID of the VPC to which the network interface belongs.
- Vpc
Name string - Name of the VPC to which the NIC belongs
- Zone
Id string - ID of the availability zone to which the network interface belongs.
- Account
Id string - NIC owner ID
- Created
Time string - NIC creation time
- Id string
- The provider-assigned unique ID for this managed resource.
- Mac
Address string - MAC address of the network interface.
- Network
Interface stringId - Network interface ID.
- Service
Managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- Status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- Type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- Updated
Time string - NIC update time
- Vpc
Id string - ID of the VPC to which the network interface belongs.
- Vpc
Name string - Name of the VPC to which the NIC belongs
- Zone
Id string - ID of the availability zone to which the network interface belongs.
- account
Id String - NIC owner ID
- created
Time String - NIC creation time
- id String
- The provider-assigned unique ID for this managed resource.
- mac
Address String - MAC address of the network interface.
- network
Interface StringId - Network interface ID.
- service
Managed Boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status String
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- type String
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time String - NIC update time
- vpc
Id String - ID of the VPC to which the network interface belongs.
- vpc
Name String - Name of the VPC to which the NIC belongs
- zone
Id String - ID of the availability zone to which the network interface belongs.
- account
Id string - NIC owner ID
- created
Time string - NIC creation time
- id string
- The provider-assigned unique ID for this managed resource.
- mac
Address string - MAC address of the network interface.
- network
Interface stringId - Network interface ID.
- service
Managed boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time string - NIC update time
- vpc
Id string - ID of the VPC to which the network interface belongs.
- vpc
Name string - Name of the VPC to which the NIC belongs
- zone
Id string - ID of the availability zone to which the network interface belongs.
- account_
id str - NIC owner ID
- created_
time str - NIC creation time
- id str
- The provider-assigned unique ID for this managed resource.
- mac_
address str - MAC address of the network interface.
- network_
interface_ strid - Network interface ID.
- service_
managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- status str
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- type str
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated_
time str - NIC update time
- vpc_
id str - ID of the VPC to which the network interface belongs.
- vpc_
name str - Name of the VPC to which the NIC belongs
- zone_
id str - ID of the availability zone to which the network interface belongs.
- account
Id String - NIC owner ID
- created
Time String - NIC creation time
- id String
- The provider-assigned unique ID for this managed resource.
- mac
Address String - MAC address of the network interface.
- network
Interface StringId - Network interface ID.
- service
Managed Boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status String
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- type String
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time String - NIC update time
- vpc
Id String - ID of the VPC to which the network interface belongs.
- vpc
Name String - Name of the VPC to which the NIC belongs
- zone
Id String - ID of the availability zone to which the network interface belongs.
Look up Existing Eni Resource
Get an existing Eni resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EniState, opts?: CustomResourceOptions): Eni@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
created_time: Optional[str] = None,
delete_on_termination: Optional[bool] = None,
description: Optional[str] = None,
instance_id: Optional[str] = None,
ipv6_address_count: Optional[int] = None,
ipv6_sets: Optional[Sequence[str]] = None,
mac_address: Optional[str] = None,
network_interface_id: Optional[str] = None,
network_interface_name: Optional[str] = None,
port_security_enabled: Optional[bool] = None,
primary_ip_address: Optional[EniPrimaryIpAddressArgs] = None,
private_ip_sets: Optional[Sequence[EniPrivateIpSetArgs]] = None,
project_name: Optional[str] = None,
secondary_private_ip_address_count: Optional[int] = None,
security_group_ids: Optional[Sequence[str]] = None,
service_managed: Optional[bool] = None,
status: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[EniTagArgs]] = None,
type: Optional[str] = None,
updated_time: Optional[str] = None,
vpc_id: Optional[str] = None,
vpc_name: Optional[str] = None,
zone_id: Optional[str] = None) -> Enifunc GetEni(ctx *Context, name string, id IDInput, state *EniState, opts ...ResourceOption) (*Eni, error)public static Eni Get(string name, Input<string> id, EniState? state, CustomResourceOptions? opts = null)public static Eni get(String name, Output<String> id, EniState state, CustomResourceOptions options)resources: _: type: volcenginecc:vpc:Eni get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - NIC owner ID
- Created
Time string - NIC creation time
- Delete
On boolTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- Description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- Instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- Ipv6Address
Count int - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- Ipv6Sets List<string>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- Mac
Address string - MAC address of the network interface.
- Network
Interface stringId - Network interface ID.
- Network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- Port
Security boolEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- Primary
Ip Volcengine.Address Eni Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- Private
Ip List<Volcengine.Sets Eni Private Ip Set> - Project
Name string - Name of the project to which the NIC belongs
- Secondary
Private intIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- Security
Group List<string>Ids - ID of one or more security groups joined by the auxiliary network interface.
- Service
Managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- Status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- Subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
List<Volcengine.
Eni Tag> - Type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- Updated
Time string - NIC update time
- Vpc
Id string - ID of the VPC to which the network interface belongs.
- Vpc
Name string - Name of the VPC to which the NIC belongs
- Zone
Id string - ID of the availability zone to which the network interface belongs.
- Account
Id string - NIC owner ID
- Created
Time string - NIC creation time
- Delete
On boolTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- Description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- Instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- Ipv6Address
Count int - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- Ipv6Sets []string
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- Mac
Address string - MAC address of the network interface.
- Network
Interface stringId - Network interface ID.
- Network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- Port
Security boolEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- Primary
Ip EniAddress Primary Ip Address Args - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- Private
Ip []EniSets Private Ip Set Args - Project
Name string - Name of the project to which the NIC belongs
- Secondary
Private intIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- Security
Group []stringIds - ID of one or more security groups joined by the auxiliary network interface.
- Service
Managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- Status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- Subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
[]Eni
Tag Args - Type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- Updated
Time string - NIC update time
- Vpc
Id string - ID of the VPC to which the network interface belongs.
- Vpc
Name string - Name of the VPC to which the NIC belongs
- Zone
Id string - ID of the availability zone to which the network interface belongs.
- account
Id String - NIC owner ID
- created
Time String - NIC creation time
- delete
On BooleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description String
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id String - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count Integer - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets List<String>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- mac
Address String - MAC address of the network interface.
- network
Interface StringId - Network interface ID.
- network
Interface StringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security BooleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip EniAddress Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip List<EniSets Private Ip Set> - project
Name String - Name of the project to which the NIC belongs
- secondary
Private IntegerIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group List<String>Ids - ID of one or more security groups joined by the auxiliary network interface.
- service
Managed Boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status String
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- subnet
Id String - ID of the subnet where the auxiliary network interface resides.
-
List<Eni
Tag> - type String
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time String - NIC update time
- vpc
Id String - ID of the VPC to which the network interface belongs.
- vpc
Name String - Name of the VPC to which the NIC belongs
- zone
Id String - ID of the availability zone to which the network interface belongs.
- account
Id string - NIC owner ID
- created
Time string - NIC creation time
- delete
On booleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description string
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id string - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count number - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets string[]
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- mac
Address string - MAC address of the network interface.
- network
Interface stringId - Network interface ID.
- network
Interface stringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security booleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip EniAddress Primary Ip Address - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip EniSets Private Ip Set[] - project
Name string - Name of the project to which the NIC belongs
- secondary
Private numberIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group string[]Ids - ID of one or more security groups joined by the auxiliary network interface.
- service
Managed boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status string
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- subnet
Id string - ID of the subnet where the auxiliary network interface resides.
-
Eni
Tag[] - type string
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time string - NIC update time
- vpc
Id string - ID of the VPC to which the network interface belongs.
- vpc
Name string - Name of the VPC to which the NIC belongs
- zone
Id string - ID of the availability zone to which the network interface belongs.
- account_
id str - NIC owner ID
- created_
time str - NIC creation time
- delete_
on_ booltermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description str
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance_
id str - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6_
address_ intcount - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6_
sets Sequence[str] - IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- mac_
address str - MAC address of the network interface.
- network_
interface_ strid - Network interface ID.
- network_
interface_ strname - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port_
security_ boolenabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary_
ip_ Eniaddress Primary Ip Address Args - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private_
ip_ Sequence[Enisets Private Ip Set Args] - project_
name str - Name of the project to which the NIC belongs
- secondary_
private_ intip_ address_ count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security_
group_ Sequence[str]ids - ID of one or more security groups joined by the auxiliary network interface.
- service_
managed bool - Indicates whether this is an official service network interface. true for yes, false for no.
- status str
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- subnet_
id str - ID of the subnet where the auxiliary network interface resides.
-
Sequence[Eni
Tag Args] - type str
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated_
time str - NIC update time
- vpc_
id str - ID of the VPC to which the network interface belongs.
- vpc_
name str - Name of the VPC to which the NIC belongs
- zone_
id str - ID of the availability zone to which the network interface belongs.
- account
Id String - NIC owner ID
- created
Time String - NIC creation time
- delete
On BooleanTermination - Enable release with cloud server instance deletion. true to enable, false to disable
- description String
- Description for the auxiliary network interface. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Allowed characters include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). If not specified, defaults to an empty string.
- instance
Id String - ID of the instance bound to the NIC. If the NIC is not attached or the ServiceManaged parameter is true, InstanceId returns empty
- ipv6Address
Count Number - Number of private IPv6 addresses assigned to the network interface. When this parameter is specified, the system automatically assigns the corresponding number of available private IPv6 addresses from the subnet to which the network interface belongs. Cannot be used together with IPv6Sets during creation.
- ipv6Sets List<String>
- IPv6 address list of the network interface, for example [2408::153:3921:XX:XX:7b12:1c5f, 2408:4008:2cf:XX:XX:dd1e:2a22:5ddf].
- mac
Address String - MAC address of the network interface.
- network
Interface StringId - Network interface ID.
- network
Interface StringName - NIC name. Length must be between 1 and 128 characters, starting with a letter, Chinese character, or number. Can include periods (.), underscores (_), and hyphens (-). If not specified, defaults to the ID of the secondary NIC
- port
Security BooleanEnabled - Enable source/destination address check for the NIC. When enabled, the system automatically blocks traffic whose source or destination address does not match the current NIC. true to enable, false to disable (default)
- primary
Ip Property MapAddress - Primary private IPv4 address of the network interface. Address modification is not supported, but you can modify the public IP. If specified, it must be an available private IPv4 address in the corresponding subnet. If not specified, an available private IPv4 address will be automatically assigned from the corresponding subnet. For example: 192.XX.XX.10.
- private
Ip List<Property Map>Sets - project
Name String - Name of the project to which the NIC belongs
- secondary
Private NumberIp Address Count - Number of auxiliary private IPv4 addresses automatically assigned to the auxiliary network interface. Value range: 1–49. Cannot be used together with PrivateIpSets during creation.
- security
Group List<String>Ids - ID of one or more security groups joined by the auxiliary network interface.
- service
Managed Boolean - Indicates whether this is an official service network interface. true for yes, false for no.
- status String
- Binding status of the network interface. Creating: In progress. Available: Not attached. Attaching: In progress. InUse: Attached. Detaching: In progress. Deleting: In progress.
- subnet
Id String - ID of the subnet where the auxiliary network interface resides.
- List<Property Map>
- type String
- NIC type. primary: primary NIC, secondary: secondary NIC
- updated
Time String - NIC update time
- vpc
Id String - ID of the VPC to which the network interface belongs.
- vpc
Name String - Name of the VPC to which the NIC belongs
- zone
Id String - ID of the availability zone to which the network interface belongs.
Supporting Types
EniPrimaryIpAddress, EniPrimaryIpAddressArgs
- Associated
Elastic Volcengine.Ip Eni Primary Ip Address Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- Primary bool
- Indicates whether this is the primary private IPv4 address.
- Private
Ip stringAddress - Private IP address of the network interface.
- Associated
Elastic EniIp Primary Ip Address Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- Primary bool
- Indicates whether this is the primary private IPv4 address.
- Private
Ip stringAddress - Private IP address of the network interface.
- associated
Elastic EniIp Primary Ip Address Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- primary Boolean
- Indicates whether this is the primary private IPv4 address.
- private
Ip StringAddress - Private IP address of the network interface.
- associated
Elastic EniIp Primary Ip Address Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- primary boolean
- Indicates whether this is the primary private IPv4 address.
- private
Ip stringAddress - Private IP address of the network interface.
- associated_
elastic_ Eniip Primary Ip Address Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- primary bool
- Indicates whether this is the primary private IPv4 address.
- private_
ip_ straddress - Private IP address of the network interface.
- associated
Elastic Property MapIp - Information about the public IP associated with the primary private IPv4 address of the network interface.
- primary Boolean
- Indicates whether this is the primary private IPv4 address.
- private
Ip StringAddress - Private IP address of the network interface.
EniPrimaryIpAddressAssociatedElasticIp, EniPrimaryIpAddressAssociatedElasticIpArgs
- Allocation
Id string - Public IP ID
- Eip
Address string - Public IP address
- Release
With boolInstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
- Allocation
Id string - Public IP ID
- Eip
Address string - Public IP address
- Release
With boolInstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
- allocation
Id String - Public IP ID
- eip
Address String - Public IP address
- release
With BooleanInstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
- allocation
Id string - Public IP ID
- eip
Address string - Public IP address
- release
With booleanInstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
- allocation_
id str - Public IP ID
- eip_
address str - Public IP address
- release_
with_ boolinstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
- allocation
Id String - Public IP ID
- eip
Address String - Public IP address
- release
With BooleanInstance - Whether the public IP is released when the cloud server instance is deleted. Only pay-as-you-go public IPs bound to the primary NIC's primary private IP are valid. When enabled, if the cloud server instance is automatically reclaimed by the system (24 hours after unsubscription, upon expiration, or due to overdue payment) or deleted via the DeleteInstances API, the public IP is released along with the instance. true: yes, false: no
EniPrivateIpSet, EniPrivateIpSetArgs
- Associated
Elastic Volcengine.Ip Eni Private Ip Set Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- Private
Ip stringAddress - Private IP address of the network interface.
- Associated
Elastic EniIp Private Ip Set Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- Private
Ip stringAddress - Private IP address of the network interface.
- associated
Elastic EniIp Private Ip Set Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- private
Ip StringAddress - Private IP address of the network interface.
- associated
Elastic EniIp Private Ip Set Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- private
Ip stringAddress - Private IP address of the network interface.
- associated_
elastic_ Eniip Private Ip Set Associated Elastic Ip - Information about the public IP associated with the primary private IPv4 address of the network interface.
- private_
ip_ straddress - Private IP address of the network interface.
- associated
Elastic Property MapIp - Information about the public IP associated with the primary private IPv4 address of the network interface.
- private
Ip StringAddress - Private IP address of the network interface.
EniPrivateIpSetAssociatedElasticIp, EniPrivateIpSetAssociatedElasticIpArgs
- Allocation
Id string - Public IP ID
- Allocation
Id string - Public IP ID
- allocation
Id String - Public IP ID
- allocation
Id string - Public IP ID
- allocation_
id str - Public IP ID
- allocation
Id String - Public IP ID
EniTag, EniTagArgs
Import
$ pulumi import volcenginecc:vpc/eni:Eni example "network_interface_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
