@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
177 lines (176 loc) • 6.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class Port extends pulumi.CustomResource {
/**
* Get an existing Port 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?: PortState, opts?: pulumi.CustomResourceOptions): Port;
/**
* Returns true if the given object is an instance of Port. 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 Port;
/**
* UUID of the bond port.
*/
readonly bondId: pulumi.Output<string>;
/**
* Name of the bond port.
*/
readonly bondName: pulumi.Output<string>;
/**
* Whether the port should be bonded.
*/
readonly bonded: pulumi.Output<boolean>;
/**
* Flag indicating whether the port can be removed from a bond.
*/
readonly disbondSupported: pulumi.Output<boolean>;
/**
* Whether to put the port to Layer 2 mode, valid only for bond ports.
*/
readonly layer2: pulumi.Output<boolean | undefined>;
/**
* MAC address of the port.
*/
readonly mac: pulumi.Output<string>;
/**
* Name of the port, e.g. `bond0` or `eth0`.
*/
readonly name: pulumi.Output<string>;
/**
* UUID of a VLAN to assign as a native VLAN. It must be one of attached VLANs (from `vlanIds` parameter).
*/
readonly nativeVlanId: pulumi.Output<string | undefined>;
/**
* One of layer2-bonded, layer2-individual, layer3, hybrid and hybrid-bonded. This attribute is only set on bond ports.
*/
readonly networkType: pulumi.Output<string>;
/**
* ID of the port to read.
*/
readonly portId: pulumi.Output<string>;
/**
* Behavioral setting to reset the port to default settings (layer3 bonded mode without any vlan attached) before delete/destroy.
*/
readonly resetOnDelete: pulumi.Output<boolean | undefined>;
/**
* Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports.
*/
readonly type: pulumi.Output<string>;
/**
* List of VLAN UUIDs to attach to the port, valid only for L2 and Hybrid ports.
*/
readonly vlanIds: pulumi.Output<string[]>;
/**
* List of VXLAN IDs to attach to the port, valid only for L2 and Hybrid ports.
*/
readonly vxlanIds: pulumi.Output<number[]>;
/**
* Create a Port 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: PortArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Port resources.
*/
export interface PortState {
/**
* UUID of the bond port.
*/
bondId?: pulumi.Input<string>;
/**
* Name of the bond port.
*/
bondName?: pulumi.Input<string>;
/**
* Whether the port should be bonded.
*/
bonded?: pulumi.Input<boolean>;
/**
* Flag indicating whether the port can be removed from a bond.
*/
disbondSupported?: pulumi.Input<boolean>;
/**
* Whether to put the port to Layer 2 mode, valid only for bond ports.
*/
layer2?: pulumi.Input<boolean>;
/**
* MAC address of the port.
*/
mac?: pulumi.Input<string>;
/**
* Name of the port, e.g. `bond0` or `eth0`.
*/
name?: pulumi.Input<string>;
/**
* UUID of a VLAN to assign as a native VLAN. It must be one of attached VLANs (from `vlanIds` parameter).
*/
nativeVlanId?: pulumi.Input<string>;
/**
* One of layer2-bonded, layer2-individual, layer3, hybrid and hybrid-bonded. This attribute is only set on bond ports.
*/
networkType?: pulumi.Input<string>;
/**
* ID of the port to read.
*/
portId?: pulumi.Input<string>;
/**
* Behavioral setting to reset the port to default settings (layer3 bonded mode without any vlan attached) before delete/destroy.
*/
resetOnDelete?: pulumi.Input<boolean>;
/**
* Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports.
*/
type?: pulumi.Input<string>;
/**
* List of VLAN UUIDs to attach to the port, valid only for L2 and Hybrid ports.
*/
vlanIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of VXLAN IDs to attach to the port, valid only for L2 and Hybrid ports.
*/
vxlanIds?: pulumi.Input<pulumi.Input<number>[]>;
}
/**
* The set of arguments for constructing a Port resource.
*/
export interface PortArgs {
/**
* Whether the port should be bonded.
*/
bonded: pulumi.Input<boolean>;
/**
* Whether to put the port to Layer 2 mode, valid only for bond ports.
*/
layer2?: pulumi.Input<boolean>;
/**
* UUID of a VLAN to assign as a native VLAN. It must be one of attached VLANs (from `vlanIds` parameter).
*/
nativeVlanId?: pulumi.Input<string>;
/**
* ID of the port to read.
*/
portId: pulumi.Input<string>;
/**
* Behavioral setting to reset the port to default settings (layer3 bonded mode without any vlan attached) before delete/destroy.
*/
resetOnDelete?: pulumi.Input<boolean>;
/**
* List of VLAN UUIDs to attach to the port, valid only for L2 and Hybrid ports.
*/
vlanIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of VXLAN IDs to attach to the port, valid only for L2 and Hybrid ports.
*/
vxlanIds?: pulumi.Input<pulumi.Input<number>[]>;
}