@volcengine/pulumi/nlb/serverGroup.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
export declare class ServerGroup extends pulumi.CustomResource {
    /**
     * Get an existing ServerGroup 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?: ServerGroupState, opts?: pulumi.CustomResourceOptions): ServerGroup;
    /**
     * Returns true if the given object is an instance of ServerGroup.  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 ServerGroup;
    /**
     * Whether to enable full port forwarding. Default is false.
     */
    readonly anyPortEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Whether to enable the function of passing through the backend security group. Default is false.
     */
    readonly bypassSecurityGroupEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Whether to enable connection graceful interruption. Default is false.
     */
    readonly connectionDrainEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
     */
    readonly connectionDrainTimeout: pulumi.Output<number | undefined>;
    /**
     * The description of the server group.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The health check config of the server group.
     */
    readonly healthCheck: pulumi.Output<outputs.nlb.ServerGroupHealthCheck>;
    /**
     * The ip address version of the server group. Valid values: `ipv4` (default), `ipv6`.
     */
    readonly ipAddressVersion: pulumi.Output<string | undefined>;
    /**
     * Whether to enable source address retention. Default is true.
     */
    readonly preserveClientIpEnabled: pulumi.Output<boolean | undefined>;
    /**
     * The project name of the server group.
     */
    readonly projectName: pulumi.Output<string | undefined>;
    /**
     * The protocol of the server group. Valid values: `TCP` (default), `UDP`, `TCP_SSL`.
     */
    readonly protocol: pulumi.Output<string | undefined>;
    /**
     * Whether to enable Proxy Protocol. Valid values: `off` (default), `standard`.
     */
    readonly proxyProtocolType: pulumi.Output<string | undefined>;
    /**
     * The scheduling algorithm. Valid values: `wrr` (default), `wlc`, `sh`.
     */
    readonly scheduler: pulumi.Output<string | undefined>;
    /**
     * The server count of the server group.
     */
    readonly serverCount: pulumi.Output<number>;
    /**
     * The name of the server group.
     */
    readonly serverGroupName: pulumi.Output<string>;
    /**
     * The backend servers of the server group.
     */
    readonly servers: pulumi.Output<outputs.nlb.ServerGroupServer[]>;
    /**
     * Whether to enable session persistence. Default is false.
     */
    readonly sessionPersistenceEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
     */
    readonly sessionPersistenceTimeout: pulumi.Output<number | undefined>;
    /**
     * The status of the server group.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Tags.
     */
    readonly tags: pulumi.Output<outputs.nlb.ServerGroupTag[] | undefined>;
    /**
     * Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
     */
    readonly timestampRemoveEnabled: pulumi.Output<boolean | undefined>;
    /**
     * The type of the server group. Valid values: `instance` (default), `ip`.
     */
    readonly type: pulumi.Output<string | undefined>;
    /**
     * The id of the VPC to which the server group belongs.
     */
    readonly vpcId: pulumi.Output<string>;
    /**
     * Create a ServerGroup 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: ServerGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ServerGroup resources.
 */
export interface ServerGroupState {
    /**
     * Whether to enable full port forwarding. Default is false.
     */
    anyPortEnabled?: pulumi.Input<boolean>;
    /**
     * Whether to enable the function of passing through the backend security group. Default is false.
     */
    bypassSecurityGroupEnabled?: pulumi.Input<boolean>;
    /**
     * Whether to enable connection graceful interruption. Default is false.
     */
    connectionDrainEnabled?: pulumi.Input<boolean>;
    /**
     * Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
     */
    connectionDrainTimeout?: pulumi.Input<number>;
    /**
     * The description of the server group.
     */
    description?: pulumi.Input<string>;
    /**
     * The health check config of the server group.
     */
    healthCheck?: pulumi.Input<inputs.nlb.ServerGroupHealthCheck>;
    /**
     * The ip address version of the server group. Valid values: `ipv4` (default), `ipv6`.
     */
    ipAddressVersion?: pulumi.Input<string>;
    /**
     * Whether to enable source address retention. Default is true.
     */
    preserveClientIpEnabled?: pulumi.Input<boolean>;
    /**
     * The project name of the server group.
     */
    projectName?: pulumi.Input<string>;
    /**
     * The protocol of the server group. Valid values: `TCP` (default), `UDP`, `TCP_SSL`.
     */
    protocol?: pulumi.Input<string>;
    /**
     * Whether to enable Proxy Protocol. Valid values: `off` (default), `standard`.
     */
    proxyProtocolType?: pulumi.Input<string>;
    /**
     * The scheduling algorithm. Valid values: `wrr` (default), `wlc`, `sh`.
     */
    scheduler?: pulumi.Input<string>;
    /**
     * The server count of the server group.
     */
    serverCount?: pulumi.Input<number>;
    /**
     * The name of the server group.
     */
    serverGroupName?: pulumi.Input<string>;
    /**
     * The backend servers of the server group.
     */
    servers?: pulumi.Input<pulumi.Input<inputs.nlb.ServerGroupServer>[]>;
    /**
     * Whether to enable session persistence. Default is false.
     */
    sessionPersistenceEnabled?: pulumi.Input<boolean>;
    /**
     * Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
     */
    sessionPersistenceTimeout?: pulumi.Input<number>;
    /**
     * The status of the server group.
     */
    status?: pulumi.Input<string>;
    /**
     * Tags.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.nlb.ServerGroupTag>[]>;
    /**
     * Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
     */
    timestampRemoveEnabled?: pulumi.Input<boolean>;
    /**
     * The type of the server group. Valid values: `instance` (default), `ip`.
     */
    type?: pulumi.Input<string>;
    /**
     * The id of the VPC to which the server group belongs.
     */
    vpcId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ServerGroup resource.
 */
export interface ServerGroupArgs {
    /**
     * Whether to enable full port forwarding. Default is false.
     */
    anyPortEnabled?: pulumi.Input<boolean>;
    /**
     * Whether to enable the function of passing through the backend security group. Default is false.
     */
    bypassSecurityGroupEnabled?: pulumi.Input<boolean>;
    /**
     * Whether to enable connection graceful interruption. Default is false.
     */
    connectionDrainEnabled?: pulumi.Input<boolean>;
    /**
     * Connection graceful interruption timeout. Unit: second. Value range: 0 ~ 900. Default is 0.
     */
    connectionDrainTimeout?: pulumi.Input<number>;
    /**
     * The description of the server group.
     */
    description?: pulumi.Input<string>;
    /**
     * The health check config of the server group.
     */
    healthCheck?: pulumi.Input<inputs.nlb.ServerGroupHealthCheck>;
    /**
     * The ip address version of the server group. Valid values: `ipv4` (default), `ipv6`.
     */
    ipAddressVersion?: pulumi.Input<string>;
    /**
     * Whether to enable source address retention. Default is true.
     */
    preserveClientIpEnabled?: pulumi.Input<boolean>;
    /**
     * The project name of the server group.
     */
    projectName?: pulumi.Input<string>;
    /**
     * The protocol of the server group. Valid values: `TCP` (default), `UDP`, `TCP_SSL`.
     */
    protocol?: pulumi.Input<string>;
    /**
     * Whether to enable Proxy Protocol. Valid values: `off` (default), `standard`.
     */
    proxyProtocolType?: pulumi.Input<string>;
    /**
     * The scheduling algorithm. Valid values: `wrr` (default), `wlc`, `sh`.
     */
    scheduler?: pulumi.Input<string>;
    /**
     * The name of the server group.
     */
    serverGroupName: pulumi.Input<string>;
    /**
     * The backend servers of the server group.
     */
    servers?: pulumi.Input<pulumi.Input<inputs.nlb.ServerGroupServer>[]>;
    /**
     * Whether to enable session persistence. Default is false.
     */
    sessionPersistenceEnabled?: pulumi.Input<boolean>;
    /**
     * Session persistence timeout. Unit: second. Value range: 1 ~ 3600. Default is 1000.
     */
    sessionPersistenceTimeout?: pulumi.Input<number>;
    /**
     * Tags.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.nlb.ServerGroupTag>[]>;
    /**
     * Whether to enable the function of removing the TCP/HTTP/HTTPS packet timestamp. Default is false.
     */
    timestampRemoveEnabled?: pulumi.Input<boolean>;
    /**
     * The type of the server group. Valid values: `instance` (default), `ip`.
     */
    type?: pulumi.Input<string>;
    /**
     * The id of the VPC to which the server group belongs.
     */
    vpcId: pulumi.Input<string>;
}