1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. NetworkLoadBalancer
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nlb.NetworkLoadBalancer

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Create NetworkLoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NetworkLoadBalancer(name: string, args: NetworkLoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
def NetworkLoadBalancer(resource_name: str,
                        args: NetworkLoadBalancerArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def NetworkLoadBalancer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        network_type: Optional[str] = None,
                        zone_mappings: Optional[Sequence[NetworkLoadBalancerZoneMappingArgs]] = None,
                        vpc_id: Optional[str] = None,
                        region: Optional[str] = None,
                        modification_protection_status: Optional[str] = None,
                        ipv6_bandwidth_package_id: Optional[str] = None,
                        load_balancer_name: Optional[str] = None,
                        modification_protection_reason: Optional[str] = None,
                        access_log_config: Optional[NetworkLoadBalancerAccessLogConfigArgs] = None,
                        ipv4_bandwidth_package_id: Optional[str] = None,
                        project_name: Optional[str] = None,
                        ip_address_version: Optional[str] = None,
                        security_group_ids: Optional[Sequence[str]] = None,
                        tags: Optional[Sequence[NetworkLoadBalancerTagArgs]] = None,
                        description: Optional[str] = None,
                        cross_zone_enabled: Optional[bool] = None)
    func NewNetworkLoadBalancer(ctx *Context, name string, args NetworkLoadBalancerArgs, opts ...ResourceOption) (*NetworkLoadBalancer, error)
    public NetworkLoadBalancer(string name, NetworkLoadBalancerArgs args, CustomResourceOptions? opts = null)
    public NetworkLoadBalancer(String name, NetworkLoadBalancerArgs args)
public NetworkLoadBalancer(String name, NetworkLoadBalancerArgs args, CustomResourceOptions options)

    type: volcengine:nlb:NetworkLoadBalancer
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 NetworkLoadBalancerArgs
    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 NetworkLoadBalancerArgs
    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 NetworkLoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkLoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkLoadBalancerArgs
    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 networkLoadBalancerResource = new Volcengine.Nlb.NetworkLoadBalancer("networkLoadBalancerResource", new()
{
    NetworkType = "string",
    ZoneMappings = new[]
    {
        new Volcengine.Nlb.Inputs.NetworkLoadBalancerZoneMappingArgs
        {
            SubnetId = "string",
            ZoneId = "string",
            EipId = "string",
            EniId = "string",
            Ipv4Address = "string",
            Ipv4EipAddress = "string",
            Ipv4EipId = "string",
            Ipv4HcStatus = "string",
            Ipv6Address = "string",
            Ipv6EipId = "string",
            Ipv6HcStatus = "string",
        },
    },
    VpcId = "string",
    Region = "string",
    ModificationProtectionStatus = "string",
    Ipv6BandwidthPackageId = "string",
    LoadBalancerName = "string",
    ModificationProtectionReason = "string",
    AccessLogConfig = new Volcengine.Nlb.Inputs.NetworkLoadBalancerAccessLogConfigArgs
    {
        Enabled = false,
        ProjectName = "string",
        TopicId = "string",
        TopicName = "string",
    },
    Ipv4BandwidthPackageId = "string",
    ProjectName = "string",
    IpAddressVersion = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Volcengine.Nlb.Inputs.NetworkLoadBalancerTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Description = "string",
    CrossZoneEnabled = false,
});

    example, err := nlb.NewNetworkLoadBalancer(ctx, "networkLoadBalancerResource", &nlb.NetworkLoadBalancerArgs{
	NetworkType: pulumi.String("string"),
	ZoneMappings: nlb.NetworkLoadBalancerZoneMappingArray{
		&nlb.NetworkLoadBalancerZoneMappingArgs{
			SubnetId:       pulumi.String("string"),
			ZoneId:         pulumi.String("string"),
			EipId:          pulumi.String("string"),
			EniId:          pulumi.String("string"),
			Ipv4Address:    pulumi.String("string"),
			Ipv4EipAddress: pulumi.String("string"),
			Ipv4EipId:      pulumi.String("string"),
			Ipv4HcStatus:   pulumi.String("string"),
			Ipv6Address:    pulumi.String("string"),
			Ipv6EipId:      pulumi.String("string"),
			Ipv6HcStatus:   pulumi.String("string"),
		},
	},
	VpcId:                        pulumi.String("string"),
	Region:                       pulumi.String("string"),
	ModificationProtectionStatus: pulumi.String("string"),
	Ipv6BandwidthPackageId:       pulumi.String("string"),
	LoadBalancerName:             pulumi.String("string"),
	ModificationProtectionReason: pulumi.String("string"),
	AccessLogConfig: &nlb.NetworkLoadBalancerAccessLogConfigArgs{
		Enabled:     pulumi.Bool(false),
		ProjectName: pulumi.String("string"),
		TopicId:     pulumi.String("string"),
		TopicName:   pulumi.String("string"),
	},
	Ipv4BandwidthPackageId: pulumi.String("string"),
	ProjectName:            pulumi.String("string"),
	IpAddressVersion:       pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: nlb.NetworkLoadBalancerTagArray{
		&nlb.NetworkLoadBalancerTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Description:      pulumi.String("string"),
	CrossZoneEnabled: pulumi.Bool(false),
})

    var networkLoadBalancerResource = new NetworkLoadBalancer("networkLoadBalancerResource", NetworkLoadBalancerArgs.builder()
    .networkType("string")
    .zoneMappings(NetworkLoadBalancerZoneMappingArgs.builder()
        .subnetId("string")
        .zoneId("string")
        .eipId("string")
        .eniId("string")
        .ipv4Address("string")
        .ipv4EipAddress("string")
        .ipv4EipId("string")
        .ipv4HcStatus("string")
        .ipv6Address("string")
        .ipv6EipId("string")
        .ipv6HcStatus("string")
        .build())
    .vpcId("string")
    .region("string")
    .modificationProtectionStatus("string")
    .ipv6BandwidthPackageId("string")
    .loadBalancerName("string")
    .modificationProtectionReason("string")
    .accessLogConfig(NetworkLoadBalancerAccessLogConfigArgs.builder()
        .enabled(false)
        .projectName("string")
        .topicId("string")
        .topicName("string")
        .build())
    .ipv4BandwidthPackageId("string")
    .projectName("string")
    .ipAddressVersion("string")
    .securityGroupIds("string")
    .tags(NetworkLoadBalancerTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .description("string")
    .crossZoneEnabled(false)
    .build());

    network_load_balancer_resource = volcengine.nlb.NetworkLoadBalancer("networkLoadBalancerResource",
    network_type="string",
    zone_mappings=[{
        "subnet_id": "string",
        "zone_id": "string",
        "eip_id": "string",
        "eni_id": "string",
        "ipv4_address": "string",
        "ipv4_eip_address": "string",
        "ipv4_eip_id": "string",
        "ipv4_hc_status": "string",
        "ipv6_address": "string",
        "ipv6_eip_id": "string",
        "ipv6_hc_status": "string",
    }],
    vpc_id="string",
    region="string",
    modification_protection_status="string",
    ipv6_bandwidth_package_id="string",
    load_balancer_name="string",
    modification_protection_reason="string",
    access_log_config={
        "enabled": False,
        "project_name": "string",
        "topic_id": "string",
        "topic_name": "string",
    },
    ipv4_bandwidth_package_id="string",
    project_name="string",
    ip_address_version="string",
    security_group_ids=["string"],
    tags=[{
        "key": "string",
        "value": "string",
    }],
    description="string",
    cross_zone_enabled=False)

    const networkLoadBalancerResource = new volcengine.nlb.NetworkLoadBalancer("networkLoadBalancerResource", {
    networkType: "string",
    zoneMappings: [{
        subnetId: "string",
        zoneId: "string",
        eipId: "string",
        eniId: "string",
        ipv4Address: "string",
        ipv4EipAddress: "string",
        ipv4EipId: "string",
        ipv4HcStatus: "string",
        ipv6Address: "string",
        ipv6EipId: "string",
        ipv6HcStatus: "string",
    }],
    vpcId: "string",
    region: "string",
    modificationProtectionStatus: "string",
    ipv6BandwidthPackageId: "string",
    loadBalancerName: "string",
    modificationProtectionReason: "string",
    accessLogConfig: {
        enabled: false,
        projectName: "string",
        topicId: "string",
        topicName: "string",
    },
    ipv4BandwidthPackageId: "string",
    projectName: "string",
    ipAddressVersion: "string",
    securityGroupIds: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    description: "string",
    crossZoneEnabled: false,
});

    type: volcengine:nlb:NetworkLoadBalancer
properties:
    accessLogConfig:
        enabled: false
        projectName: string
        topicId: string
        topicName: string
    crossZoneEnabled: false
    description: string
    ipAddressVersion: string
    ipv4BandwidthPackageId: string
    ipv6BandwidthPackageId: string
    loadBalancerName: string
    modificationProtectionReason: string
    modificationProtectionStatus: string
    networkType: string
    projectName: string
    region: string
    securityGroupIds:
        - string
    tags:
        - key: string
          value: string
    vpcId: string
    zoneMappings:
        - eipId: string
          eniId: string
          ipv4Address: string
          ipv4EipAddress: string
          ipv4EipId: string
          ipv4HcStatus: string
          ipv6Address: string
          ipv6EipId: string
          ipv6HcStatus: string
          subnetId: string
          zoneId: string

    NetworkLoadBalancer 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 NetworkLoadBalancer resource accepts the following input properties:

    NetworkType 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.
    Region string
    The region of the NLB instance.
    VpcId string
    The ID of the VPC where the NLB instance is deployed.
    ZoneMappings List<NetworkLoadBalancerZoneMapping>
    The zone mappings of the NLB instance.
    AccessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    CrossZoneEnabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    Description string
    The description of the NLB instance.
    IpAddressVersion 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.
    Ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    Ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    LoadBalancerName string
    The name of the NLB instance.
    ModificationProtectionReason string
    The reason for modification protection.
    ModificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    ProjectName string
    The project name of the NLB instance.
    SecurityGroupIds List<string>
    The security group IDs of the NLB instance.
    Tags List<NetworkLoadBalancerTag>
    Tags.
    NetworkType 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.
    Region string
    The region of the NLB instance.
    VpcId string
    The ID of the VPC where the NLB instance is deployed.
    ZoneMappings []NetworkLoadBalancerZoneMappingArgs
    The zone mappings of the NLB instance.
    AccessLogConfig NetworkLoadBalancerAccessLogConfigArgs
    The access log configuration of the NLB instance.
    CrossZoneEnabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    Description string
    The description of the NLB instance.
    IpAddressVersion 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.
    Ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    Ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    LoadBalancerName string
    The name of the NLB instance.
    ModificationProtectionReason string
    The reason for modification protection.
    ModificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    ProjectName string
    The project name of the NLB instance.
    SecurityGroupIds []string
    The security group IDs of the NLB instance.
    Tags []NetworkLoadBalancerTagArgs
    Tags.
    networkType 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.
    region String
    The region of the NLB instance.
    vpcId String
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings List<NetworkLoadBalancerZoneMapping>
    The zone mappings of the NLB instance.
    accessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    crossZoneEnabled Boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description String
    The description of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId String
    The ID of the IPv4 bandwidth package.
    ipv6BandwidthPackageId String
    The ID of the IPv6 bandwidth package.
    loadBalancerName String
    The name of the NLB instance.
    modificationProtectionReason String
    The reason for modification protection.
    modificationProtectionStatus String
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    projectName String
    The project name of the NLB instance.
    securityGroupIds List<String>
    The security group IDs of the NLB instance.
    tags List<NetworkLoadBalancerTag>
    Tags.
    networkType 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.
    region string
    The region of the NLB instance.
    vpcId string
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings NetworkLoadBalancerZoneMapping[]
    The zone mappings of the NLB instance.
    accessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    crossZoneEnabled boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description string
    The description of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    loadBalancerName string
    The name of the NLB instance.
    modificationProtectionReason string
    The reason for modification protection.
    modificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    projectName string
    The project name of the NLB instance.
    securityGroupIds string[]
    The security group IDs of the NLB instance.
    tags NetworkLoadBalancerTag[]
    Tags.
    network_type str
    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.
    region str
    The region of the NLB instance.
    vpc_id str
    The ID of the VPC where the NLB instance is deployed.
    zone_mappings Sequence[NetworkLoadBalancerZoneMappingArgs]
    The zone mappings of the NLB instance.
    access_log_config NetworkLoadBalancerAccessLogConfigArgs
    The access log configuration of the NLB instance.
    cross_zone_enabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description str
    The description of the NLB instance.
    ip_address_version str
    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.
    ipv4_bandwidth_package_id str
    The ID of the IPv4 bandwidth package.
    ipv6_bandwidth_package_id str
    The ID of the IPv6 bandwidth package.
    load_balancer_name str
    The name of the NLB instance.
    modification_protection_reason str
    The reason for modification protection.
    modification_protection_status str
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    project_name str
    The project name of the NLB instance.
    security_group_ids Sequence[str]
    The security group IDs of the NLB instance.
    tags Sequence[NetworkLoadBalancerTagArgs]
    Tags.
    networkType 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.
    region String
    The region of the NLB instance.
    vpcId String
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings List<Property Map>
    The zone mappings of the NLB instance.
    accessLogConfig Property Map
    The access log configuration of the NLB instance.
    crossZoneEnabled Boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description String
    The description of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId String
    The ID of the IPv4 bandwidth package.
    ipv6BandwidthPackageId String
    The ID of the IPv6 bandwidth package.
    loadBalancerName String
    The name of the NLB instance.
    modificationProtectionReason String
    The reason for modification protection.
    modificationProtectionStatus String
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    projectName String
    The project name of the NLB instance.
    securityGroupIds List<String>
    The security group IDs of the NLB instance.
    tags List<Property Map>
    Tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NetworkLoadBalancer resource produces the following output properties:

    AccountId string
    The account ID of the NLB instance.
    BillingStatus string
    The billing status of the NLB instance.
    CreateTime string
    The creation time of the NLB instance.
    DnsName string
    The DNS name of the NLB instance.
    ExpectedOverdueTime string
    The expected overdue time of the NLB instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    Ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    ManagedSecurityGroupId string
    The managed security group ID of the NLB instance.
    OverdueTime string
    The overdue time of the NLB instance.
    ReclaimedTime string
    The reclaimed time of the NLB instance.
    Status string
    The status of the NLB instance.
    UpdateTime string
    The update time of the NLB instance.
    AccountId string
    The account ID of the NLB instance.
    BillingStatus string
    The billing status of the NLB instance.
    CreateTime string
    The creation time of the NLB instance.
    DnsName string
    The DNS name of the NLB instance.
    ExpectedOverdueTime string
    The expected overdue time of the NLB instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    Ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    ManagedSecurityGroupId string
    The managed security group ID of the NLB instance.
    OverdueTime string
    The overdue time of the NLB instance.
    ReclaimedTime string
    The reclaimed time of the NLB instance.
    Status string
    The status of the NLB instance.
    UpdateTime string
    The update time of the NLB instance.
    accountId String
    The account ID of the NLB instance.
    billingStatus String
    The billing status of the NLB instance.
    createTime String
    The creation time of the NLB instance.
    dnsName String
    The DNS name of the NLB instance.
    expectedOverdueTime String
    The expected overdue time of the NLB instance.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4NetworkType String
    The IPv4 network type of the NLB instance.
    ipv6NetworkType String
    The IPv6 network type of the NLB instance.
    managedSecurityGroupId String
    The managed security group ID of the NLB instance.
    overdueTime String
    The overdue time of the NLB instance.
    reclaimedTime String
    The reclaimed time of the NLB instance.
    status String
    The status of the NLB instance.
    updateTime String
    The update time of the NLB instance.
    accountId string
    The account ID of the NLB instance.
    billingStatus string
    The billing status of the NLB instance.
    createTime string
    The creation time of the NLB instance.
    dnsName string
    The DNS name of the NLB instance.
    expectedOverdueTime string
    The expected overdue time of the NLB instance.
    id string
    The provider-assigned unique ID for this managed resource.
    ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    managedSecurityGroupId string
    The managed security group ID of the NLB instance.
    overdueTime string
    The overdue time of the NLB instance.
    reclaimedTime string
    The reclaimed time of the NLB instance.
    status string
    The status of the NLB instance.
    updateTime string
    The update time of the NLB instance.
    account_id str
    The account ID of the NLB instance.
    billing_status str
    The billing status of the NLB instance.
    create_time str
    The creation time of the NLB instance.
    dns_name str
    The DNS name of the NLB instance.
    expected_overdue_time str
    The expected overdue time of the NLB instance.
    id str
    The provider-assigned unique ID for this managed resource.
    ipv4_network_type str
    The IPv4 network type of the NLB instance.
    ipv6_network_type str
    The IPv6 network type of the NLB instance.
    managed_security_group_id str
    The managed security group ID of the NLB instance.
    overdue_time str
    The overdue time of the NLB instance.
    reclaimed_time str
    The reclaimed time of the NLB instance.
    status str
    The status of the NLB instance.
    update_time str
    The update time of the NLB instance.
    accountId String
    The account ID of the NLB instance.
    billingStatus String
    The billing status of the NLB instance.
    createTime String
    The creation time of the NLB instance.
    dnsName String
    The DNS name of the NLB instance.
    expectedOverdueTime String
    The expected overdue time of the NLB instance.
    id String
    The provider-assigned unique ID for this managed resource.
    ipv4NetworkType String
    The IPv4 network type of the NLB instance.
    ipv6NetworkType String
    The IPv6 network type of the NLB instance.
    managedSecurityGroupId String
    The managed security group ID of the NLB instance.
    overdueTime String
    The overdue time of the NLB instance.
    reclaimedTime String
    The reclaimed time of the NLB instance.
    status String
    The status of the NLB instance.
    updateTime String
    The update time of the NLB instance.

    Look up Existing NetworkLoadBalancer Resource

    Get an existing NetworkLoadBalancer 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?: NetworkLoadBalancerState, opts?: CustomResourceOptions): NetworkLoadBalancer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_log_config: Optional[NetworkLoadBalancerAccessLogConfigArgs] = None,
        account_id: Optional[str] = None,
        billing_status: Optional[str] = None,
        create_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_name: Optional[str] = None,
        managed_security_group_id: Optional[str] = None,
        modification_protection_reason: Optional[str] = None,
        modification_protection_status: Optional[str] = None,
        network_type: Optional[str] = None,
        overdue_time: Optional[str] = None,
        project_name: Optional[str] = None,
        reclaimed_time: Optional[str] = None,
        region: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[NetworkLoadBalancerTagArgs]] = None,
        update_time: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_mappings: Optional[Sequence[NetworkLoadBalancerZoneMappingArgs]] = None) -> NetworkLoadBalancer
    func GetNetworkLoadBalancer(ctx *Context, name string, id IDInput, state *NetworkLoadBalancerState, opts ...ResourceOption) (*NetworkLoadBalancer, error)
    public static NetworkLoadBalancer Get(string name, Input<string> id, NetworkLoadBalancerState? state, CustomResourceOptions? opts = null)
    public static NetworkLoadBalancer get(String name, Output<String> id, NetworkLoadBalancerState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:nlb:NetworkLoadBalancer    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.
    The following state arguments are supported:
    AccessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    AccountId string
    The account ID of the NLB instance.
    BillingStatus string
    The billing status of the NLB instance.
    CreateTime string
    The creation time of the NLB instance.
    CrossZoneEnabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    Description string
    The description of the NLB instance.
    DnsName string
    The DNS name of the NLB instance.
    ExpectedOverdueTime string
    The expected overdue time of the NLB instance.
    IpAddressVersion 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.
    Ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    Ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    Ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    Ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    LoadBalancerName string
    The name of the NLB instance.
    ManagedSecurityGroupId string
    The managed security group ID of the NLB instance.
    ModificationProtectionReason string
    The reason for modification protection.
    ModificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    NetworkType 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.
    OverdueTime string
    The overdue time of the NLB instance.
    ProjectName string
    The project name of the NLB instance.
    ReclaimedTime string
    The reclaimed time of the NLB instance.
    Region string
    The region of the NLB instance.
    SecurityGroupIds List<string>
    The security group IDs of the NLB instance.
    Status string
    The status of the NLB instance.
    Tags List<NetworkLoadBalancerTag>
    Tags.
    UpdateTime string
    The update time of the NLB instance.
    VpcId string
    The ID of the VPC where the NLB instance is deployed.
    ZoneMappings List<NetworkLoadBalancerZoneMapping>
    The zone mappings of the NLB instance.
    AccessLogConfig NetworkLoadBalancerAccessLogConfigArgs
    The access log configuration of the NLB instance.
    AccountId string
    The account ID of the NLB instance.
    BillingStatus string
    The billing status of the NLB instance.
    CreateTime string
    The creation time of the NLB instance.
    CrossZoneEnabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    Description string
    The description of the NLB instance.
    DnsName string
    The DNS name of the NLB instance.
    ExpectedOverdueTime string
    The expected overdue time of the NLB instance.
    IpAddressVersion 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.
    Ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    Ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    Ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    Ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    LoadBalancerName string
    The name of the NLB instance.
    ManagedSecurityGroupId string
    The managed security group ID of the NLB instance.
    ModificationProtectionReason string
    The reason for modification protection.
    ModificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    NetworkType 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.
    OverdueTime string
    The overdue time of the NLB instance.
    ProjectName string
    The project name of the NLB instance.
    ReclaimedTime string
    The reclaimed time of the NLB instance.
    Region string
    The region of the NLB instance.
    SecurityGroupIds []string
    The security group IDs of the NLB instance.
    Status string
    The status of the NLB instance.
    Tags []NetworkLoadBalancerTagArgs
    Tags.
    UpdateTime string
    The update time of the NLB instance.
    VpcId string
    The ID of the VPC where the NLB instance is deployed.
    ZoneMappings []NetworkLoadBalancerZoneMappingArgs
    The zone mappings of the NLB instance.
    accessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    accountId String
    The account ID of the NLB instance.
    billingStatus String
    The billing status of the NLB instance.
    createTime String
    The creation time of the NLB instance.
    crossZoneEnabled Boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description String
    The description of the NLB instance.
    dnsName String
    The DNS name of the NLB instance.
    expectedOverdueTime String
    The expected overdue time of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId String
    The ID of the IPv4 bandwidth package.
    ipv4NetworkType String
    The IPv4 network type of the NLB instance.
    ipv6BandwidthPackageId String
    The ID of the IPv6 bandwidth package.
    ipv6NetworkType String
    The IPv6 network type of the NLB instance.
    loadBalancerName String
    The name of the NLB instance.
    managedSecurityGroupId String
    The managed security group ID of the NLB instance.
    modificationProtectionReason String
    The reason for modification protection.
    modificationProtectionStatus String
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    networkType 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.
    overdueTime String
    The overdue time of the NLB instance.
    projectName String
    The project name of the NLB instance.
    reclaimedTime String
    The reclaimed time of the NLB instance.
    region String
    The region of the NLB instance.
    securityGroupIds List<String>
    The security group IDs of the NLB instance.
    status String
    The status of the NLB instance.
    tags List<NetworkLoadBalancerTag>
    Tags.
    updateTime String
    The update time of the NLB instance.
    vpcId String
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings List<NetworkLoadBalancerZoneMapping>
    The zone mappings of the NLB instance.
    accessLogConfig NetworkLoadBalancerAccessLogConfig
    The access log configuration of the NLB instance.
    accountId string
    The account ID of the NLB instance.
    billingStatus string
    The billing status of the NLB instance.
    createTime string
    The creation time of the NLB instance.
    crossZoneEnabled boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description string
    The description of the NLB instance.
    dnsName string
    The DNS name of the NLB instance.
    expectedOverdueTime string
    The expected overdue time of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId string
    The ID of the IPv4 bandwidth package.
    ipv4NetworkType string
    The IPv4 network type of the NLB instance.
    ipv6BandwidthPackageId string
    The ID of the IPv6 bandwidth package.
    ipv6NetworkType string
    The IPv6 network type of the NLB instance.
    loadBalancerName string
    The name of the NLB instance.
    managedSecurityGroupId string
    The managed security group ID of the NLB instance.
    modificationProtectionReason string
    The reason for modification protection.
    modificationProtectionStatus string
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    networkType 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.
    overdueTime string
    The overdue time of the NLB instance.
    projectName string
    The project name of the NLB instance.
    reclaimedTime string
    The reclaimed time of the NLB instance.
    region string
    The region of the NLB instance.
    securityGroupIds string[]
    The security group IDs of the NLB instance.
    status string
    The status of the NLB instance.
    tags NetworkLoadBalancerTag[]
    Tags.
    updateTime string
    The update time of the NLB instance.
    vpcId string
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings NetworkLoadBalancerZoneMapping[]
    The zone mappings of the NLB instance.
    access_log_config NetworkLoadBalancerAccessLogConfigArgs
    The access log configuration of the NLB instance.
    account_id str
    The account ID of the NLB instance.
    billing_status str
    The billing status of the NLB instance.
    create_time str
    The creation time of the NLB instance.
    cross_zone_enabled bool
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description str
    The description of the NLB instance.
    dns_name str
    The DNS name of the NLB instance.
    expected_overdue_time str
    The expected overdue time of the NLB instance.
    ip_address_version str
    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.
    ipv4_bandwidth_package_id str
    The ID of the IPv4 bandwidth package.
    ipv4_network_type str
    The IPv4 network type of the NLB instance.
    ipv6_bandwidth_package_id str
    The ID of the IPv6 bandwidth package.
    ipv6_network_type str
    The IPv6 network type of the NLB instance.
    load_balancer_name str
    The name of the NLB instance.
    managed_security_group_id str
    The managed security group ID of the NLB instance.
    modification_protection_reason str
    The reason for modification protection.
    modification_protection_status str
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    network_type str
    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.
    overdue_time str
    The overdue time of the NLB instance.
    project_name str
    The project name of the NLB instance.
    reclaimed_time str
    The reclaimed time of the NLB instance.
    region str
    The region of the NLB instance.
    security_group_ids Sequence[str]
    The security group IDs of the NLB instance.
    status str
    The status of the NLB instance.
    tags Sequence[NetworkLoadBalancerTagArgs]
    Tags.
    update_time str
    The update time of the NLB instance.
    vpc_id str
    The ID of the VPC where the NLB instance is deployed.
    zone_mappings Sequence[NetworkLoadBalancerZoneMappingArgs]
    The zone mappings of the NLB instance.
    accessLogConfig Property Map
    The access log configuration of the NLB instance.
    accountId String
    The account ID of the NLB instance.
    billingStatus String
    The billing status of the NLB instance.
    createTime String
    The creation time of the NLB instance.
    crossZoneEnabled Boolean
    Whether to enable cross-zone load balancing for the NLB instance. Valid values: true, false. true: Enable. false: Disable.
    description String
    The description of the NLB instance.
    dnsName String
    The DNS name of the NLB instance.
    expectedOverdueTime String
    The expected overdue time of the NLB instance.
    ipAddressVersion 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.
    ipv4BandwidthPackageId String
    The ID of the IPv4 bandwidth package.
    ipv4NetworkType String
    The IPv4 network type of the NLB instance.
    ipv6BandwidthPackageId String
    The ID of the IPv6 bandwidth package.
    ipv6NetworkType String
    The IPv6 network type of the NLB instance.
    loadBalancerName String
    The name of the NLB instance.
    managedSecurityGroupId String
    The managed security group ID of the NLB instance.
    modificationProtectionReason String
    The reason for modification protection.
    modificationProtectionStatus String
    The modification protection status of the NLB instance. Valid values: NonProtection, ConsoleProtection. NonProtection: No protection. ConsoleProtection: Console protection.
    networkType 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.
    overdueTime String
    The overdue time of the NLB instance.
    projectName String
    The project name of the NLB instance.
    reclaimedTime String
    The reclaimed time of the NLB instance.
    region String
    The region of the NLB instance.
    securityGroupIds List<String>
    The security group IDs of the NLB instance.
    status String
    The status of the NLB instance.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of the NLB instance.
    vpcId String
    The ID of the VPC where the NLB instance is deployed.
    zoneMappings List<Property Map>
    The zone mappings of the NLB instance.

    Supporting Types

    NetworkLoadBalancerAccessLogConfig, NetworkLoadBalancerAccessLogConfigArgs

    Enabled bool
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    ProjectName string
    The project name where the access log topic resides.
    TopicId string
    The topic ID of the access log.
    TopicName string
    The topic name of the access log.
    Enabled bool
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    ProjectName string
    The project name where the access log topic resides.
    TopicId string
    The topic ID of the access log.
    TopicName string
    The topic name of the access log.
    enabled Boolean
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    projectName String
    The project name where the access log topic resides.
    topicId String
    The topic ID of the access log.
    topicName String
    The topic name of the access log.
    enabled boolean
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    projectName string
    The project name where the access log topic resides.
    topicId string
    The topic ID of the access log.
    topicName string
    The topic name of the access log.
    enabled bool
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    project_name str
    The project name where the access log topic resides.
    topic_id str
    The topic ID of the access log.
    topic_name str
    The topic name of the access log.
    enabled Boolean
    Whether to enable access logging. Valid values: true, false. true: Enable. false: Disable.
    projectName String
    The project name where the access log topic resides.
    topicId String
    The topic ID of the access log.
    topicName String
    The topic name of the access log.

    NetworkLoadBalancerTag, NetworkLoadBalancerTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    NetworkLoadBalancerZoneMapping, NetworkLoadBalancerZoneMappingArgs

    SubnetId string
    The ID of the subnet.
    ZoneId string
    The ID of the zone.
    EipId string
    The ID of the EIP.
    EniId string
    The ID of the ENI.
    Ipv4Address string
    The IPv4 address of the NLB instance.
    Ipv4EipAddress string
    The public IPv4 address.
    Ipv4EipId string
    The ID of the EIP.
    Ipv4HcStatus string
    The IPv4 health check status.
    Ipv6Address string
    The IPv6 address of the NLB instance.
    Ipv6EipId string
    The ID of the IPv6 EIP.
    Ipv6HcStatus string
    The IPv6 health check status.
    SubnetId string
    The ID of the subnet.
    ZoneId string
    The ID of the zone.
    EipId string
    The ID of the EIP.
    EniId string
    The ID of the ENI.
    Ipv4Address string
    The IPv4 address of the NLB instance.
    Ipv4EipAddress string
    The public IPv4 address.
    Ipv4EipId string
    The ID of the EIP.
    Ipv4HcStatus string
    The IPv4 health check status.
    Ipv6Address string
    The IPv6 address of the NLB instance.
    Ipv6EipId string
    The ID of the IPv6 EIP.
    Ipv6HcStatus string
    The IPv6 health check status.
    subnetId String
    The ID of the subnet.
    zoneId String
    The ID of the zone.
    eipId String
    The ID of the EIP.
    eniId String
    The ID of the ENI.
    ipv4Address String
    The IPv4 address of the NLB instance.
    ipv4EipAddress String
    The public IPv4 address.
    ipv4EipId String
    The ID of the EIP.
    ipv4HcStatus String
    The IPv4 health check status.
    ipv6Address String
    The IPv6 address of the NLB instance.
    ipv6EipId String
    The ID of the IPv6 EIP.
    ipv6HcStatus String
    The IPv6 health check status.
    subnetId string
    The ID of the subnet.
    zoneId string
    The ID of the zone.
    eipId string
    The ID of the EIP.
    eniId string
    The ID of the ENI.
    ipv4Address string
    The IPv4 address of the NLB instance.
    ipv4EipAddress string
    The public IPv4 address.
    ipv4EipId string
    The ID of the EIP.
    ipv4HcStatus string
    The IPv4 health check status.
    ipv6Address string
    The IPv6 address of the NLB instance.
    ipv6EipId string
    The ID of the IPv6 EIP.
    ipv6HcStatus string
    The IPv6 health check status.
    subnet_id str
    The ID of the subnet.
    zone_id str
    The ID of the zone.
    eip_id str
    The ID of the EIP.
    eni_id str
    The ID of the ENI.
    ipv4_address str
    The IPv4 address of the NLB instance.
    ipv4_eip_address str
    The public IPv4 address.
    ipv4_eip_id str
    The ID of the EIP.
    ipv4_hc_status str
    The IPv4 health check status.
    ipv6_address str
    The IPv6 address of the NLB instance.
    ipv6_eip_id str
    The ID of the IPv6 EIP.
    ipv6_hc_status str
    The IPv6 health check status.
    subnetId String
    The ID of the subnet.
    zoneId String
    The ID of the zone.
    eipId String
    The ID of the EIP.
    eniId String
    The ID of the ENI.
    ipv4Address String
    The IPv4 address of the NLB instance.
    ipv4EipAddress String
    The public IPv4 address.
    ipv4EipId String
    The ID of the EIP.
    ipv4HcStatus String
    The IPv4 health check status.
    ipv6Address String
    The IPv6 address of the NLB instance.
    ipv6EipId String
    The ID of the IPv6 EIP.
    ipv6HcStatus String
    The IPv6 health check status.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.