@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
151 lines (150 loc) • 5.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Compute Instance IPs. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#ips-268151).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const serverIp = new scaleway.InstanceIp("serverIp", {});
* ```
*
* ## Import
*
* IPs can be imported using the `{zone}/{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/instanceIp:InstanceIp server_ip fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class InstanceIp extends pulumi.CustomResource {
/**
* Get an existing InstanceIp 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?: InstanceIpState, opts?: pulumi.CustomResourceOptions): InstanceIp;
/**
* Returns true if the given object is an instance of InstanceIp. 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 InstanceIp;
/**
* The IP address.
*/
readonly address: pulumi.Output<string>;
/**
* The organization ID the IP is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The IP Prefix.
*/
readonly prefix: pulumi.Output<string>;
/**
* `projectId`) The ID of the project the IP is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The reverse dns attached to this IP
*/
readonly reverse: pulumi.Output<string>;
/**
* The server associated with this IP
*/
readonly serverId: pulumi.Output<string>;
/**
* The tags associated with the IP.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The type of the IP (`nat`, `routedIpv4`, `routedIpv6`), more information in [the documentation](https://www.scaleway.com/en/docs/compute/instances/api-cli/using-routed-ips/)
*
* > **Important:** An IP can migrate from `nat` to `routedIpv4` but cannot be converted back
*/
readonly type: pulumi.Output<string>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a InstanceIp 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?: InstanceIpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstanceIp resources.
*/
export interface InstanceIpState {
/**
* The IP address.
*/
address?: pulumi.Input<string>;
/**
* The organization ID the IP is associated with.
*/
organizationId?: pulumi.Input<string>;
/**
* The IP Prefix.
*/
prefix?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the IP is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The reverse dns attached to this IP
*/
reverse?: pulumi.Input<string>;
/**
* The server associated with this IP
*/
serverId?: pulumi.Input<string>;
/**
* The tags associated with the IP.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the IP (`nat`, `routedIpv4`, `routedIpv6`), more information in [the documentation](https://www.scaleway.com/en/docs/compute/instances/api-cli/using-routed-ips/)
*
* > **Important:** An IP can migrate from `nat` to `routedIpv4` but cannot be converted back
*/
type?: pulumi.Input<string>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstanceIp resource.
*/
export interface InstanceIpArgs {
/**
* `projectId`) The ID of the project the IP is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The tags associated with the IP.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the IP (`nat`, `routedIpv4`, `routedIpv6`), more information in [the documentation](https://www.scaleway.com/en/docs/compute/instances/api-cli/using-routed-ips/)
*
* > **Important:** An IP can migrate from `nat` to `routedIpv4` but cannot be converted back
*/
type?: pulumi.Input<string>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
zone?: pulumi.Input<string>;
}