@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
213 lines • 7.57 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Creates and manages Scaleway Instance Private NICs. For more information, see
* the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-private-nics-list-all-private-nics).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const pnic01 = new scaleway.instance.PrivateNic("pnic01", {
* serverId: "fr-par-1/11111111-1111-1111-1111-111111111111",
* privateNetworkId: "fr-par-1/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
* });
* ```
*
* ### With zone
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "private_network_instance",
* region: "fr-par",
* });
* const base = new scaleway.instance.Server("base", {
* image: "ubuntu_jammy",
* type: "DEV1-S",
* zone: pn01.zone,
* });
* const pnic01 = new scaleway.instance.PrivateNic("pnic01", {
* serverId: base.id,
* privateNetworkId: pn01.id,
* zone: pn01.zone,
* });
* ```
*
* ### With IPAM IP IDs
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "vpc_instance"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "private_network_instance",
* ipv4Subnet: {
* subnet: "172.16.64.0/22",
* },
* vpcId: vpc01.id,
* });
* const ip01 = new scaleway.ipam.Ip("ip01", {
* address: "172.16.64.7",
* sources: [{
* privateNetworkId: pn01.id,
* }],
* });
* const server01 = new scaleway.instance.Server("server01", {
* image: "ubuntu_focal",
* type: "PLAY2-MICRO",
* });
* const pnic01 = new scaleway.instance.PrivateNic("pnic01", {
* privateNetworkId: pn01.id,
* serverId: server01.id,
* ipamIpIds: [ip01.id],
* });
* ```
*
* ## Import
*
* Private NICs can be imported using the `{zone}/{server_id}/{private_nic_id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:index/instancePrivateNic:InstancePrivateNic pnic01 fr-par-1/11111111-1111-1111-1111-111111111111/22222222-2222-2222-2222-222222222222
* ```
*
* @deprecated scaleway.index/instanceprivatenic.InstancePrivateNic has been deprecated in favor of scaleway.instance/privatenic.PrivateNic
*/
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>;
/**
* IPAM IDs of a pre-reserved IP addresses to assign to the Instance in the requested private network.
*/
readonly ipamIpIds: pulumi.Output<string[] | undefined>;
/**
* The MAC address of the private NIC.
*/
readonly macAddress: pulumi.Output<string>;
/**
* The list of private IPv4 and IPv6 addresses associated with the resource.
*/
readonly privateIps: pulumi.Output<outputs.InstancePrivateNicPrivateIp[]>;
/**
* 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 | undefined>;
/**
* 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.
*/
/** @deprecated scaleway.index/instanceprivatenic.InstancePrivateNic has been deprecated in favor of scaleway.instance/privatenic.PrivateNic */
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>[] | undefined>;
/**
* IPAM IDs of a pre-reserved IP addresses to assign to the Instance in the requested private network.
*/
ipamIpIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The MAC address of the private NIC.
*/
macAddress?: pulumi.Input<string | undefined>;
/**
* The list of private IPv4 and IPv6 addresses associated with the resource.
*/
privateIps?: pulumi.Input<pulumi.Input<inputs.InstancePrivateNicPrivateIp>[] | undefined>;
/**
* The ID of the private network attached to.
*/
privateNetworkId?: pulumi.Input<string | undefined>;
/**
* The ID of the server associated with.
*/
serverId?: pulumi.Input<string | undefined>;
/**
* The tags associated with the private NIC.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `zone`) The zone in which the server must be created.
*/
zone?: pulumi.Input<string | undefined>;
}
/**
* 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>[] | undefined>;
/**
* IPAM IDs of a pre-reserved IP addresses to assign to the Instance in the requested private network.
*/
ipamIpIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The list of private IPv4 and IPv6 addresses associated with the resource.
*/
privateIps?: pulumi.Input<pulumi.Input<inputs.InstancePrivateNicPrivateIp>[] | undefined>;
/**
* 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>[] | undefined>;
/**
* `zone`) The zone in which the server must be created.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=instancePrivateNic.d.ts.map