NetworkInterface

Provides an Elastic network interface (ENI) resource.

Create a NetworkInterface Resource

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: CustomResourceOptions);

def NetworkInterface(resource_name, opts=None, attachments=None, description=None, private_ip=None, private_ips=None, private_ips_count=None, security_groups=None, source_dest_check=None, subnet_id=None, tags=None, __props__=None);

func NewNetworkInterface(ctx *Context, name string, args NetworkInterfaceArgs, opts ...ResourceOption) (*NetworkInterface, error)

public NetworkInterface(string name, NetworkInterfaceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NetworkInterface Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NetworkInterface resource accepts the following input properties:

SubnetId string: Subnet ID to create the ENI in.
Attachments List<NetworkInterfaceAttachmentArgs>: Block to define the attachment of the ENI. Documented below.
Description string: A description for the network interface.
PrivateIp string
PrivateIps List<string>: List of private IPs to assign to the ENI.
PrivateIpsCount int: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
SecurityGroups List<string>: List of security group IDs to assign to the ENI.
SourceDestCheck bool: Whether to enable source destination checking for the ENI. Default true.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

SubnetId string: Subnet ID to create the ENI in.
Attachments []NetworkInterfaceAttachmentType: Block to define the attachment of the ENI. Documented below.
Description string: A description for the network interface.
PrivateIp string
PrivateIps []string: List of private IPs to assign to the ENI.
PrivateIpsCount int: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
SecurityGroups []string: List of security group IDs to assign to the ENI.
SourceDestCheck bool: Whether to enable source destination checking for the ENI. Default true.
Tags map[string]string: A map of tags to assign to the resource.

subnetId string: Subnet ID to create the ENI in.
attachments NetworkInterfaceAttachment[]: Block to define the attachment of the ENI. Documented below.
description string: A description for the network interface.
privateIp string
privateIps string[]: List of private IPs to assign to the ENI.
privateIpsCount number: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
securityGroups string[]: List of security group IDs to assign to the ENI.
sourceDestCheck boolean: Whether to enable source destination checking for the ENI. Default true.
tags {[key: string]: string}: A map of tags to assign to the resource.

subnet_id str: Subnet ID to create the ENI in.
attachments List[NetworkInterfaceAttachment]: Block to define the attachment of the ENI. Documented below.
description str: A description for the network interface.
private_ip str
private_ips List[str]: List of private IPs to assign to the ENI.
private_ips_count float: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
security_groups List[str]: List of security group IDs to assign to the ENI.
source_dest_check bool: Whether to enable source destination checking for the ENI. Default true.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkInterface resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
MacAddress string: The MAC address of the network interface.
OutpostArn string
PrivateDnsName string: The private DNS name of the network interface (IPv4).

Id string: The provider-assigned unique ID for this managed resource.
MacAddress string: The MAC address of the network interface.
OutpostArn string
PrivateDnsName string: The private DNS name of the network interface (IPv4).

id string: The provider-assigned unique ID for this managed resource.
macAddress string: The MAC address of the network interface.
outpostArn string
privateDnsName string: The private DNS name of the network interface (IPv4).

id str: The provider-assigned unique ID for this managed resource.
mac_address str: The MAC address of the network interface.
outpost_arn str
private_dns_name str: The private DNS name of the network interface (IPv4).

Look up an Existing NetworkInterface Resource

Get an existing NetworkInterface 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?: NetworkInterfaceState, opts?: CustomResourceOptions): NetworkInterface

static get(resource_name, id, opts=None, attachments=None, description=None, mac_address=None, outpost_arn=None, private_dns_name=None, private_ip=None, private_ips=None, private_ips_count=None, security_groups=None, source_dest_check=None, subnet_id=None, tags=None, __props__=None);

func GetNetworkInterface(ctx *Context, name string, id IDInput, state *NetworkInterfaceState, opts ...ResourceOption) (*NetworkInterface, error)

public static NetworkInterface Get(string name, Input<string> id, NetworkInterfaceState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Attachments List<NetworkInterfaceAttachmentArgs>: Block to define the attachment of the ENI. Documented below.
Description string: A description for the network interface.
MacAddress string: The MAC address of the network interface.
OutpostArn string
PrivateDnsName string: The private DNS name of the network interface (IPv4).
PrivateIp string
PrivateIps List<string>: List of private IPs to assign to the ENI.
PrivateIpsCount int: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
SecurityGroups List<string>: List of security group IDs to assign to the ENI.
SourceDestCheck bool: Whether to enable source destination checking for the ENI. Default true.
SubnetId string: Subnet ID to create the ENI in.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Attachments []NetworkInterfaceAttachmentType: Block to define the attachment of the ENI. Documented below.
Description string: A description for the network interface.
MacAddress string: The MAC address of the network interface.
OutpostArn string
PrivateDnsName string: The private DNS name of the network interface (IPv4).
PrivateIp string
PrivateIps []string: List of private IPs to assign to the ENI.
PrivateIpsCount int: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
SecurityGroups []string: List of security group IDs to assign to the ENI.
SourceDestCheck bool: Whether to enable source destination checking for the ENI. Default true.
SubnetId string: Subnet ID to create the ENI in.
Tags map[string]string: A map of tags to assign to the resource.

attachments NetworkInterfaceAttachment[]: Block to define the attachment of the ENI. Documented below.
description string: A description for the network interface.
macAddress string: The MAC address of the network interface.
outpostArn string
privateDnsName string: The private DNS name of the network interface (IPv4).
privateIp string
privateIps string[]: List of private IPs to assign to the ENI.
privateIpsCount number: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
securityGroups string[]: List of security group IDs to assign to the ENI.
sourceDestCheck boolean: Whether to enable source destination checking for the ENI. Default true.
subnetId string: Subnet ID to create the ENI in.
tags {[key: string]: string}: A map of tags to assign to the resource.

attachments List[NetworkInterfaceAttachment]: Block to define the attachment of the ENI. Documented below.
description str: A description for the network interface.
mac_address str: The MAC address of the network interface.
outpost_arn str
private_dns_name str: The private DNS name of the network interface (IPv4).
private_ip str
private_ips List[str]: List of private IPs to assign to the ENI.
private_ips_count float: Number of secondary private IPs to assign to the ENI. The total number of private IPs will be 1 + private_ips_count, as a primary private IP will be assiged to an ENI by default.
security_groups List[str]: List of security group IDs to assign to the ENI.
source_dest_check bool: Whether to enable source destination checking for the ENI. Default true.
subnet_id str: Subnet ID to create the ENI in.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

NetworkInterfaceAttachment

See the input and output API doc for this type.

DeviceIndex int: Integer to define the devices index.
Instance string: ID of the instance to attach to.
AttachmentId string

DeviceIndex int: Integer to define the devices index.
Instance string: ID of the instance to attach to.
AttachmentId string

deviceIndex number: Integer to define the devices index.
instance string: ID of the instance to attach to.
attachmentId string

device_index float: Integer to define the devices index.
instance str: ID of the instance to attach to.
attachment_id str

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud