published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
The NLB instance receives user access requests and forwards them to backend servers based on the configuration of listeners and server groups.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
nLBDemo:
type: volcenginecc:clb:Nlb
name: NLBDemo
properties:
ipv4NetworkType: intranet
securityGroupIds:
- sg-13fg4nslwnwu83n6nu5a7xxxx
vpcId: vpc-13ffun9olqz9c3n6nu43bxxxx
loadBalancerName: NLBDemo
description: NLBDemom
projectName: default
ipAddressVersion: ipv4
crossZoneEnabled: false
zoneMappings:
- subnet_id: subnet-mjoyynjt59ts5smt1bncxxxx
zone_id: cn-beijing-a
ipv_4_address: 192.168.xx.2
modificationProtectionStatus: ConsoleProtection
tags:
- key: env
value: test
Create Nlb Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Nlb(name: string, args: NlbArgs, opts?: CustomResourceOptions);@overload
def Nlb(resource_name: str,
args: NlbArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Nlb(resource_name: str,
opts: Optional[ResourceOptions] = None,
ipv4_network_type: Optional[str] = None,
zone_mappings: Optional[Sequence[NlbZoneMappingArgs]] = None,
vpc_id: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
ipv6_bandwidth_package_id: Optional[str] = None,
ipv4_bandwidth_package_id: Optional[str] = None,
account_id: Optional[str] = None,
ipv6_network_type: Optional[str] = None,
load_balancer_name: Optional[str] = None,
modification_protection_status: Optional[str] = None,
project_name: Optional[str] = None,
ip_address_version: Optional[str] = None,
tags: Optional[Sequence[NlbTagArgs]] = None,
description: Optional[str] = None,
cross_zone_enabled: Optional[bool] = None)func NewNlb(ctx *Context, name string, args NlbArgs, opts ...ResourceOption) (*Nlb, error)public Nlb(string name, NlbArgs args, CustomResourceOptions? opts = null)type: volcenginecc:clb:Nlb
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NlbArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NlbArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NlbArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NlbArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NlbArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var nlbResource = new Volcenginecc.Clb.Nlb("nlbResource", new()
{
Ipv4NetworkType = "string",
ZoneMappings = new[]
{
new Volcenginecc.Clb.Inputs.NlbZoneMappingArgs
{
EniId = "string",
Ipv4Address = "string",
Ipv4EipAddress = "string",
Ipv4EipId = "string",
Ipv4HcStatus = "string",
Ipv4LocalAddresses = new[]
{
"string",
},
Ipv6Address = "string",
Ipv6EipId = "string",
Ipv6HcStatus = "string",
Ipv6LocalAddresses = new[]
{
"string",
},
SubnetId = "string",
ZoneId = "string",
},
},
VpcId = "string",
SecurityGroupIds = new[]
{
"string",
},
Ipv6BandwidthPackageId = "string",
Ipv4BandwidthPackageId = "string",
AccountId = "string",
Ipv6NetworkType = "string",
LoadBalancerName = "string",
ModificationProtectionStatus = "string",
ProjectName = "string",
IpAddressVersion = "string",
Tags = new[]
{
new Volcenginecc.Clb.Inputs.NlbTagArgs
{
Key = "string",
Value = "string",
},
},
Description = "string",
CrossZoneEnabled = false,
});
example, err := clb.NewNlb(ctx, "nlbResource", &clb.NlbArgs{
Ipv4NetworkType: pulumi.String("string"),
ZoneMappings: clb.NlbZoneMappingArray{
&clb.NlbZoneMappingArgs{
EniId: pulumi.String("string"),
Ipv4Address: pulumi.String("string"),
Ipv4EipAddress: pulumi.String("string"),
Ipv4EipId: pulumi.String("string"),
Ipv4HcStatus: pulumi.String("string"),
Ipv4LocalAddresses: pulumi.StringArray{
pulumi.String("string"),
},
Ipv6Address: pulumi.String("string"),
Ipv6EipId: pulumi.String("string"),
Ipv6HcStatus: pulumi.String("string"),
Ipv6LocalAddresses: pulumi.StringArray{
pulumi.String("string"),
},
SubnetId: pulumi.String("string"),
ZoneId: pulumi.String("string"),
},
},
VpcId: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Ipv6BandwidthPackageId: pulumi.String("string"),
Ipv4BandwidthPackageId: pulumi.String("string"),
AccountId: pulumi.String("string"),
Ipv6NetworkType: pulumi.String("string"),
LoadBalancerName: pulumi.String("string"),
ModificationProtectionStatus: pulumi.String("string"),
ProjectName: pulumi.String("string"),
IpAddressVersion: pulumi.String("string"),
Tags: clb.NlbTagArray{
&clb.NlbTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
CrossZoneEnabled: pulumi.Bool(false),
})
var nlbResource = new Nlb("nlbResource", NlbArgs.builder()
.ipv4NetworkType("string")
.zoneMappings(NlbZoneMappingArgs.builder()
.eniId("string")
.ipv4Address("string")
.ipv4EipAddress("string")
.ipv4EipId("string")
.ipv4HcStatus("string")
.ipv4LocalAddresses("string")
.ipv6Address("string")
.ipv6EipId("string")
.ipv6HcStatus("string")
.ipv6LocalAddresses("string")
.subnetId("string")
.zoneId("string")
.build())
.vpcId("string")
.securityGroupIds("string")
.ipv6BandwidthPackageId("string")
.ipv4BandwidthPackageId("string")
.accountId("string")
.ipv6NetworkType("string")
.loadBalancerName("string")
.modificationProtectionStatus("string")
.projectName("string")
.ipAddressVersion("string")
.tags(NlbTagArgs.builder()
.key("string")
.value("string")
.build())
.description("string")
.crossZoneEnabled(false)
.build());
nlb_resource = volcenginecc.clb.Nlb("nlbResource",
ipv4_network_type="string",
zone_mappings=[{
"eni_id": "string",
"ipv4_address": "string",
"ipv4_eip_address": "string",
"ipv4_eip_id": "string",
"ipv4_hc_status": "string",
"ipv4_local_addresses": ["string"],
"ipv6_address": "string",
"ipv6_eip_id": "string",
"ipv6_hc_status": "string",
"ipv6_local_addresses": ["string"],
"subnet_id": "string",
"zone_id": "string",
}],
vpc_id="string",
security_group_ids=["string"],
ipv6_bandwidth_package_id="string",
ipv4_bandwidth_package_id="string",
account_id="string",
ipv6_network_type="string",
load_balancer_name="string",
modification_protection_status="string",
project_name="string",
ip_address_version="string",
tags=[{
"key": "string",
"value": "string",
}],
description="string",
cross_zone_enabled=False)
const nlbResource = new volcenginecc.clb.Nlb("nlbResource", {
ipv4NetworkType: "string",
zoneMappings: [{
eniId: "string",
ipv4Address: "string",
ipv4EipAddress: "string",
ipv4EipId: "string",
ipv4HcStatus: "string",
ipv4LocalAddresses: ["string"],
ipv6Address: "string",
ipv6EipId: "string",
ipv6HcStatus: "string",
ipv6LocalAddresses: ["string"],
subnetId: "string",
zoneId: "string",
}],
vpcId: "string",
securityGroupIds: ["string"],
ipv6BandwidthPackageId: "string",
ipv4BandwidthPackageId: "string",
accountId: "string",
ipv6NetworkType: "string",
loadBalancerName: "string",
modificationProtectionStatus: "string",
projectName: "string",
ipAddressVersion: "string",
tags: [{
key: "string",
value: "string",
}],
description: "string",
crossZoneEnabled: false,
});
type: volcenginecc:clb:Nlb
properties:
accountId: string
crossZoneEnabled: false
description: string
ipAddressVersion: string
ipv4BandwidthPackageId: string
ipv4NetworkType: string
ipv6BandwidthPackageId: string
ipv6NetworkType: string
loadBalancerName: string
modificationProtectionStatus: string
projectName: string
securityGroupIds:
- string
tags:
- key: string
value: string
vpcId: string
zoneMappings:
- eniId: string
ipv4Address: string
ipv4EipAddress: string
ipv4EipId: string
ipv4HcStatus: string
ipv4LocalAddresses:
- string
ipv6Address: string
ipv6EipId: string
ipv6HcStatus: string
ipv6LocalAddresses:
- string
subnetId: string
zoneId: string
Nlb Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Nlb resource accepts the following input properties:
- Ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- Security
Group List<string>Ids - List of security group IDs associated with the NLB instance.
- Vpc
Id string - VPC ID to which the NLB instance belongs.
- Zone
Mappings List<Volcengine.Nlb Zone Mapping> - Account
Id string - Account ID to which the NLB instance belongs.
- Cross
Zone boolEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- Description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- Ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- Ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- Ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- Ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- Load
Balancer stringName - Name of the NLB instance.
- Modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- Project
Name string - Name of the project to which the NLB instance belongs.
-
List<Volcengine.
Nlb Tag>
- Ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- Security
Group []stringIds - List of security group IDs associated with the NLB instance.
- Vpc
Id string - VPC ID to which the NLB instance belongs.
- Zone
Mappings []NlbZone Mapping Args - Account
Id string - Account ID to which the NLB instance belongs.
- Cross
Zone boolEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- Description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- Ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- Ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- Ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- Ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- Load
Balancer stringName - Name of the NLB instance.
- Modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- Project
Name string - Name of the project to which the NLB instance belongs.
-
[]Nlb
Tag Args
- ipv4Network
Type String - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- security
Group List<String>Ids - List of security group IDs associated with the NLB instance.
- vpc
Id String - VPC ID to which the NLB instance belongs.
- zone
Mappings List<NlbZone Mapping> - account
Id String - Account ID to which the NLB instance belongs.
- cross
Zone BooleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description String
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- ip
Address StringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package StringId - Shared bandwidth package ID for IPv4 type.
- ipv6Bandwidth
Package StringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type String - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer StringName - Name of the NLB instance.
- modification
Protection StringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- project
Name String - Name of the project to which the NLB instance belongs.
-
List<Nlb
Tag>
- ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- security
Group string[]Ids - List of security group IDs associated with the NLB instance.
- vpc
Id string - VPC ID to which the NLB instance belongs.
- zone
Mappings NlbZone Mapping[] - account
Id string - Account ID to which the NLB instance belongs.
- cross
Zone booleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer stringName - Name of the NLB instance.
- modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- project
Name string - Name of the project to which the NLB instance belongs.
-
Nlb
Tag[]
- ipv4_
network_ strtype - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- security_
group_ Sequence[str]ids - List of security group IDs associated with the NLB instance.
- vpc_
id str - VPC ID to which the NLB instance belongs.
- zone_
mappings Sequence[NlbZone Mapping Args] - account_
id str - Account ID to which the NLB instance belongs.
- cross_
zone_ boolenabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description str
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- ip_
address_ strversion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4_
bandwidth_ strpackage_ id - Shared bandwidth package ID for IPv4 type.
- ipv6_
bandwidth_ strpackage_ id - Shared bandwidth package ID for IPv6 type.
- ipv6_
network_ strtype - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load_
balancer_ strname - Name of the NLB instance.
- modification_
protection_ strstatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- project_
name str - Name of the project to which the NLB instance belongs.
-
Sequence[Nlb
Tag Args]
- ipv4Network
Type String - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- security
Group List<String>Ids - List of security group IDs associated with the NLB instance.
- vpc
Id String - VPC ID to which the NLB instance belongs.
- zone
Mappings List<Property Map> - account
Id String - Account ID to which the NLB instance belongs.
- cross
Zone BooleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description String
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- ip
Address StringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package StringId - Shared bandwidth package ID for IPv4 type.
- ipv6Bandwidth
Package StringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type String - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer StringName - Name of the NLB instance.
- modification
Protection StringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- project
Name String - Name of the project to which the NLB instance belongs.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Nlb resource produces the following output properties:
- Access
Log Volcengine.Nlb Access Log - Access log information of the NLB instance.
- Billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- Billing
Type int - Billing type of the NLB instance. 3: pay-as-you-go
- Created
Time string - Creation time of the NLB instance.
- Dns
Name string - DNS address of the NLB instance.
- Expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer stringId - NLB instance ID.
- Managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- Overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- Updated
Time string - Update time of the NLB instance.
- Access
Log NlbAccess Log - Access log information of the NLB instance.
- Billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- Billing
Type int - Billing type of the NLB instance. 3: pay-as-you-go
- Created
Time string - Creation time of the NLB instance.
- Dns
Name string - DNS address of the NLB instance.
- Expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Load
Balancer stringId - NLB instance ID.
- Managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- Overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- Updated
Time string - Update time of the NLB instance.
- access
Log NlbAccess Log - Access log information of the NLB instance.
- billing
Status String - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type Integer - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time String - Creation time of the NLB instance.
- dns
Name String - DNS address of the NLB instance.
- expected
Overdue StringTime - Time when the NLB instance is suspended due to overdue payment.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer StringId - NLB instance ID.
- managed
Security StringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- overdue
Time String - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- reclaimed
Time String - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- status String
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- updated
Time String - Update time of the NLB instance.
- access
Log NlbAccess Log - Access log information of the NLB instance.
- billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type number - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time string - Creation time of the NLB instance.
- dns
Name string - DNS address of the NLB instance.
- expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- id string
- The provider-assigned unique ID for this managed resource.
- load
Balancer stringId - NLB instance ID.
- managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- updated
Time string - Update time of the NLB instance.
- access_
log NlbAccess Log - Access log information of the NLB instance.
- billing_
status str - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing_
type int - Billing type of the NLB instance. 3: pay-as-you-go
- created_
time str - Creation time of the NLB instance.
- dns_
name str - DNS address of the NLB instance.
- expected_
overdue_ strtime - Time when the NLB instance is suspended due to overdue payment.
- id str
- The provider-assigned unique ID for this managed resource.
- load_
balancer_ strid - NLB instance ID.
- managed_
security_ strgroup_ id - Managed security group ID automatically associated with the NLB instance by the system.
- overdue_
time str - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- reclaimed_
time str - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- status str
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- updated_
time str - Update time of the NLB instance.
- access
Log Property Map - Access log information of the NLB instance.
- billing
Status String - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type Number - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time String - Creation time of the NLB instance.
- dns
Name String - DNS address of the NLB instance.
- expected
Overdue StringTime - Time when the NLB instance is suspended due to overdue payment.
- id String
- The provider-assigned unique ID for this managed resource.
- load
Balancer StringId - NLB instance ID.
- managed
Security StringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- overdue
Time String - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- reclaimed
Time String - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- status String
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- updated
Time String - Update time of the NLB instance.
Look up Existing Nlb Resource
Get an existing Nlb resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NlbState, opts?: CustomResourceOptions): Nlb@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_log: Optional[NlbAccessLogArgs] = None,
account_id: Optional[str] = None,
billing_status: Optional[str] = None,
billing_type: Optional[int] = None,
created_time: Optional[str] = None,
cross_zone_enabled: Optional[bool] = None,
description: Optional[str] = None,
dns_name: Optional[str] = None,
expected_overdue_time: Optional[str] = None,
ip_address_version: Optional[str] = None,
ipv4_bandwidth_package_id: Optional[str] = None,
ipv4_network_type: Optional[str] = None,
ipv6_bandwidth_package_id: Optional[str] = None,
ipv6_network_type: Optional[str] = None,
load_balancer_id: Optional[str] = None,
load_balancer_name: Optional[str] = None,
managed_security_group_id: Optional[str] = None,
modification_protection_status: Optional[str] = None,
overdue_time: Optional[str] = None,
project_name: Optional[str] = None,
reclaimed_time: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
status: Optional[str] = None,
tags: Optional[Sequence[NlbTagArgs]] = None,
updated_time: Optional[str] = None,
vpc_id: Optional[str] = None,
zone_mappings: Optional[Sequence[NlbZoneMappingArgs]] = None) -> Nlbfunc GetNlb(ctx *Context, name string, id IDInput, state *NlbState, opts ...ResourceOption) (*Nlb, error)public static Nlb Get(string name, Input<string> id, NlbState? state, CustomResourceOptions? opts = null)public static Nlb get(String name, Output<String> id, NlbState state, CustomResourceOptions options)resources: _: type: volcenginecc:clb:Nlb get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Log Volcengine.Nlb Access Log - Access log information of the NLB instance.
- Account
Id string - Account ID to which the NLB instance belongs.
- Billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- Billing
Type int - Billing type of the NLB instance. 3: pay-as-you-go
- Created
Time string - Creation time of the NLB instance.
- Cross
Zone boolEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- Description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- Dns
Name string - DNS address of the NLB instance.
- Expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- Ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- Ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- Ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- Ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- Ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- Load
Balancer stringId - NLB instance ID.
- Load
Balancer stringName - Name of the NLB instance.
- Managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- Modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- Overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Project
Name string - Name of the project to which the NLB instance belongs.
- Reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Security
Group List<string>Ids - List of security group IDs associated with the NLB instance.
- Status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
-
List<Volcengine.
Nlb Tag> - Updated
Time string - Update time of the NLB instance.
- Vpc
Id string - VPC ID to which the NLB instance belongs.
- Zone
Mappings List<Volcengine.Nlb Zone Mapping>
- Access
Log NlbAccess Log Args - Access log information of the NLB instance.
- Account
Id string - Account ID to which the NLB instance belongs.
- Billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- Billing
Type int - Billing type of the NLB instance. 3: pay-as-you-go
- Created
Time string - Creation time of the NLB instance.
- Cross
Zone boolEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- Description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- Dns
Name string - DNS address of the NLB instance.
- Expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- Ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- Ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- Ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- Ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- Ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- Load
Balancer stringId - NLB instance ID.
- Load
Balancer stringName - Name of the NLB instance.
- Managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- Modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- Overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Project
Name string - Name of the project to which the NLB instance belongs.
- Reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- Security
Group []stringIds - List of security group IDs associated with the NLB instance.
- Status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
-
[]Nlb
Tag Args - Updated
Time string - Update time of the NLB instance.
- Vpc
Id string - VPC ID to which the NLB instance belongs.
- Zone
Mappings []NlbZone Mapping Args
- access
Log NlbAccess Log - Access log information of the NLB instance.
- account
Id String - Account ID to which the NLB instance belongs.
- billing
Status String - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type Integer - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time String - Creation time of the NLB instance.
- cross
Zone BooleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description String
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- dns
Name String - DNS address of the NLB instance.
- expected
Overdue StringTime - Time when the NLB instance is suspended due to overdue payment.
- ip
Address StringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package StringId - Shared bandwidth package ID for IPv4 type.
- ipv4Network
Type String - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- ipv6Bandwidth
Package StringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type String - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer StringId - NLB instance ID.
- load
Balancer StringName - Name of the NLB instance.
- managed
Security StringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- modification
Protection StringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- overdue
Time String - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- project
Name String - Name of the project to which the NLB instance belongs.
- reclaimed
Time String - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- security
Group List<String>Ids - List of security group IDs associated with the NLB instance.
- status String
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
-
List<Nlb
Tag> - updated
Time String - Update time of the NLB instance.
- vpc
Id String - VPC ID to which the NLB instance belongs.
- zone
Mappings List<NlbZone Mapping>
- access
Log NlbAccess Log - Access log information of the NLB instance.
- account
Id string - Account ID to which the NLB instance belongs.
- billing
Status string - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type number - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time string - Creation time of the NLB instance.
- cross
Zone booleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description string
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- dns
Name string - DNS address of the NLB instance.
- expected
Overdue stringTime - Time when the NLB instance is suspended due to overdue payment.
- ip
Address stringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package stringId - Shared bandwidth package ID for IPv4 type.
- ipv4Network
Type string - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- ipv6Bandwidth
Package stringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type string - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer stringId - NLB instance ID.
- load
Balancer stringName - Name of the NLB instance.
- managed
Security stringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- modification
Protection stringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- overdue
Time string - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- project
Name string - Name of the project to which the NLB instance belongs.
- reclaimed
Time string - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- security
Group string[]Ids - List of security group IDs associated with the NLB instance.
- status string
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
-
Nlb
Tag[] - updated
Time string - Update time of the NLB instance.
- vpc
Id string - VPC ID to which the NLB instance belongs.
- zone
Mappings NlbZone Mapping[]
- access_
log NlbAccess Log Args - Access log information of the NLB instance.
- account_
id str - Account ID to which the NLB instance belongs.
- billing_
status str - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing_
type int - Billing type of the NLB instance. 3: pay-as-you-go
- created_
time str - Creation time of the NLB instance.
- cross_
zone_ boolenabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description str
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- dns_
name str - DNS address of the NLB instance.
- expected_
overdue_ strtime - Time when the NLB instance is suspended due to overdue payment.
- ip_
address_ strversion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4_
bandwidth_ strpackage_ id - Shared bandwidth package ID for IPv4 type.
- ipv4_
network_ strtype - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- ipv6_
bandwidth_ strpackage_ id - Shared bandwidth package ID for IPv6 type.
- ipv6_
network_ strtype - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load_
balancer_ strid - NLB instance ID.
- load_
balancer_ strname - Name of the NLB instance.
- managed_
security_ strgroup_ id - Managed security group ID automatically associated with the NLB instance by the system.
- modification_
protection_ strstatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- overdue_
time str - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- project_
name str - Name of the project to which the NLB instance belongs.
- reclaimed_
time str - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- security_
group_ Sequence[str]ids - List of security group IDs associated with the NLB instance.
- status str
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
-
Sequence[Nlb
Tag Args] - updated_
time str - Update time of the NLB instance.
- vpc_
id str - VPC ID to which the NLB instance belongs.
- zone_
mappings Sequence[NlbZone Mapping Args]
- access
Log Property Map - Access log information of the NLB instance.
- account
Id String - Account ID to which the NLB instance belongs.
- billing
Status String - Billing status of the NLB instance. Normal: normal, FinancialLocked: locked.
- billing
Type Number - Billing type of the NLB instance. 3: pay-as-you-go
- created
Time String - Creation time of the NLB instance.
- cross
Zone BooleanEnabled - Whether the NLB instance has cross-availability zone forwarding enabled. true (default): enabled. false: disabled.
- description String
- Description of the NLB instance. Must start with a letter, number, or Chinese character and can include the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Length limit: 0–255 characters. If this parameter is not provided, the default is an empty string.
- dns
Name String - DNS address of the NLB instance.
- expected
Overdue StringTime - Time when the NLB instance is suspended due to overdue payment.
- ip
Address StringVersion - IP address type of the NLB instance. ipv4: IPv4 version. dualstack: dual stack, supports both IPv4 and IPv6 versions.
- ipv4Bandwidth
Package StringId - Shared bandwidth package ID for IPv4 type.
- ipv4Network
Type String - IPv4 network type of the NLB instance. internet: public network type. intranet: private network type.
- ipv6Bandwidth
Package StringId - Shared bandwidth package ID for IPv6 type.
- ipv6Network
Type String - IPv6 network type of the NLB instance. internet: public network type. intranet: private network type.
- load
Balancer StringId - NLB instance ID.
- load
Balancer StringName - Name of the NLB instance.
- managed
Security StringGroup Id - Managed security group ID automatically associated with the NLB instance by the system.
- modification
Protection StringStatus - Whether modification protection is enabled for the NLB instance in the console. NonProtection or empty: disabled, allows modification or deletion of the instance via the console. ConsoleProtection: enabled, prevents modification or deletion of the instance via the console.
- overdue
Time String - Time when the NLB instance is locked. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- project
Name String - Name of the project to which the NLB instance belongs.
- reclaimed
Time String - Expected reclamation time of the NLB instance. If the BillingStatus parameter is Normal, this parameter returns an empty string.
- security
Group List<String>Ids - List of security group IDs associated with the NLB instance.
- status String
- Status of the NLB instance. Inactive: stopped. Active: running. Creating: creating. Provisioning: creating (this status only appears when creating an NLB instance via API). Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
- List<Property Map>
- updated
Time String - Update time of the NLB instance.
- vpc
Id String - VPC ID to which the NLB instance belongs.
- zone
Mappings List<Property Map>
Supporting Types
NlbAccessLog, NlbAccessLogArgs
- Access
Log boolEnabled - Enable access logs. true: yes. false: no.
- Project
Id string - Log project ID.
- Topic
Id string - Log topic ID.
- Access
Log boolEnabled - Enable access logs. true: yes. false: no.
- Project
Id string - Log project ID.
- Topic
Id string - Log topic ID.
- access
Log BooleanEnabled - Enable access logs. true: yes. false: no.
- project
Id String - Log project ID.
- topic
Id String - Log topic ID.
- access
Log booleanEnabled - Enable access logs. true: yes. false: no.
- project
Id string - Log project ID.
- topic
Id string - Log topic ID.
- access_
log_ boolenabled - Enable access logs. true: yes. false: no.
- project_
id str - Log project ID.
- topic_
id str - Log topic ID.
- access
Log BooleanEnabled - Enable access logs. true: yes. false: no.
- project
Id String - Log project ID.
- topic
Id String - Log topic ID.
NlbTag, NlbTagArgs
NlbZoneMapping, NlbZoneMappingArgs
- Eni
Id string - Network interface card ID.
- Ipv4Address string
- Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- Ipv4Eip
Address string - Public IPv4 EIP address of the NLB instance.
- Ipv4Eip
Id string - Public IPv4 EIP ID of the NLB instance.
- Ipv4Hc
Status string - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- Ipv4Local
Addresses List<string> - Private IPv4 LIP address of the NLB instance.
- Ipv6Address string
- Private IPv6 VIP address of the NLB instance.
- Ipv6Eip
Id string - ID of the IPv6 public bandwidth associated with the NLB instance.
- Ipv6Hc
Status string - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- Ipv6Local
Addresses List<string> - Private IPv6 LIP address of the NLB instance.
- Subnet
Id string - Subnet ID to which the NLB instance belongs.
- Zone
Id string - Availability zone ID to which the NLB instance belongs.
- Eni
Id string - Network interface card ID.
- Ipv4Address string
- Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- Ipv4Eip
Address string - Public IPv4 EIP address of the NLB instance.
- Ipv4Eip
Id string - Public IPv4 EIP ID of the NLB instance.
- Ipv4Hc
Status string - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- Ipv4Local
Addresses []string - Private IPv4 LIP address of the NLB instance.
- Ipv6Address string
- Private IPv6 VIP address of the NLB instance.
- Ipv6Eip
Id string - ID of the IPv6 public bandwidth associated with the NLB instance.
- Ipv6Hc
Status string - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- Ipv6Local
Addresses []string - Private IPv6 LIP address of the NLB instance.
- Subnet
Id string - Subnet ID to which the NLB instance belongs.
- Zone
Id string - Availability zone ID to which the NLB instance belongs.
- eni
Id String - Network interface card ID.
- ipv4Address String
- Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- ipv4Eip
Address String - Public IPv4 EIP address of the NLB instance.
- ipv4Eip
Id String - Public IPv4 EIP ID of the NLB instance.
- ipv4Hc
Status String - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- ipv4Local
Addresses List<String> - Private IPv4 LIP address of the NLB instance.
- ipv6Address String
- Private IPv6 VIP address of the NLB instance.
- ipv6Eip
Id String - ID of the IPv6 public bandwidth associated with the NLB instance.
- ipv6Hc
Status String - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- ipv6Local
Addresses List<String> - Private IPv6 LIP address of the NLB instance.
- subnet
Id String - Subnet ID to which the NLB instance belongs.
- zone
Id String - Availability zone ID to which the NLB instance belongs.
- eni
Id string - Network interface card ID.
- ipv4Address string
- Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- ipv4Eip
Address string - Public IPv4 EIP address of the NLB instance.
- ipv4Eip
Id string - Public IPv4 EIP ID of the NLB instance.
- ipv4Hc
Status string - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- ipv4Local
Addresses string[] - Private IPv4 LIP address of the NLB instance.
- ipv6Address string
- Private IPv6 VIP address of the NLB instance.
- ipv6Eip
Id string - ID of the IPv6 public bandwidth associated with the NLB instance.
- ipv6Hc
Status string - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- ipv6Local
Addresses string[] - Private IPv6 LIP address of the NLB instance.
- subnet
Id string - Subnet ID to which the NLB instance belongs.
- zone
Id string - Availability zone ID to which the NLB instance belongs.
- eni_
id str - Network interface card ID.
- ipv4_
address str - Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- ipv4_
eip_ straddress - Public IPv4 EIP address of the NLB instance.
- ipv4_
eip_ strid - Public IPv4 EIP ID of the NLB instance.
- ipv4_
hc_ strstatus - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- ipv4_
local_ Sequence[str]addresses - Private IPv4 LIP address of the NLB instance.
- ipv6_
address str - Private IPv6 VIP address of the NLB instance.
- ipv6_
eip_ strid - ID of the IPv6 public bandwidth associated with the NLB instance.
- ipv6_
hc_ strstatus - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- ipv6_
local_ Sequence[str]addresses - Private IPv6 LIP address of the NLB instance.
- subnet_
id str - Subnet ID to which the NLB instance belongs.
- zone_
id str - Availability zone ID to which the NLB instance belongs.
- eni
Id String - Network interface card ID.
- ipv4Address String
- Private IPv4 VIP address of the NLB instance. If this parameter is not provided, the system automatically assigns an available IPv4 address from the subnet.
- ipv4Eip
Address String - Public IPv4 EIP address of the NLB instance.
- ipv4Eip
Id String - Public IPv4 EIP ID of the NLB instance.
- ipv4Hc
Status String - Health status of the NLB instance's private IPv4 address. Healthy: healthy. Unhealthy: abnormal.
- ipv4Local
Addresses List<String> - Private IPv4 LIP address of the NLB instance.
- ipv6Address String
- Private IPv6 VIP address of the NLB instance.
- ipv6Eip
Id String - ID of the IPv6 public bandwidth associated with the NLB instance.
- ipv6Hc
Status String - Health status of the NLB instance's private IPv6 address. Healthy: healthy. Unhealthy: abnormal.
- ipv6Local
Addresses List<String> - Private IPv6 LIP address of the NLB instance.
- subnet
Id String - Subnet ID to which the NLB instance belongs.
- zone
Id String - Availability zone ID to which the NLB instance belongs.
Import
$ pulumi import volcenginecc:clb/nlb:Nlb example "load_balancer_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
