@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
339 lines (338 loc) • 11.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
export declare class NetworkLoadBalancer extends pulumi.CustomResource {
/**
* Get an existing NetworkLoadBalancer 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?: NetworkLoadBalancerState, opts?: pulumi.CustomResourceOptions): NetworkLoadBalancer;
/**
* Returns true if the given object is an instance of NetworkLoadBalancer. 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 NetworkLoadBalancer;
/**
* The access log configuration of the NLB instance.
*/
readonly accessLogConfig: pulumi.Output<outputs.nlb.NetworkLoadBalancerAccessLogConfig | undefined>;
/**
* The account ID of the NLB instance.
*/
readonly accountId: pulumi.Output<string>;
/**
* The billing status of the NLB instance.
*/
readonly billingStatus: pulumi.Output<string>;
/**
* The creation time of the NLB instance.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether to enable cross-zone load balancing for the NLB instance. Valid values: `true`, `false`. `true`: Enable.
* `false`: Disable.
*/
readonly crossZoneEnabled: pulumi.Output<boolean>;
/**
* The description of the NLB instance.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The DNS name of the NLB instance.
*/
readonly dnsName: pulumi.Output<string>;
/**
* The expected overdue time of the NLB instance.
*/
readonly expectedOverdueTime: pulumi.Output<string>;
/**
* The IP address version of the NLB instance. Valid values: `ipv4`, `dualstack`. `ipv4`: The NLB instance supports IPv4.
* `dualstack`: The NLB instance supports both IPv4 and IPv6.
*/
readonly ipAddressVersion: pulumi.Output<string | undefined>;
/**
* The ID of the IPv4 bandwidth package.
*/
readonly ipv4BandwidthPackageId: pulumi.Output<string | undefined>;
/**
* The IPv4 network type of the NLB instance.
*/
readonly ipv4NetworkType: pulumi.Output<string>;
/**
* The ID of the IPv6 bandwidth package.
*/
readonly ipv6BandwidthPackageId: pulumi.Output<string | undefined>;
/**
* The IPv6 network type of the NLB instance.
*/
readonly ipv6NetworkType: pulumi.Output<string>;
/**
* The name of the NLB instance.
*/
readonly loadBalancerName: pulumi.Output<string>;
/**
* The managed security group ID of the NLB instance.
*/
readonly managedSecurityGroupId: pulumi.Output<string>;
/**
* The reason for modification protection.
*/
readonly modificationProtectionReason: pulumi.Output<string>;
/**
* The modification protection status of the NLB instance. Valid values: `NonProtection`, `ConsoleProtection`.
* `NonProtection`: No protection. `ConsoleProtection`: Console protection.
*/
readonly modificationProtectionStatus: pulumi.Output<string>;
/**
* The network type of the NLB instance. Valid values: `internet`, `intranet`. `internet`: The NLB instance is an
* internet-facing instance. `intranet`: The NLB instance is an internal-facing instance.
*/
readonly networkType: pulumi.Output<string>;
/**
* The overdue time of the NLB instance.
*/
readonly overdueTime: pulumi.Output<string>;
/**
* The project name of the NLB instance.
*/
readonly projectName: pulumi.Output<string>;
/**
* The reclaimed time of the NLB instance.
*/
readonly reclaimedTime: pulumi.Output<string>;
/**
* The region of the NLB instance.
*/
readonly region: pulumi.Output<string>;
/**
* The security group IDs of the NLB instance.
*/
readonly securityGroupIds: pulumi.Output<string[] | undefined>;
/**
* The status of the NLB instance.
*/
readonly status: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.nlb.NetworkLoadBalancerTag[] | undefined>;
/**
* The update time of the NLB instance.
*/
readonly updateTime: pulumi.Output<string>;
/**
* The ID of the VPC where the NLB instance is deployed.
*/
readonly vpcId: pulumi.Output<string>;
/**
* The zone mappings of the NLB instance.
*/
readonly zoneMappings: pulumi.Output<outputs.nlb.NetworkLoadBalancerZoneMapping[]>;
/**
* Create a NetworkLoadBalancer 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: NetworkLoadBalancerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetworkLoadBalancer resources.
*/
export interface NetworkLoadBalancerState {
/**
* The access log configuration of the NLB instance.
*/
accessLogConfig?: pulumi.Input<inputs.nlb.NetworkLoadBalancerAccessLogConfig>;
/**
* The account ID of the NLB instance.
*/
accountId?: pulumi.Input<string>;
/**
* The billing status of the NLB instance.
*/
billingStatus?: pulumi.Input<string>;
/**
* The creation time of the NLB instance.
*/
createTime?: pulumi.Input<string>;
/**
* Whether to enable cross-zone load balancing for the NLB instance. Valid values: `true`, `false`. `true`: Enable.
* `false`: Disable.
*/
crossZoneEnabled?: pulumi.Input<boolean>;
/**
* The description of the NLB instance.
*/
description?: pulumi.Input<string>;
/**
* The DNS name of the NLB instance.
*/
dnsName?: pulumi.Input<string>;
/**
* The expected overdue time of the NLB instance.
*/
expectedOverdueTime?: pulumi.Input<string>;
/**
* The IP address version of the NLB instance. Valid values: `ipv4`, `dualstack`. `ipv4`: The NLB instance supports IPv4.
* `dualstack`: The NLB instance supports both IPv4 and IPv6.
*/
ipAddressVersion?: pulumi.Input<string>;
/**
* The ID of the IPv4 bandwidth package.
*/
ipv4BandwidthPackageId?: pulumi.Input<string>;
/**
* The IPv4 network type of the NLB instance.
*/
ipv4NetworkType?: pulumi.Input<string>;
/**
* The ID of the IPv6 bandwidth package.
*/
ipv6BandwidthPackageId?: pulumi.Input<string>;
/**
* The IPv6 network type of the NLB instance.
*/
ipv6NetworkType?: pulumi.Input<string>;
/**
* The name of the NLB instance.
*/
loadBalancerName?: pulumi.Input<string>;
/**
* The managed security group ID of the NLB instance.
*/
managedSecurityGroupId?: pulumi.Input<string>;
/**
* The reason for modification protection.
*/
modificationProtectionReason?: pulumi.Input<string>;
/**
* The modification protection status of the NLB instance. Valid values: `NonProtection`, `ConsoleProtection`.
* `NonProtection`: No protection. `ConsoleProtection`: Console protection.
*/
modificationProtectionStatus?: pulumi.Input<string>;
/**
* The network type of the NLB instance. Valid values: `internet`, `intranet`. `internet`: The NLB instance is an
* internet-facing instance. `intranet`: The NLB instance is an internal-facing instance.
*/
networkType?: pulumi.Input<string>;
/**
* The overdue time of the NLB instance.
*/
overdueTime?: pulumi.Input<string>;
/**
* The project name of the NLB instance.
*/
projectName?: pulumi.Input<string>;
/**
* The reclaimed time of the NLB instance.
*/
reclaimedTime?: pulumi.Input<string>;
/**
* The region of the NLB instance.
*/
region?: pulumi.Input<string>;
/**
* The security group IDs of the NLB instance.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The status of the NLB instance.
*/
status?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.nlb.NetworkLoadBalancerTag>[]>;
/**
* The update time of the NLB instance.
*/
updateTime?: pulumi.Input<string>;
/**
* The ID of the VPC where the NLB instance is deployed.
*/
vpcId?: pulumi.Input<string>;
/**
* The zone mappings of the NLB instance.
*/
zoneMappings?: pulumi.Input<pulumi.Input<inputs.nlb.NetworkLoadBalancerZoneMapping>[]>;
}
/**
* The set of arguments for constructing a NetworkLoadBalancer resource.
*/
export interface NetworkLoadBalancerArgs {
/**
* The access log configuration of the NLB instance.
*/
accessLogConfig?: pulumi.Input<inputs.nlb.NetworkLoadBalancerAccessLogConfig>;
/**
* Whether to enable cross-zone load balancing for the NLB instance. Valid values: `true`, `false`. `true`: Enable.
* `false`: Disable.
*/
crossZoneEnabled?: pulumi.Input<boolean>;
/**
* The description of the NLB instance.
*/
description?: pulumi.Input<string>;
/**
* The IP address version of the NLB instance. Valid values: `ipv4`, `dualstack`. `ipv4`: The NLB instance supports IPv4.
* `dualstack`: The NLB instance supports both IPv4 and IPv6.
*/
ipAddressVersion?: pulumi.Input<string>;
/**
* The ID of the IPv4 bandwidth package.
*/
ipv4BandwidthPackageId?: pulumi.Input<string>;
/**
* The ID of the IPv6 bandwidth package.
*/
ipv6BandwidthPackageId?: pulumi.Input<string>;
/**
* The name of the NLB instance.
*/
loadBalancerName?: pulumi.Input<string>;
/**
* The reason for modification protection.
*/
modificationProtectionReason?: pulumi.Input<string>;
/**
* The modification protection status of the NLB instance. Valid values: `NonProtection`, `ConsoleProtection`.
* `NonProtection`: No protection. `ConsoleProtection`: Console protection.
*/
modificationProtectionStatus?: pulumi.Input<string>;
/**
* The network type of the NLB instance. Valid values: `internet`, `intranet`. `internet`: The NLB instance is an
* internet-facing instance. `intranet`: The NLB instance is an internal-facing instance.
*/
networkType: pulumi.Input<string>;
/**
* The project name of the NLB instance.
*/
projectName?: pulumi.Input<string>;
/**
* The region of the NLB instance.
*/
region: pulumi.Input<string>;
/**
* The security group IDs of the NLB instance.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.nlb.NetworkLoadBalancerTag>[]>;
/**
* The ID of the VPC where the NLB instance is deployed.
*/
vpcId: pulumi.Input<string>;
/**
* The zone mappings of the NLB instance.
*/
zoneMappings: pulumi.Input<pulumi.Input<inputs.nlb.NetworkLoadBalancerZoneMapping>[]>;
}