@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
192 lines (191 loc) • 13.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The AWS::EC2::NetworkInterface resource creates network interface
*/
export declare class NetworkInterface extends pulumi.CustomResource {
/**
* Get an existing NetworkInterface resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): NetworkInterface;
/**
* Returns true if the given object is an instance of NetworkInterface. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NetworkInterface;
/**
* Network interface id.
*/
readonly awsId: pulumi.Output<string>;
/**
* A connection tracking specification for the network interface.
*/
readonly connectionTrackingSpecification: pulumi.Output<outputs.ec2.NetworkInterfaceConnectionTrackingSpecification | undefined>;
/**
* A description for the network interface.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly enablePrimaryIpv6: pulumi.Output<boolean | undefined>;
/**
* A list of security group IDs associated with this network interface.
*/
readonly groupSet: pulumi.Output<string[] | undefined>;
/**
* Indicates the type of network interface.
*/
readonly interfaceType: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly ipv4PrefixCount: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly ipv4Prefixes: pulumi.Output<outputs.ec2.NetworkInterfaceIpv4PrefixSpecification[] | undefined>;
/**
* 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.
*/
readonly ipv6AddressCount: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly ipv6Addresses: pulumi.Output<outputs.ec2.NetworkInterfaceInstanceIpv6Address[] | undefined>;
/**
* 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.
*/
readonly ipv6PrefixCount: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly ipv6Prefixes: pulumi.Output<outputs.ec2.NetworkInterfaceIpv6PrefixSpecification[] | undefined>;
/**
* The primary IPv6 address
*/
readonly primaryIpv6Address: pulumi.Output<string>;
/**
* Returns the primary private IP address of the network interface.
*/
readonly primaryPrivateIpAddress: pulumi.Output<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.
*/
readonly privateIpAddress: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly privateIpAddresses: pulumi.Output<outputs.ec2.NetworkInterfacePrivateIpAddressSpecification[] | undefined>;
/**
* 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
*/
readonly secondaryPrivateIpAddressCount: pulumi.Output<number | undefined>;
/**
* Returns the secondary private IP addresses of the network interface.
*/
readonly secondaryPrivateIpAddresses: pulumi.Output<string[]>;
/**
* Indicates whether traffic to or from the instance is validated.
*/
readonly sourceDestCheck: pulumi.Output<boolean | undefined>;
/**
* The ID of the subnet to associate with the network interface.
*/
readonly subnetId: pulumi.Output<string>;
/**
* An arbitrary set of tags (key-value pairs) for this network interface.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The ID of the VPC
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a NetworkInterface resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NetworkInterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a NetworkInterface resource.
*/
export interface NetworkInterfaceArgs {
/**
* A connection tracking specification for the network interface.
*/
connectionTrackingSpecification?: pulumi.Input<inputs.ec2.NetworkInterfaceConnectionTrackingSpecificationArgs>;
/**
* A description for the network interface.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
enablePrimaryIpv6?: pulumi.Input<boolean>;
/**
* A list of security group IDs associated with this network interface.
*/
groupSet?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Indicates the type of network interface.
*/
interfaceType?: pulumi.Input<string>;
/**
* 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.
*/
ipv4PrefixCount?: pulumi.Input<number>;
/**
* 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.
*/
ipv4Prefixes?: pulumi.Input<pulumi.Input<inputs.ec2.NetworkInterfaceIpv4PrefixSpecificationArgs>[]>;
/**
* 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.
*/
ipv6AddressCount?: pulumi.Input<number>;
/**
* 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.
*/
ipv6Addresses?: pulumi.Input<pulumi.Input<inputs.ec2.NetworkInterfaceInstanceIpv6AddressArgs>[]>;
/**
* 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.
*/
ipv6PrefixCount?: pulumi.Input<number>;
/**
* 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.
*/
ipv6Prefixes?: pulumi.Input<pulumi.Input<inputs.ec2.NetworkInterfaceIpv6PrefixSpecificationArgs>[]>;
/**
* 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.
*/
privateIpAddress?: pulumi.Input<string>;
/**
* 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.
*/
privateIpAddresses?: pulumi.Input<pulumi.Input<inputs.ec2.NetworkInterfacePrivateIpAddressSpecificationArgs>[]>;
/**
* 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
*/
secondaryPrivateIpAddressCount?: pulumi.Input<number>;
/**
* Indicates whether traffic to or from the instance is validated.
*/
sourceDestCheck?: pulumi.Input<boolean>;
/**
* The ID of the subnet to associate with the network interface.
*/
subnetId: pulumi.Input<string>;
/**
* An arbitrary set of tags (key-value pairs) for this network interface.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}