UNPKG

@lbrlabs/pulumi-scaleway

Version:

A Pulumi package for creating and managing scaleway cloud resources.

150 lines (149 loc) 4.95 kB
import * as pulumi from "@pulumi/pulumi"; /** * Creates and manages Scaleway Instance Private NICs. For more information, see * [the documentation](https://developers.scaleway.com/en/products/instance/api/#private-nics-a42eea). * * ## Examples * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const pnic01 = new scaleway.InstancePrivateNic("pnic01", { * privateNetworkId: "fr-par-1/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", * serverId: "fr-par-1/11111111-1111-1111-1111-111111111111", * }); * ``` * * ### With zone * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const pn01 = new scaleway.VpcPrivateNetwork("pn01", {zone: "fr-par-2"}); * const base = new scaleway.InstanceServer("base", { * image: "ubuntu_jammy", * type: "DEV1-S", * zone: pn01.zone, * }); * const pnic01 = new scaleway.InstancePrivateNic("pnic01", { * serverId: base.id, * privateNetworkId: pn01.id, * zone: pn01.zone, * }); * ``` * * ## Import * * Private NICs can be imported using the `{zone}/{server_id}/{private_nic_id}`, e.g. bash * * ```sh * $ pulumi import scaleway:index/instancePrivateNic:InstancePrivateNic pnic01 fr-par-1/11111111-1111-1111-1111-111111111111/22222222-2222-2222-2222-222222222222 * ``` */ export declare class InstancePrivateNic extends pulumi.CustomResource { /** * Get an existing InstancePrivateNic 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?: InstancePrivateNicState, opts?: pulumi.CustomResourceOptions): InstancePrivateNic; /** * Returns true if the given object is an instance of InstancePrivateNic. 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 InstancePrivateNic; /** * IPAM ip list, should be for internal use only */ readonly ipIds: pulumi.Output<string[] | undefined>; /** * The MAC address of the private NIC. */ readonly macAddress: pulumi.Output<string>; /** * The ID of the private network attached to. */ readonly privateNetworkId: pulumi.Output<string>; /** * The ID of the server associated with. */ readonly serverId: pulumi.Output<string>; /** * The tags associated with the private NIC. */ readonly tags: pulumi.Output<string[] | undefined>; /** * `zone`) The zone in which the server must be created. */ readonly zone: pulumi.Output<string>; /** * Create a InstancePrivateNic 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: InstancePrivateNicArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering InstancePrivateNic resources. */ export interface InstancePrivateNicState { /** * IPAM ip list, should be for internal use only */ ipIds?: pulumi.Input<pulumi.Input<string>[]>; /** * The MAC address of the private NIC. */ macAddress?: pulumi.Input<string>; /** * The ID of the private network attached to. */ privateNetworkId?: pulumi.Input<string>; /** * The ID of the server associated with. */ serverId?: pulumi.Input<string>; /** * The tags associated with the private NIC. */ tags?: pulumi.Input<pulumi.Input<string>[]>; /** * `zone`) The zone in which the server must be created. */ zone?: pulumi.Input<string>; } /** * The set of arguments for constructing a InstancePrivateNic resource. */ export interface InstancePrivateNicArgs { /** * IPAM ip list, should be for internal use only */ ipIds?: pulumi.Input<pulumi.Input<string>[]>; /** * The ID of the private network attached to. */ privateNetworkId: pulumi.Input<string>; /** * The ID of the server associated with. */ serverId: pulumi.Input<string>; /** * The tags associated with the private NIC. */ tags?: pulumi.Input<pulumi.Input<string>[]>; /** * `zone`) The zone in which the server must be created. */ zone?: pulumi.Input<string>; }