@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
200 lines (199 loc) • 7.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Creates and manages Scaleway Load-Balancer Frontends. For more information, see [the documentation](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/#path-frontends).
*
* ## Examples Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const frontend01 = new scaleway.LoadbalancerFrontend("frontend01", {
* lbId: scaleway_lb.lb01.id,
* backendId: scaleway_lb_backend.backend01.id,
* inboundPort: 80,
* });
* ```
*
* ## Import
*
* Load-Balancer frontend can be imported using the `{zone}/{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/loadbalancerFrontend:LoadbalancerFrontend frontend01 fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class LoadbalancerFrontend extends pulumi.CustomResource {
/**
* Get an existing LoadbalancerFrontend 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?: LoadbalancerFrontendState, opts?: pulumi.CustomResourceOptions): LoadbalancerFrontend;
/**
* Returns true if the given object is an instance of LoadbalancerFrontend. 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 LoadbalancerFrontend;
/**
* A list of ACL rules to apply to the load-balancer frontend. Defined below.
*/
readonly acls: pulumi.Output<outputs.LoadbalancerFrontendAcl[] | undefined>;
/**
* The load-balancer backend ID this frontend is attached to.
*
* > **Important:** Updates to `lbId` or `backendId` will recreate the frontend.
*/
readonly backendId: pulumi.Output<string>;
/**
* (Deprecated) first certificate ID used by the frontend.
*
* @deprecated Please use certificate_ids
*/
readonly certificateId: pulumi.Output<string>;
/**
* List of Certificate IDs that should be used by the frontend.
*
* > **Important:** Certificates are not allowed on port 80.
*/
readonly certificateIds: pulumi.Output<string[] | undefined>;
/**
* Activates HTTP/3 protocol.
*/
readonly enableHttp3: pulumi.Output<boolean | undefined>;
/**
* A boolean to specify whether to use lb_acl.
* If `externalAcls` is set to `true`, `acl` can not be set directly in the lb frontend.
*/
readonly externalAcls: pulumi.Output<boolean | undefined>;
/**
* TCP port to listen on the front side.
*/
readonly inboundPort: pulumi.Output<number>;
/**
* The load-balancer ID this frontend is attached to.
*/
readonly lbId: pulumi.Output<string>;
/**
* The ACL name. If not provided it will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* Maximum inactivity time on the client side. (e.g.: `1s`)
*/
readonly timeoutClient: pulumi.Output<string | undefined>;
/**
* Create a LoadbalancerFrontend 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: LoadbalancerFrontendArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LoadbalancerFrontend resources.
*/
export interface LoadbalancerFrontendState {
/**
* A list of ACL rules to apply to the load-balancer frontend. Defined below.
*/
acls?: pulumi.Input<pulumi.Input<inputs.LoadbalancerFrontendAcl>[]>;
/**
* The load-balancer backend ID this frontend is attached to.
*
* > **Important:** Updates to `lbId` or `backendId` will recreate the frontend.
*/
backendId?: pulumi.Input<string>;
/**
* (Deprecated) first certificate ID used by the frontend.
*
* @deprecated Please use certificate_ids
*/
certificateId?: pulumi.Input<string>;
/**
* List of Certificate IDs that should be used by the frontend.
*
* > **Important:** Certificates are not allowed on port 80.
*/
certificateIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Activates HTTP/3 protocol.
*/
enableHttp3?: pulumi.Input<boolean>;
/**
* A boolean to specify whether to use lb_acl.
* If `externalAcls` is set to `true`, `acl` can not be set directly in the lb frontend.
*/
externalAcls?: pulumi.Input<boolean>;
/**
* TCP port to listen on the front side.
*/
inboundPort?: pulumi.Input<number>;
/**
* The load-balancer ID this frontend is attached to.
*/
lbId?: pulumi.Input<string>;
/**
* The ACL name. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string>;
/**
* Maximum inactivity time on the client side. (e.g.: `1s`)
*/
timeoutClient?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LoadbalancerFrontend resource.
*/
export interface LoadbalancerFrontendArgs {
/**
* A list of ACL rules to apply to the load-balancer frontend. Defined below.
*/
acls?: pulumi.Input<pulumi.Input<inputs.LoadbalancerFrontendAcl>[]>;
/**
* The load-balancer backend ID this frontend is attached to.
*
* > **Important:** Updates to `lbId` or `backendId` will recreate the frontend.
*/
backendId: pulumi.Input<string>;
/**
* List of Certificate IDs that should be used by the frontend.
*
* > **Important:** Certificates are not allowed on port 80.
*/
certificateIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Activates HTTP/3 protocol.
*/
enableHttp3?: pulumi.Input<boolean>;
/**
* A boolean to specify whether to use lb_acl.
* If `externalAcls` is set to `true`, `acl` can not be set directly in the lb frontend.
*/
externalAcls?: pulumi.Input<boolean>;
/**
* TCP port to listen on the front side.
*/
inboundPort: pulumi.Input<number>;
/**
* The load-balancer ID this frontend is attached to.
*/
lbId: pulumi.Input<string>;
/**
* The ACL name. If not provided it will be randomly generated.
*/
name?: pulumi.Input<string>;
/**
* Maximum inactivity time on the client side. (e.g.: `1s`)
*/
timeoutClient?: pulumi.Input<string>;
}