@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
167 lines (166 loc) • 5.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Load Balancer IP addresses.
*
* For more information, see the [main documentation](https://www.scaleway.com/en/docs/load-balancer/how-to/create-manage-flex-ips/) or [API documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-ip-addresses-list-ip-addresses).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const ip = new scaleway.loadbalancers.Ip("ip", {reverse: "my-reverse.com"});
* ```
*
* ### With IPv6
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const ipv6 = new scaleway.loadbalancers.Ip("ipv6", {isIpv6: true});
* ```
*
* ## Import
*
* IPs can be imported using `{zone}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/loadbalancerIp:LoadbalancerIp ip01 fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/loadbalancerip.LoadbalancerIp has been deprecated in favor of scaleway.loadbalancers/ip.Ip
*/
export declare class LoadbalancerIp extends pulumi.CustomResource {
/**
* Get an existing LoadbalancerIp 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?: LoadbalancerIpState, opts?: pulumi.CustomResourceOptions): LoadbalancerIp;
/**
* Returns true if the given object is an instance of LoadbalancerIp. 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 LoadbalancerIp;
/**
* The IP address
*/
readonly ipAddress: pulumi.Output<string>;
/**
* If true, creates a flexible IP with an IPv6 address.
*/
readonly isIpv6: pulumi.Output<boolean | undefined>;
/**
* The associated Load Balancer ID if any
*/
readonly lbId: pulumi.Output<string>;
/**
* The organizationId you want to attach the resource to
*/
readonly organizationId: pulumi.Output<string>;
/**
* `projectId`) The ID of the Project the IP is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The region of the resource
*/
readonly region: pulumi.Output<string>;
/**
* The reverse domain associated with this IP.
*/
readonly reverse: pulumi.Output<string>;
/**
* The tags associated with this IP.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a LoadbalancerIp 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/loadbalancerip.LoadbalancerIp has been deprecated in favor of scaleway.loadbalancers/ip.Ip */
constructor(name: string, args?: LoadbalancerIpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LoadbalancerIp resources.
*/
export interface LoadbalancerIpState {
/**
* The IP address
*/
ipAddress?: pulumi.Input<string>;
/**
* If true, creates a flexible IP with an IPv6 address.
*/
isIpv6?: pulumi.Input<boolean>;
/**
* The associated Load Balancer ID if any
*/
lbId?: pulumi.Input<string>;
/**
* The organizationId you want to attach the resource to
*/
organizationId?: pulumi.Input<string>;
/**
* `projectId`) The ID of the Project the IP is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The region of the resource
*/
region?: pulumi.Input<string>;
/**
* The reverse domain associated with this IP.
*/
reverse?: pulumi.Input<string>;
/**
* The tags associated with this IP.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LoadbalancerIp resource.
*/
export interface LoadbalancerIpArgs {
/**
* If true, creates a flexible IP with an IPv6 address.
*/
isIpv6?: pulumi.Input<boolean>;
/**
* `projectId`) The ID of the Project the IP is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The reverse domain associated with this IP.
*/
reverse?: pulumi.Input<string>;
/**
* The tags associated with this IP.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* `zone`) The zone in which the IP should be reserved.
*/
zone?: pulumi.Input<string>;
}