Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Yandex
  3. API Docs
  4. LbNetworkLoadBalancer
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

yandex.LbNetworkLoadBalancer

Explore with Pulumi AI

yandex logo
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
pulumi/pulumi-yandex

    Creates a network load balancer in the specified folder using the data specified in the config. For more information, see the official documentation.

    Example Usage

    using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Yandex.LbNetworkLoadBalancer("foo", new Yandex.LbNetworkLoadBalancerArgs
        {
            AttachedTargetGroups = 
            {
                new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupArgs
                {
                    Healthchecks = 
                    {
                        new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs
                        {
                            HttpOptions = new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs
                            {
                                Path = "/ping",
                                Port = 8080,
                            },
                            Name = "http",
                        },
                    },
                    TargetGroupId = yandex_lb_target_group.My_target_group.Id,
                },
            },
            Listeners = 
            {
                new Yandex.Inputs.LbNetworkLoadBalancerListenerArgs
                {
                    ExternalAddressSpec = new Yandex.Inputs.LbNetworkLoadBalancerListenerExternalAddressSpecArgs
                    {
                        IpVersion = "ipv4",
                    },
                    Name = "my-listener",
                    Port = 8080,
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := yandex.NewLbNetworkLoadBalancer(ctx, "foo", &yandex.LbNetworkLoadBalancerArgs{
			AttachedTargetGroups: LbNetworkLoadBalancerAttachedTargetGroupArray{
				&LbNetworkLoadBalancerAttachedTargetGroupArgs{
					Healthchecks: LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArray{
						&LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs{
							HttpOptions: &LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs{
								Path: pulumi.String("/ping"),
								Port: pulumi.Int(8080),
							},
							Name: pulumi.String("http"),
						},
					},
					TargetGroupId: pulumi.Any(yandex_lb_target_group.My - target - group.Id),
				},
			},
			Listeners: LbNetworkLoadBalancerListenerArray{
				&LbNetworkLoadBalancerListenerArgs{
					ExternalAddressSpec: &LbNetworkLoadBalancerListenerExternalAddressSpecArgs{
						IpVersion: pulumi.String("ipv4"),
					},
					Name: pulumi.String("my-listener"),
					Port: pulumi.Int(8080),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const foo = new yandex.LbNetworkLoadBalancer("foo", {
    attachedTargetGroups: [{
        healthchecks: [{
            httpOptions: {
                path: "/ping",
                port: 8080,
            },
            name: "http",
        }],
        targetGroupId: yandex_lb_target_group_my_target_group.id,
    }],
    listeners: [{
        externalAddressSpec: {
            ipVersion: "ipv4",
        },
        name: "my-listener",
        port: 8080,
    }],
});

    import pulumi
import pulumi_yandex as yandex

foo = yandex.LbNetworkLoadBalancer("foo",
    attached_target_groups=[yandex.LbNetworkLoadBalancerAttachedTargetGroupArgs(
        healthchecks=[yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs(
            http_options=yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs(
                path="/ping",
                port=8080,
            ),
            name="http",
        )],
        target_group_id=yandex_lb_target_group["my-target-group"]["id"],
    )],
    listeners=[yandex.LbNetworkLoadBalancerListenerArgs(
        external_address_spec=yandex.LbNetworkLoadBalancerListenerExternalAddressSpecArgs(
            ip_version="ipv4",
        ),
        name="my-listener",
        port=8080,
    )])

    Example coming soon!

    Create LbNetworkLoadBalancer Resource

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

    Constructor syntax

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

@overload
def LbNetworkLoadBalancer(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          attached_target_groups: Optional[Sequence[LbNetworkLoadBalancerAttachedTargetGroupArgs]] = None,
                          description: Optional[str] = None,
                          folder_id: Optional[str] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          listeners: Optional[Sequence[LbNetworkLoadBalancerListenerArgs]] = None,
                          name: Optional[str] = None,
                          region_id: Optional[str] = None,
                          type: Optional[str] = None)
    func NewLbNetworkLoadBalancer(ctx *Context, name string, args *LbNetworkLoadBalancerArgs, opts ...ResourceOption) (*LbNetworkLoadBalancer, error)
    public LbNetworkLoadBalancer(string name, LbNetworkLoadBalancerArgs? args = null, CustomResourceOptions? opts = null)
    public LbNetworkLoadBalancer(String name, LbNetworkLoadBalancerArgs args)
public LbNetworkLoadBalancer(String name, LbNetworkLoadBalancerArgs args, CustomResourceOptions options)

    type: yandex:LbNetworkLoadBalancer
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 LbNetworkLoadBalancerArgs
    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 LbNetworkLoadBalancerArgs
    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 LbNetworkLoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbNetworkLoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbNetworkLoadBalancerArgs
    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 lbNetworkLoadBalancerResource = new Yandex.LbNetworkLoadBalancer("lbNetworkLoadBalancerResource", new()
{
    AttachedTargetGroups = new[]
    {
        new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupArgs
        {
            Healthchecks = new[]
            {
                new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs
                {
                    Name = "string",
                    HealthyThreshold = 0,
                    HttpOptions = new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs
                    {
                        Port = 0,
                        Path = "string",
                    },
                    Interval = 0,
                    TcpOptions = new Yandex.Inputs.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptionsArgs
                    {
                        Port = 0,
                    },
                    Timeout = 0,
                    UnhealthyThreshold = 0,
                },
            },
            TargetGroupId = "string",
        },
    },
    Description = "string",
    FolderId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Listeners = new[]
    {
        new Yandex.Inputs.LbNetworkLoadBalancerListenerArgs
        {
            Name = "string",
            Port = 0,
            ExternalAddressSpec = new Yandex.Inputs.LbNetworkLoadBalancerListenerExternalAddressSpecArgs
            {
                Address = "string",
                IpVersion = "string",
            },
            InternalAddressSpec = new Yandex.Inputs.LbNetworkLoadBalancerListenerInternalAddressSpecArgs
            {
                SubnetId = "string",
                Address = "string",
                IpVersion = "string",
            },
            Protocol = "string",
            TargetPort = 0,
        },
    },
    Name = "string",
    RegionId = "string",
    Type = "string",
});

    example, err := yandex.NewLbNetworkLoadBalancer(ctx, "lbNetworkLoadBalancerResource", &yandex.LbNetworkLoadBalancerArgs{
	AttachedTargetGroups: yandex.LbNetworkLoadBalancerAttachedTargetGroupArray{
		&yandex.LbNetworkLoadBalancerAttachedTargetGroupArgs{
			Healthchecks: yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArray{
				&yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs{
					Name:             pulumi.String("string"),
					HealthyThreshold: pulumi.Int(0),
					HttpOptions: &yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs{
						Port: pulumi.Int(0),
						Path: pulumi.String("string"),
					},
					Interval: pulumi.Int(0),
					TcpOptions: &yandex.LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptionsArgs{
						Port: pulumi.Int(0),
					},
					Timeout:            pulumi.Int(0),
					UnhealthyThreshold: pulumi.Int(0),
				},
			},
			TargetGroupId: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	FolderId:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Listeners: yandex.LbNetworkLoadBalancerListenerArray{
		&yandex.LbNetworkLoadBalancerListenerArgs{
			Name: pulumi.String("string"),
			Port: pulumi.Int(0),
			ExternalAddressSpec: &yandex.LbNetworkLoadBalancerListenerExternalAddressSpecArgs{
				Address:   pulumi.String("string"),
				IpVersion: pulumi.String("string"),
			},
			InternalAddressSpec: &yandex.LbNetworkLoadBalancerListenerInternalAddressSpecArgs{
				SubnetId:  pulumi.String("string"),
				Address:   pulumi.String("string"),
				IpVersion: pulumi.String("string"),
			},
			Protocol:   pulumi.String("string"),
			TargetPort: pulumi.Int(0),
		},
	},
	Name:     pulumi.String("string"),
	RegionId: pulumi.String("string"),
	Type:     pulumi.String("string"),
})

    var lbNetworkLoadBalancerResource = new LbNetworkLoadBalancer("lbNetworkLoadBalancerResource", LbNetworkLoadBalancerArgs.builder()
    .attachedTargetGroups(LbNetworkLoadBalancerAttachedTargetGroupArgs.builder()
        .healthchecks(LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs.builder()
            .name("string")
            .healthyThreshold(0)
            .httpOptions(LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs.builder()
                .port(0)
                .path("string")
                .build())
            .interval(0)
            .tcpOptions(LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptionsArgs.builder()
                .port(0)
                .build())
            .timeout(0)
            .unhealthyThreshold(0)
            .build())
        .targetGroupId("string")
        .build())
    .description("string")
    .folderId("string")
    .labels(Map.of("string", "string"))
    .listeners(LbNetworkLoadBalancerListenerArgs.builder()
        .name("string")
        .port(0)
        .externalAddressSpec(LbNetworkLoadBalancerListenerExternalAddressSpecArgs.builder()
            .address("string")
            .ipVersion("string")
            .build())
        .internalAddressSpec(LbNetworkLoadBalancerListenerInternalAddressSpecArgs.builder()
            .subnetId("string")
            .address("string")
            .ipVersion("string")
            .build())
        .protocol("string")
        .targetPort(0)
        .build())
    .name("string")
    .regionId("string")
    .type("string")
    .build());

    lb_network_load_balancer_resource = yandex.LbNetworkLoadBalancer("lbNetworkLoadBalancerResource",
    attached_target_groups=[{
        "healthchecks": [{
            "name": "string",
            "healthy_threshold": 0,
            "http_options": {
                "port": 0,
                "path": "string",
            },
            "interval": 0,
            "tcp_options": {
                "port": 0,
            },
            "timeout": 0,
            "unhealthy_threshold": 0,
        }],
        "target_group_id": "string",
    }],
    description="string",
    folder_id="string",
    labels={
        "string": "string",
    },
    listeners=[{
        "name": "string",
        "port": 0,
        "external_address_spec": {
            "address": "string",
            "ip_version": "string",
        },
        "internal_address_spec": {
            "subnet_id": "string",
            "address": "string",
            "ip_version": "string",
        },
        "protocol": "string",
        "target_port": 0,
    }],
    name="string",
    region_id="string",
    type="string")

    const lbNetworkLoadBalancerResource = new yandex.LbNetworkLoadBalancer("lbNetworkLoadBalancerResource", {
    attachedTargetGroups: [{
        healthchecks: [{
            name: "string",
            healthyThreshold: 0,
            httpOptions: {
                port: 0,
                path: "string",
            },
            interval: 0,
            tcpOptions: {
                port: 0,
            },
            timeout: 0,
            unhealthyThreshold: 0,
        }],
        targetGroupId: "string",
    }],
    description: "string",
    folderId: "string",
    labels: {
        string: "string",
    },
    listeners: [{
        name: "string",
        port: 0,
        externalAddressSpec: {
            address: "string",
            ipVersion: "string",
        },
        internalAddressSpec: {
            subnetId: "string",
            address: "string",
            ipVersion: "string",
        },
        protocol: "string",
        targetPort: 0,
    }],
    name: "string",
    regionId: "string",
    type: "string",
});

    type: yandex:LbNetworkLoadBalancer
properties:
    attachedTargetGroups:
        - healthchecks:
            - healthyThreshold: 0
              httpOptions:
                path: string
                port: 0
              interval: 0
              name: string
              tcpOptions:
                port: 0
              timeout: 0
              unhealthyThreshold: 0
          targetGroupId: string
    description: string
    folderId: string
    labels:
        string: string
    listeners:
        - externalAddressSpec:
            address: string
            ipVersion: string
          internalAddressSpec:
            address: string
            ipVersion: string
            subnetId: string
          name: string
          port: 0
          protocol: string
          targetPort: 0
    name: string
    regionId: string
    type: string

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

    AttachedTargetGroups List<LbNetworkLoadBalancerAttachedTargetGroup>
    An AttachedTargetGroup resource. The structure is documented below.
    Description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    FolderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    Labels Dictionary<string, string>
    Labels to assign to this network load balancer. A list of key/value pairs.
    Listeners List<LbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    RegionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    Type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    AttachedTargetGroups []LbNetworkLoadBalancerAttachedTargetGroupArgs
    An AttachedTargetGroup resource. The structure is documented below.
    Description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    FolderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    Labels map[string]string
    Labels to assign to this network load balancer. A list of key/value pairs.
    Listeners []LbNetworkLoadBalancerListenerArgs
    Listener specification that will be used by a network load balancer. The structure is documented below.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    RegionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    Type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups List<LbNetworkLoadBalancerAttachedTargetGroup>
    An AttachedTargetGroup resource. The structure is documented below.
    description String
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId String
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Map<String,String>
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners List<LbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId String
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type String
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups LbNetworkLoadBalancerAttachedTargetGroup[]
    An AttachedTargetGroup resource. The structure is documented below.
    description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels {[key: string]: string}
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners LbNetworkLoadBalancerListener[]
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attached_target_groups Sequence[LbNetworkLoadBalancerAttachedTargetGroupArgs]
    An AttachedTargetGroup resource. The structure is documented below.
    description str
    An optional description of the network load balancer. Provide this property when you create the resource.
    folder_id str
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Mapping[str, str]
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners Sequence[LbNetworkLoadBalancerListenerArgs]
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name str
    Name of the listener. The name must be unique for each listener on a single load balancer.
    region_id str
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type str
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups List<Property Map>
    An AttachedTargetGroup resource. The structure is documented below.
    description String
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId String
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Map<String>
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners List<Property Map>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId String
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type String
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.

    Outputs

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

    CreatedAt string
    The network load balancer creation timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The network load balancer creation timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The network load balancer creation timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The network load balancer creation timestamp.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The network load balancer creation timestamp.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The network load balancer creation timestamp.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LbNetworkLoadBalancer Resource

    Get an existing LbNetworkLoadBalancer 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?: LbNetworkLoadBalancerState, opts?: CustomResourceOptions): LbNetworkLoadBalancer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached_target_groups: Optional[Sequence[LbNetworkLoadBalancerAttachedTargetGroupArgs]] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        folder_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        listeners: Optional[Sequence[LbNetworkLoadBalancerListenerArgs]] = None,
        name: Optional[str] = None,
        region_id: Optional[str] = None,
        type: Optional[str] = None) -> LbNetworkLoadBalancer
    func GetLbNetworkLoadBalancer(ctx *Context, name string, id IDInput, state *LbNetworkLoadBalancerState, opts ...ResourceOption) (*LbNetworkLoadBalancer, error)
    public static LbNetworkLoadBalancer Get(string name, Input<string> id, LbNetworkLoadBalancerState? state, CustomResourceOptions? opts = null)
    public static LbNetworkLoadBalancer get(String name, Output<String> id, LbNetworkLoadBalancerState state, CustomResourceOptions options)
    resources:  _:    type: yandex:LbNetworkLoadBalancer    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:
    AttachedTargetGroups List<LbNetworkLoadBalancerAttachedTargetGroup>
    An AttachedTargetGroup resource. The structure is documented below.
    CreatedAt string
    The network load balancer creation timestamp.
    Description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    FolderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    Labels Dictionary<string, string>
    Labels to assign to this network load balancer. A list of key/value pairs.
    Listeners List<LbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    RegionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    Type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    AttachedTargetGroups []LbNetworkLoadBalancerAttachedTargetGroupArgs
    An AttachedTargetGroup resource. The structure is documented below.
    CreatedAt string
    The network load balancer creation timestamp.
    Description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    FolderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    Labels map[string]string
    Labels to assign to this network load balancer. A list of key/value pairs.
    Listeners []LbNetworkLoadBalancerListenerArgs
    Listener specification that will be used by a network load balancer. The structure is documented below.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    RegionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    Type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups List<LbNetworkLoadBalancerAttachedTargetGroup>
    An AttachedTargetGroup resource. The structure is documented below.
    createdAt String
    The network load balancer creation timestamp.
    description String
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId String
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Map<String,String>
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners List<LbNetworkLoadBalancerListener>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId String
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type String
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups LbNetworkLoadBalancerAttachedTargetGroup[]
    An AttachedTargetGroup resource. The structure is documented below.
    createdAt string
    The network load balancer creation timestamp.
    description string
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId string
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels {[key: string]: string}
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners LbNetworkLoadBalancerListener[]
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId string
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type string
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attached_target_groups Sequence[LbNetworkLoadBalancerAttachedTargetGroupArgs]
    An AttachedTargetGroup resource. The structure is documented below.
    created_at str
    The network load balancer creation timestamp.
    description str
    An optional description of the network load balancer. Provide this property when you create the resource.
    folder_id str
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Mapping[str, str]
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners Sequence[LbNetworkLoadBalancerListenerArgs]
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name str
    Name of the listener. The name must be unique for each listener on a single load balancer.
    region_id str
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type str
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.
    attachedTargetGroups List<Property Map>
    An AttachedTargetGroup resource. The structure is documented below.
    createdAt String
    The network load balancer creation timestamp.
    description String
    An optional description of the network load balancer. Provide this property when you create the resource.
    folderId String
    The ID of the folder to which the resource belongs. If omitted, the provider folder is used.
    labels Map<String>
    Labels to assign to this network load balancer. A list of key/value pairs.
    listeners List<Property Map>
    Listener specification that will be used by a network load balancer. The structure is documented below.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    regionId String
    ID of the availability zone where the network load balancer resides. The default is 'ru-central1'.
    type String
    Type of the network load balancer. Must be one of 'external' or 'internal'. The default is 'external'.

    Supporting Types

    LbNetworkLoadBalancerAttachedTargetGroup, LbNetworkLoadBalancerAttachedTargetGroupArgs

    Healthchecks List<LbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
    A HealthCheck resource. The structure is documented below.
    TargetGroupId string
    ID of the target group.
    Healthchecks []LbNetworkLoadBalancerAttachedTargetGroupHealthcheck
    A HealthCheck resource. The structure is documented below.
    TargetGroupId string
    ID of the target group.
    healthchecks List<LbNetworkLoadBalancerAttachedTargetGroupHealthcheck>
    A HealthCheck resource. The structure is documented below.
    targetGroupId String
    ID of the target group.
    healthchecks LbNetworkLoadBalancerAttachedTargetGroupHealthcheck[]
    A HealthCheck resource. The structure is documented below.
    targetGroupId string
    ID of the target group.
    healthchecks Sequence[LbNetworkLoadBalancerAttachedTargetGroupHealthcheck]
    A HealthCheck resource. The structure is documented below.
    target_group_id str
    ID of the target group.
    healthchecks List<Property Map>
    A HealthCheck resource. The structure is documented below.
    targetGroupId String
    ID of the target group.

    LbNetworkLoadBalancerAttachedTargetGroupHealthcheck, LbNetworkLoadBalancerAttachedTargetGroupHealthcheckArgs

    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    HealthyThreshold int
    Number of successful health checks required in order to set the HEALTHY status for the target.
    HttpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions
    Options for HTTP health check. The structure is documented below.
    Interval int
    The interval between health checks. The default is 2 seconds.
    TcpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions
    Options for TCP health check. The structure is documented below.
    Timeout int
    Timeout for a target to return a response for the health check. The default is 1 second.
    UnhealthyThreshold int
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    HealthyThreshold int
    Number of successful health checks required in order to set the HEALTHY status for the target.
    HttpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions
    Options for HTTP health check. The structure is documented below.
    Interval int
    The interval between health checks. The default is 2 seconds.
    TcpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions
    Options for TCP health check. The structure is documented below.
    Timeout int
    Timeout for a target to return a response for the health check. The default is 1 second.
    UnhealthyThreshold int
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    healthyThreshold Integer
    Number of successful health checks required in order to set the HEALTHY status for the target.
    httpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions
    Options for HTTP health check. The structure is documented below.
    interval Integer
    The interval between health checks. The default is 2 seconds.
    tcpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions
    Options for TCP health check. The structure is documented below.
    timeout Integer
    Timeout for a target to return a response for the health check. The default is 1 second.
    unhealthyThreshold Integer
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
    name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    healthyThreshold number
    Number of successful health checks required in order to set the HEALTHY status for the target.
    httpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions
    Options for HTTP health check. The structure is documented below.
    interval number
    The interval between health checks. The default is 2 seconds.
    tcpOptions LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions
    Options for TCP health check. The structure is documented below.
    timeout number
    Timeout for a target to return a response for the health check. The default is 1 second.
    unhealthyThreshold number
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
    name str
    Name of the listener. The name must be unique for each listener on a single load balancer.
    healthy_threshold int
    Number of successful health checks required in order to set the HEALTHY status for the target.
    http_options LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions
    Options for HTTP health check. The structure is documented below.
    interval int
    The interval between health checks. The default is 2 seconds.
    tcp_options LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions
    Options for TCP health check. The structure is documented below.
    timeout int
    Timeout for a target to return a response for the health check. The default is 1 second.
    unhealthy_threshold int
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    healthyThreshold Number
    Number of successful health checks required in order to set the HEALTHY status for the target.
    httpOptions Property Map
    Options for HTTP health check. The structure is documented below.
    interval Number
    The interval between health checks. The default is 2 seconds.
    tcpOptions Property Map
    Options for TCP health check. The structure is documented below.
    timeout Number
    Timeout for a target to return a response for the health check. The default is 1 second.
    unhealthyThreshold Number
    Number of failed health checks before changing the status to UNHEALTHY. The default is 2.

    LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptions, LbNetworkLoadBalancerAttachedTargetGroupHealthcheckHttpOptionsArgs

    Port int
    Port for incoming traffic.
    Path string
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.
    Port int
    Port for incoming traffic.
    Path string
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.
    port Integer
    Port for incoming traffic.
    path String
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.
    port number
    Port for incoming traffic.
    path string
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.
    port int
    Port for incoming traffic.
    path str
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.
    port Number
    Port for incoming traffic.
    path String
    URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.

    LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptions, LbNetworkLoadBalancerAttachedTargetGroupHealthcheckTcpOptionsArgs

    Port int
    Port for incoming traffic.
    Port int
    Port for incoming traffic.
    port Integer
    Port for incoming traffic.
    port number
    Port for incoming traffic.
    port int
    Port for incoming traffic.
    port Number
    Port for incoming traffic.

    LbNetworkLoadBalancerListener, LbNetworkLoadBalancerListenerArgs

    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    Port int
    Port for incoming traffic.
    ExternalAddressSpec LbNetworkLoadBalancerListenerExternalAddressSpec
    External IP address specification. The structure is documented below.
    InternalAddressSpec LbNetworkLoadBalancerListenerInternalAddressSpec
    Internal IP address specification. The structure is documented below.
    Protocol string
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    TargetPort int
    Port of a target. The default is the same as listener's port.
    Name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    Port int
    Port for incoming traffic.
    ExternalAddressSpec LbNetworkLoadBalancerListenerExternalAddressSpec
    External IP address specification. The structure is documented below.
    InternalAddressSpec LbNetworkLoadBalancerListenerInternalAddressSpec
    Internal IP address specification. The structure is documented below.
    Protocol string
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    TargetPort int
    Port of a target. The default is the same as listener's port.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    port Integer
    Port for incoming traffic.
    externalAddressSpec LbNetworkLoadBalancerListenerExternalAddressSpec
    External IP address specification. The structure is documented below.
    internalAddressSpec LbNetworkLoadBalancerListenerInternalAddressSpec
    Internal IP address specification. The structure is documented below.
    protocol String
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    targetPort Integer
    Port of a target. The default is the same as listener's port.
    name string
    Name of the listener. The name must be unique for each listener on a single load balancer.
    port number
    Port for incoming traffic.
    externalAddressSpec LbNetworkLoadBalancerListenerExternalAddressSpec
    External IP address specification. The structure is documented below.
    internalAddressSpec LbNetworkLoadBalancerListenerInternalAddressSpec
    Internal IP address specification. The structure is documented below.
    protocol string
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    targetPort number
    Port of a target. The default is the same as listener's port.
    name str
    Name of the listener. The name must be unique for each listener on a single load balancer.
    port int
    Port for incoming traffic.
    external_address_spec LbNetworkLoadBalancerListenerExternalAddressSpec
    External IP address specification. The structure is documented below.
    internal_address_spec LbNetworkLoadBalancerListenerInternalAddressSpec
    Internal IP address specification. The structure is documented below.
    protocol str
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    target_port int
    Port of a target. The default is the same as listener's port.
    name String
    Name of the listener. The name must be unique for each listener on a single load balancer.
    port Number
    Port for incoming traffic.
    externalAddressSpec Property Map
    External IP address specification. The structure is documented below.
    internalAddressSpec Property Map
    Internal IP address specification. The structure is documented below.
    protocol String
    Protocol for incoming traffic. TCP or UDP and the default is TCP.
    targetPort Number
    Port of a target. The default is the same as listener's port.

    LbNetworkLoadBalancerListenerExternalAddressSpec, LbNetworkLoadBalancerListenerExternalAddressSpecArgs

    Address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    IpVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    Address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    IpVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    address String
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion String
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    address str
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ip_version str
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    address String
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion String
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.

    LbNetworkLoadBalancerListenerInternalAddressSpec, LbNetworkLoadBalancerListenerInternalAddressSpecArgs

    SubnetId string
    ID of the subnet to which the internal IP address belongs.
    Address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    IpVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    SubnetId string
    ID of the subnet to which the internal IP address belongs.
    Address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    IpVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    subnetId String
    ID of the subnet to which the internal IP address belongs.
    address String
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion String
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    subnetId string
    ID of the subnet to which the internal IP address belongs.
    address string
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion string
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    subnet_id str
    ID of the subnet to which the internal IP address belongs.
    address str
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ip_version str
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.
    subnetId String
    ID of the subnet to which the internal IP address belongs.
    address String
    Internal IP address for a listener. Must belong to the subnet that is referenced in subnet_id. IP address will be allocated if it wasn't been set.
    ipVersion String
    IP version of the internal addresses that the load balancer works with. Must be one of ipv4 or ipv6. The default is ipv4.

    Import

    A network load balancer can be imported using the id of the resource, e.g.

     $ pulumi import yandex:index/lbNetworkLoadBalancer:LbNetworkLoadBalancer default network_load_balancer_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Yandex pulumi/pulumi-yandex
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the yandex Terraform Provider.
    yandex logo
    Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi
    pulumi/pulumi-yandex