AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getNetworkInterface

The AWS::EC2::NetworkInterface resource creates network interface

Using getNetworkInterface

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNetworkInterface(args: GetNetworkInterfaceArgs, opts?: InvokeOptions): Promise<GetNetworkInterfaceResult>
function getNetworkInterfaceOutput(args: GetNetworkInterfaceOutputArgs, opts?: InvokeOptions): Output<GetNetworkInterfaceResult>
def get_network_interface(id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNetworkInterfaceResult
def get_network_interface_output(id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNetworkInterfaceResult]
func LookupNetworkInterface(ctx *Context, args *LookupNetworkInterfaceArgs, opts ...InvokeOption) (*LookupNetworkInterfaceResult, error)
func LookupNetworkInterfaceOutput(ctx *Context, args *LookupNetworkInterfaceOutputArgs, opts ...InvokeOption) LookupNetworkInterfaceResultOutput

> Note: This function is named LookupNetworkInterface in the Go SDK.

public static class GetNetworkInterface 
{
    public static Task<GetNetworkInterfaceResult> InvokeAsync(GetNetworkInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkInterfaceResult> Invoke(GetNetworkInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNetworkInterfaceResult> getNetworkInterface(GetNetworkInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:ec2:getNetworkInterface
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Id string

Network interface id.

Id string

Network interface id.

id String

Network interface id.

id string

Network interface id.

id str

Network interface id.

id String

Network interface id.

getNetworkInterface Result

The following output properties are available:

Description string

A description for the network interface.

GroupSet List<string>

A list of security group IDs associated with this network interface.

Id string

Network interface id.

Ipv6AddressCount int

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 List<Pulumi.AwsNative.EC2.Outputs.NetworkInterfaceInstanceIpv6Address>

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.

PrimaryPrivateIpAddress string

Returns the primary private IP address of the network interface.

PrivateIpAddresses List<Pulumi.AwsNative.EC2.Outputs.NetworkInterfacePrivateIpAddressSpecification>

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.

SecondaryPrivateIpAddressCount int

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

SecondaryPrivateIpAddresses List<string>

Returns the secondary private IP addresses of the network interface.

SourceDestCheck bool

Indicates whether traffic to or from the instance is validated.

Tags List<Pulumi.AwsNative.EC2.Outputs.NetworkInterfaceTag>

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

Description string

A description for the network interface.

GroupSet []string

A list of security group IDs associated with this network interface.

Id string

Network interface id.

Ipv6AddressCount int

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 []NetworkInterfaceInstanceIpv6Address

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.

PrimaryPrivateIpAddress string

Returns the primary private IP address of the network interface.

PrivateIpAddresses []NetworkInterfacePrivateIpAddressSpecification

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.

SecondaryPrivateIpAddressCount int

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

SecondaryPrivateIpAddresses []string

Returns the secondary private IP addresses of the network interface.

SourceDestCheck bool

Indicates whether traffic to or from the instance is validated.

Tags []NetworkInterfaceTag

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

description String

A description for the network interface.

groupSet List<String>

A list of security group IDs associated with this network interface.

id String

Network interface id.

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

ipv6Addresses List<NetworkInterfaceInstanceIpv6Address>

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.

primaryPrivateIpAddress String

Returns the primary private IP address of the network interface.

privateIpAddresses List<NetworkInterfacePrivateIpAddressSpecification>

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.

secondaryPrivateIpAddressCount 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

secondaryPrivateIpAddresses List<String>

Returns the secondary private IP addresses of the network interface.

sourceDestCheck Boolean

Indicates whether traffic to or from the instance is validated.

tags List<NetworkInterfaceTag>

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

description string

A description for the network interface.

groupSet string[]

A list of security group IDs associated with this network interface.

id string

Network interface id.

ipv6AddressCount number

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 NetworkInterfaceInstanceIpv6Address[]

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.

primaryPrivateIpAddress string

Returns the primary private IP address of the network interface.

privateIpAddresses NetworkInterfacePrivateIpAddressSpecification[]

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.

secondaryPrivateIpAddressCount number

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

secondaryPrivateIpAddresses string[]

Returns the secondary private IP addresses of the network interface.

sourceDestCheck boolean

Indicates whether traffic to or from the instance is validated.

tags NetworkInterfaceTag[]

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

description str

A description for the network interface.

group_set Sequence[str]

A list of security group IDs associated with this network interface.

id str

Network interface id.

ipv6_address_count int

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.

ipv6_addresses Sequence[NetworkInterfaceInstanceIpv6Address]

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.

primary_private_ip_address str

Returns the primary private IP address of the network interface.

private_ip_addresses Sequence[NetworkInterfacePrivateIpAddressSpecification]

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 int

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

secondary_private_ip_addresses Sequence[str]

Returns the secondary private IP addresses of the network interface.

source_dest_check bool

Indicates whether traffic to or from the instance is validated.

tags Sequence[NetworkInterfaceTag]

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

description String

A description for the network interface.

groupSet List<String>

A list of security group IDs associated with this network interface.

id String

Network interface id.

ipv6AddressCount Number

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 List<Property Map>

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.

primaryPrivateIpAddress String

Returns the primary private IP address of the network interface.

privateIpAddresses List<Property Map>

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.

secondaryPrivateIpAddressCount Number

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

secondaryPrivateIpAddresses List<String>

Returns the secondary private IP addresses of the network interface.

sourceDestCheck Boolean

Indicates whether traffic to or from the instance is validated.

tags List<Property Map>

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

Supporting Types

NetworkInterfaceInstanceIpv6Address

NetworkInterfacePrivateIpAddressSpecification

NetworkInterfaceTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0