network_interface

Gets or updates an individual network_interface resource, use network_interfaces to retrieve a list of resources or to create or delete a resource.

Overview

Name	`network_interface`
Type	Resource
Description	The AWS::EC2::NetworkInterface resource creates network interface
Id	`aws.ec2.network_interface`

Fields

Name	Datatype	Description
`description`	`string`	A description for the network interface.
`private_ip_address`	`string`	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.
`private_ip_addresses`	`array`	Assigns a list of 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.
`secondary_private_ip_address_count`	`integer`	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
`primary_private_ip_address`	`string`	Returns the primary private IP address of the network interface.
`ipv4_prefixes`	`array`	Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. 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.
`ipv4_prefix_count`	`integer`	The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. 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.
`group_set`	`array`	A list of security group IDs associated with this network interface.
`ipv6_addresses`	`array`	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.
`ipv6_prefixes`	`array`	Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. 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.
`ipv6_prefix_count`	`integer`	The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. 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.
`subnet_id`	`string`	The ID of the subnet to associate with the network interface.
`source_dest_check`	`boolean`	Indicates whether traffic to or from the instance is validated.
`interface_type`	`string`	Indicates the type of network interface.
`secondary_private_ip_addresses`	`array`	Returns the secondary private IP addresses of the network interface.
`ipv6_address_count`	`integer`	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.
`enable_primary_ipv6`	`boolean`	If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
`primary_ipv6_address`	`string`	The primary IPv6 address
`connection_tracking_specification`	`object`
`id`	`string`	Network interface id.
`tags`	`array`	An arbitrary set of tags (key-value pairs) for this network interface.
`vpc_id`	`string`	The ID of the VPC
`region`	`string`	AWS region.

Methods

Name	Accessible by	Required Params
`update_resource`	`UPDATE`	`data__Identifier, data__PatchDocument, region`
`get_resource`	`SELECT`	`data__Identifier, region`

`SELECT` Example

SELECT
region,
description,
private_ip_address,
private_ip_addresses,
secondary_private_ip_address_count,
primary_private_ip_address,
ipv4_prefixes,
ipv4_prefix_count,
group_set,
ipv6_addresses,
ipv6_prefixes,
ipv6_prefix_count,
subnet_id,
source_dest_check,
interface_type,
secondary_private_ip_addresses,
ipv6_address_count,
enable_primary_ipv6,
primary_ipv6_address,
connection_tracking_specification,
id,
tags,
vpc_id
FROM aws.ec2.network_interface
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

Permissions

To operate on the network_interface resource, the following permissions are required:

Read

ec2:DescribeNetworkInterfaces

Update

ec2:DescribeNetworkInterfaces,
ec2:ModifyNetworkInterfaceAttribute,
ec2:UnassignIpv6Addresses,
ec2:AssignIpv6Addresses,
ec2:DeleteTags,
ec2:CreateTags,
ec2:UnassignPrivateIpAddresses,
ec2:AssignPrivateIpAddresses

Overview​

Fields​

Methods​

SELECT Example​

Permissions​

Read​

Update​