@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
225 lines (224 loc) • 8.11 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage network interface
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.vpc.NetworkInterface("foo", {
* description: "tf-test-up",
* networkInterfaceName: "tf-test-up",
* portSecurityEnabled: false,
* primaryIpAddress: "192.168.5.253",
* privateIpAddresses: ["192.168.5.2"],
* projectName: "default",
* securityGroupIds: ["sg-2fepz3c793g1s59gp67y21r34"],
* subnetId: "subnet-2fe79j7c8o5c059gp68ksxr93",
* });
* ```
*
* ## Import
*
* Network interface can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:vpc/networkInterface:NetworkInterface default eni-bp1fgnh68xyz9****
* ```
*/
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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceState, 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;
/**
* The description of the ENI.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The number of IPv6 addresses to be automatically assigned from within the CIDR block of the subnet that hosts the ENI. Valid values: 0 to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
readonly ipv6AddressCount: pulumi.Output<number>;
/**
* One or more IPv6 addresses selected from within the CIDR block of the subnet that hosts the ENI. Support up to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
readonly ipv6Addresses: pulumi.Output<string[]>;
/**
* The name of the ENI.
*/
readonly networkInterfaceName: pulumi.Output<string>;
/**
* Set port security enable or disable.
*/
readonly portSecurityEnabled: pulumi.Output<boolean>;
/**
* The primary IP address of the ENI.
*/
readonly primaryIpAddress: pulumi.Output<string>;
/**
* The list of private ip address. This field conflicts with `secondaryPrivateIpAddressCount`.
*/
readonly privateIpAddresses: pulumi.Output<string[]>;
/**
* The ProjectName of the ENI.
*/
readonly projectName: pulumi.Output<string>;
/**
* The count of secondary private ip address. This field conflicts with `privateIpAddress`.
*/
readonly secondaryPrivateIpAddressCount: pulumi.Output<number>;
/**
* The list of the security group id to which the secondary ENI belongs.
*/
readonly securityGroupIds: pulumi.Output<string[]>;
/**
* The status of the ENI.
*/
readonly status: pulumi.Output<string>;
/**
* The id of the subnet to which the ENI is connected.
*/
readonly subnetId: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.vpc.NetworkInterfaceTag[] | undefined>;
/**
* 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);
}
/**
* Input properties used for looking up and filtering NetworkInterface resources.
*/
export interface NetworkInterfaceState {
/**
* The description of the ENI.
*/
description?: pulumi.Input<string>;
/**
* The number of IPv6 addresses to be automatically assigned from within the CIDR block of the subnet that hosts the ENI. Valid values: 0 to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
ipv6AddressCount?: pulumi.Input<number>;
/**
* One or more IPv6 addresses selected from within the CIDR block of the subnet that hosts the ENI. Support up to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
ipv6Addresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the ENI.
*/
networkInterfaceName?: pulumi.Input<string>;
/**
* Set port security enable or disable.
*/
portSecurityEnabled?: pulumi.Input<boolean>;
/**
* The primary IP address of the ENI.
*/
primaryIpAddress?: pulumi.Input<string>;
/**
* The list of private ip address. This field conflicts with `secondaryPrivateIpAddressCount`.
*/
privateIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ProjectName of the ENI.
*/
projectName?: pulumi.Input<string>;
/**
* The count of secondary private ip address. This field conflicts with `privateIpAddress`.
*/
secondaryPrivateIpAddressCount?: pulumi.Input<number>;
/**
* The list of the security group id to which the secondary ENI belongs.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The status of the ENI.
*/
status?: pulumi.Input<string>;
/**
* The id of the subnet to which the ENI is connected.
*/
subnetId?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.vpc.NetworkInterfaceTag>[]>;
}
/**
* The set of arguments for constructing a NetworkInterface resource.
*/
export interface NetworkInterfaceArgs {
/**
* The description of the ENI.
*/
description?: pulumi.Input<string>;
/**
* The number of IPv6 addresses to be automatically assigned from within the CIDR block of the subnet that hosts the ENI. Valid values: 0 to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
ipv6AddressCount?: pulumi.Input<number>;
/**
* One or more IPv6 addresses selected from within the CIDR block of the subnet that hosts the ENI. Support up to 10.
* You cannot specify both the ipv6Addresses and ipv6AddressCount parameters.
*/
ipv6Addresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the ENI.
*/
networkInterfaceName?: pulumi.Input<string>;
/**
* Set port security enable or disable.
*/
portSecurityEnabled?: pulumi.Input<boolean>;
/**
* The primary IP address of the ENI.
*/
primaryIpAddress?: pulumi.Input<string>;
/**
* The list of private ip address. This field conflicts with `secondaryPrivateIpAddressCount`.
*/
privateIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ProjectName of the ENI.
*/
projectName?: pulumi.Input<string>;
/**
* The count of secondary private ip address. This field conflicts with `privateIpAddress`.
*/
secondaryPrivateIpAddressCount?: pulumi.Input<number>;
/**
* The list of the security group id to which the secondary ENI belongs.
*/
securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* The id of the subnet to which the ENI is connected.
*/
subnetId: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.vpc.NetworkInterfaceTag>[]>;
}