@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
166 lines • 5.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Load Balancer Private Network attachments.
*
* For more information, see the [main documentation](https://www.scaleway.com/en/docs/load-balancer/how-to/use-with-private-network/).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my vpc"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* vpcId: vpc01.id,
* ipv4Subnet: {
* subnet: "172.16.32.0/22",
* },
* });
* const ip01 = new scaleway.ipam.Ip("ip01", {
* address: "172.16.32.7",
* sources: [{
* privateNetworkId: pn01.id,
* }],
* });
* const lb01 = new scaleway.loadbalancers.LoadBalancer("lb01", {
* name: "test-lb-private-network",
* type: "LB-S",
* });
* const lbpn01 = new scaleway.loadbalancers.PrivateNetwork("lbpn01", {
* lbId: lb01.id,
* privateNetworkId: pn01.id,
* ipamIpIds: ip01.id,
* });
* ```
*
* ## Import
*
* Private Network attachments can be imported using `{zone}/{lb-id}/{private-network-id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:loadbalancers/privateNetwork:PrivateNetwork lbpn01 fr-par-1/11111111-1111-1111-1111-111111111111/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class PrivateNetwork extends pulumi.CustomResource {
/**
* Get an existing PrivateNetwork 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?: PrivateNetworkState, opts?: pulumi.CustomResourceOptions): PrivateNetwork;
/**
* Returns true if the given object is an instance of PrivateNetwork. 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 PrivateNetwork;
/**
* The date and time of the creation of the Private Network attachment (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
*/
readonly ipamIpIds: pulumi.Output<string>;
/**
* The load-balancer ID to attach the private network to.
*/
readonly lbId: pulumi.Output<string>;
/**
* The private network ID to attach.
*/
readonly privateNetworkId: pulumi.Output<string>;
/**
* `projectId`) The ID of the Project the Private Network attachment is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The status of the Private Network attachment.
*/
readonly status: pulumi.Output<string>;
/**
* The date and time of the last update of the Private Network attachment (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* `zone`) The zone in which the Private Network should be attached.
*/
readonly zone: pulumi.Output<string | undefined>;
/**
* Create a PrivateNetwork 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: PrivateNetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PrivateNetwork resources.
*/
export interface PrivateNetworkState {
/**
* The date and time of the creation of the Private Network attachment (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
*/
ipamIpIds?: pulumi.Input<string | undefined>;
/**
* The load-balancer ID to attach the private network to.
*/
lbId?: pulumi.Input<string | undefined>;
/**
* The private network ID to attach.
*/
privateNetworkId?: pulumi.Input<string | undefined>;
/**
* `projectId`) The ID of the Project the Private Network attachment is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The status of the Private Network attachment.
*/
status?: pulumi.Input<string | undefined>;
/**
* The date and time of the last update of the Private Network attachment (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* `zone`) The zone in which the Private Network should be attached.
*/
zone?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a PrivateNetwork resource.
*/
export interface PrivateNetworkArgs {
/**
* The IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network.
*/
ipamIpIds?: pulumi.Input<string | undefined>;
/**
* The load-balancer ID to attach the private network to.
*/
lbId: pulumi.Input<string>;
/**
* The private network ID to attach.
*/
privateNetworkId: pulumi.Input<string>;
/**
* `projectId`) The ID of the Project the Private Network attachment is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `zone`) The zone in which the Private Network should be attached.
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=privateNetwork.d.ts.map