@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
162 lines (161 loc) • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to get information about a Network Interface.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const bar = aws.ec2.getNetworkInterface({
* id: "eni-01234567",
* });
* ```
*/
export declare function getNetworkInterface(args?: GetNetworkInterfaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkInterfaceResult>;
/**
* A collection of arguments for invoking getNetworkInterface.
*/
export interface GetNetworkInterfaceArgs {
/**
* One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference.
*/
filters?: inputs.ec2.GetNetworkInterfaceFilter[];
/**
* Identifier for the network interface.
*/
id?: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Any tags assigned to the network interface.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getNetworkInterface.
*/
export interface GetNetworkInterfaceResult {
/**
* ARN of the network interface.
*/
readonly arn: string;
/**
* Association information for an Elastic IP address (IPv4) associated with the network interface. See association below.
*/
readonly associations: outputs.ec2.GetNetworkInterfaceAssociation[];
/**
* Attachment of the ENI. See attachment below.
*/
readonly attachments: outputs.ec2.GetNetworkInterfaceAttachment[];
/**
* Availability Zone.
*/
readonly availabilityZone: string;
/**
* Description of the network interface.
*/
readonly description: string;
readonly filters?: outputs.ec2.GetNetworkInterfaceFilter[];
readonly id: string;
/**
* Type of interface.
*/
readonly interfaceType: string;
/**
* List of IPv6 addresses to assign to the ENI.
*/
readonly ipv6Addresses: string[];
/**
* MAC address.
*/
readonly macAddress: string;
/**
* ARN of the Outpost.
*/
readonly outpostArn: string;
/**
* AWS account ID of the owner of the network interface.
*/
readonly ownerId: string;
/**
* Private DNS name.
*/
readonly privateDnsName: string;
/**
* Private IPv4 address of the network interface within the subnet.
*/
readonly privateIp: string;
/**
* Private IPv4 addresses associated with the network interface.
*/
readonly privateIps: string[];
readonly region: string;
/**
* ID of the entity that launched the instance on your behalf.
*/
readonly requesterId: string;
/**
* List of security groups for the network interface.
*/
readonly securityGroups: string[];
/**
* ID of the subnet.
*/
readonly subnetId: string;
/**
* Any tags assigned to the network interface.
*/
readonly tags: {
[key: string]: string;
};
/**
* ID of the VPC.
*/
readonly vpcId: string;
}
/**
* Use this data source to get information about a Network Interface.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const bar = aws.ec2.getNetworkInterface({
* id: "eni-01234567",
* });
* ```
*/
export declare function getNetworkInterfaceOutput(args?: GetNetworkInterfaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkInterfaceResult>;
/**
* A collection of arguments for invoking getNetworkInterface.
*/
export interface GetNetworkInterfaceOutputArgs {
/**
* One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetNetworkInterfaceFilterArgs>[]>;
/**
* Identifier for the network interface.
*/
id?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Any tags assigned to the network interface.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}