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

yandex.getAlbBackendGroup

Explore with Pulumi AI

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

    Get information about a Yandex Application Load Balancer Backend Group. For more information, see Yandex.Cloud Application Load Balancer.

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

const foo = pulumi.output(yandex.getAlbBackendGroup({
    backendGroupId: "my-backend-group-id",
}));

    import pulumi
import pulumi_yandex as yandex

foo = yandex.get_alb_backend_group(backend_group_id="my-backend-group-id")

    using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetAlbBackendGroup.InvokeAsync(new Yandex.GetAlbBackendGroupArgs
        {
            BackendGroupId = "my-backend-group-id",
        }));
    }

}

    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 {
		opt0 := "my-backend-group-id"
		_, err := yandex.LookupAlbBackendGroup(ctx, &GetAlbBackendGroupArgs{
			BackendGroupId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    This data source is used to define [Application Load Balancer Backend Groups] that can be used by other resources.

    Using getAlbBackendGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAlbBackendGroup(args: GetAlbBackendGroupArgs, opts?: InvokeOptions): Promise<GetAlbBackendGroupResult>
function getAlbBackendGroupOutput(args: GetAlbBackendGroupOutputArgs, opts?: InvokeOptions): Output<GetAlbBackendGroupResult>
    def get_alb_backend_group(backend_group_id: Optional[str] = None,
                          description: Optional[str] = None,
                          folder_id: Optional[str] = None,
                          grpc_backends: Optional[Sequence[GetAlbBackendGroupGrpcBackend]] = None,
                          http_backends: Optional[Sequence[GetAlbBackendGroupHttpBackend]] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None,
                          stream_backends: Optional[Sequence[GetAlbBackendGroupStreamBackend]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAlbBackendGroupResult
def get_alb_backend_group_output(backend_group_id: Optional[pulumi.Input[str]] = None,
                          description: Optional[pulumi.Input[str]] = None,
                          folder_id: Optional[pulumi.Input[str]] = None,
                          grpc_backends: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlbBackendGroupGrpcBackendArgs]]]] = None,
                          http_backends: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlbBackendGroupHttpBackendArgs]]]] = None,
                          labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          stream_backends: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlbBackendGroupStreamBackendArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAlbBackendGroupResult]
    func LookupAlbBackendGroup(ctx *Context, args *LookupAlbBackendGroupArgs, opts ...InvokeOption) (*LookupAlbBackendGroupResult, error)
func LookupAlbBackendGroupOutput(ctx *Context, args *LookupAlbBackendGroupOutputArgs, opts ...InvokeOption) LookupAlbBackendGroupResultOutput

    > Note: This function is named LookupAlbBackendGroup in the Go SDK.

    public static class GetAlbBackendGroup 
{
    public static Task<GetAlbBackendGroupResult> InvokeAsync(GetAlbBackendGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetAlbBackendGroupResult> Invoke(GetAlbBackendGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAlbBackendGroupResult> getAlbBackendGroup(GetAlbBackendGroupArgs args, InvokeOptions options)
public static Output<GetAlbBackendGroupResult> getAlbBackendGroup(GetAlbBackendGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: yandex:index/getAlbBackendGroup:getAlbBackendGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BackendGroupId string
    Backend Group ID.
    Description string
    Description of the backend group.
    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    GrpcBackends List<GetAlbBackendGroupGrpcBackend>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    HttpBackends List<GetAlbBackendGroupHttpBackend>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    Labels Dictionary<string, string>
    Labels to assign to this backend group.
    Name string
    • Name of the Backend Group.
    StreamBackends List<GetAlbBackendGroupStreamBackend>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    BackendGroupId string
    Backend Group ID.
    Description string
    Description of the backend group.
    FolderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    GrpcBackends []GetAlbBackendGroupGrpcBackend
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    HttpBackends []GetAlbBackendGroupHttpBackend
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    Labels map[string]string
    Labels to assign to this backend group.
    Name string
    • Name of the Backend Group.
    StreamBackends []GetAlbBackendGroupStreamBackend
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId String
    Backend Group ID.
    description String
    Description of the backend group.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    grpcBackends List<GetAlbBackendGroupGrpcBackend>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends List<GetAlbBackendGroupHttpBackend>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    labels Map<String,String>
    Labels to assign to this backend group.
    name String
    • Name of the Backend Group.
    streamBackends List<GetAlbBackendGroupStreamBackend>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId string
    Backend Group ID.
    description string
    Description of the backend group.
    folderId string
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    grpcBackends GetAlbBackendGroupGrpcBackend[]
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends GetAlbBackendGroupHttpBackend[]
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    labels {[key: string]: string}
    Labels to assign to this backend group.
    name string
    • Name of the Backend Group.
    streamBackends GetAlbBackendGroupStreamBackend[]
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backend_group_id str
    Backend Group ID.
    description str
    Description of the backend group.
    folder_id str
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    grpc_backends Sequence[GetAlbBackendGroupGrpcBackend]
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    http_backends Sequence[GetAlbBackendGroupHttpBackend]
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    labels Mapping[str, str]
    Labels to assign to this backend group.
    name str
    • Name of the Backend Group.
    stream_backends Sequence[GetAlbBackendGroupStreamBackend]
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId String
    Backend Group ID.
    description String
    Description of the backend group.
    folderId String
    Folder that the resource belongs to. If value is omitted, the default provider folder is used.
    grpcBackends List<Property Map>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends List<Property Map>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    labels Map<String>
    Labels to assign to this backend group.
    name String
    • Name of the Backend Group.
    streamBackends List<Property Map>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.

    getAlbBackendGroup Result

    The following output properties are available:

    BackendGroupId string
    CreatedAt string
    Creation timestamp of this backend group.
    Description string
    Description of the backend group.
    FolderId string
    GrpcBackends List<GetAlbBackendGroupGrpcBackend>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    HttpBackends List<GetAlbBackendGroupHttpBackend>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, string>
    Labels to assign to this backend group.
    Name string
    Name of the backend.
    StreamBackends List<GetAlbBackendGroupStreamBackend>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    BackendGroupId string
    CreatedAt string
    Creation timestamp of this backend group.
    Description string
    Description of the backend group.
    FolderId string
    GrpcBackends []GetAlbBackendGroupGrpcBackend
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    HttpBackends []GetAlbBackendGroupHttpBackend
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]string
    Labels to assign to this backend group.
    Name string
    Name of the backend.
    StreamBackends []GetAlbBackendGroupStreamBackend
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId String
    createdAt String
    Creation timestamp of this backend group.
    description String
    Description of the backend group.
    folderId String
    grpcBackends List<GetAlbBackendGroupGrpcBackend>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends List<GetAlbBackendGroupHttpBackend>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,String>
    Labels to assign to this backend group.
    name String
    Name of the backend.
    streamBackends List<GetAlbBackendGroupStreamBackend>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId string
    createdAt string
    Creation timestamp of this backend group.
    description string
    Description of the backend group.
    folderId string
    grpcBackends GetAlbBackendGroupGrpcBackend[]
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends GetAlbBackendGroupHttpBackend[]
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: string}
    Labels to assign to this backend group.
    name string
    Name of the backend.
    streamBackends GetAlbBackendGroupStreamBackend[]
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backend_group_id str
    created_at str
    Creation timestamp of this backend group.
    description str
    Description of the backend group.
    folder_id str
    grpc_backends Sequence[GetAlbBackendGroupGrpcBackend]
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    http_backends Sequence[GetAlbBackendGroupHttpBackend]
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, str]
    Labels to assign to this backend group.
    name str
    Name of the backend.
    stream_backends Sequence[GetAlbBackendGroupStreamBackend]
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
    backendGroupId String
    createdAt String
    Creation timestamp of this backend group.
    description String
    Description of the backend group.
    folderId String
    grpcBackends List<Property Map>
    Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
    httpBackends List<Property Map>
    Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String>
    Labels to assign to this backend group.
    name String
    Name of the backend.
    streamBackends List<Property Map>
    Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.

    Supporting Types

    GetAlbBackendGroupGrpcBackend

    Healthcheck GetAlbBackendGroupGrpcBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    LoadBalancingConfig GetAlbBackendGroupGrpcBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds List<string>
    References target groups for the backend.
    Tls GetAlbBackendGroupGrpcBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    Healthcheck GetAlbBackendGroupGrpcBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    LoadBalancingConfig GetAlbBackendGroupGrpcBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds []string
    References target groups for the backend.
    Tls GetAlbBackendGroupGrpcBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupGrpcBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig GetAlbBackendGroupGrpcBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Integer
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls GetAlbBackendGroupGrpcBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight Integer
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupGrpcBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig GetAlbBackendGroupGrpcBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name string
    • Name of the Backend Group.
    port number
    Port for incoming traffic.
    targetGroupIds string[]
    References target groups for the backend.
    tls GetAlbBackendGroupGrpcBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupGrpcBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    load_balancing_config GetAlbBackendGroupGrpcBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name str
    • Name of the Backend Group.
    port int
    Port for incoming traffic.
    target_group_ids Sequence[str]
    References target groups for the backend.
    tls GetAlbBackendGroupGrpcBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck Property Map
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig Property Map
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Number
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls Property Map
    Tls specification that will be used by this backend. Structure is documented below.
    weight Number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.

    GetAlbBackendGroupGrpcBackendHealthcheck

    GrpcHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    GrpcHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent float64
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Integer
    Optional alternative port for health checking.
    healthyThreshold Integer
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Integer
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort number
    Optional alternative port for health checking.
    healthyThreshold number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval string
    Interval between health checks.
    intervalJitterPercent number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout string
    Time to wait for a health check response.
    unhealthyThreshold number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpc_healthcheck GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheck_port int
    Optional alternative port for health checking.
    healthy_threshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    http_healthcheck GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval str
    Interval between health checks.
    interval_jitter_percent float
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    stream_healthcheck GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout str
    Time to wait for a health check response.
    unhealthy_threshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck Property Map
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Number
    Optional alternative port for health checking.
    healthyThreshold Number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck Property Map
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck Property Map
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.

    GetAlbBackendGroupGrpcBackendHealthcheckGrpcHealthcheck

    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    service_name str
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.

    GetAlbBackendGroupGrpcBackendHealthcheckHttpHealthcheck

    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.
    host string
    Optional "Host" HTTP header value.
    http2 boolean
    If set, health checks will use HTTP2.
    path string
    HTTP path.
    host str
    Optional "Host" HTTP header value.
    http2 bool
    If set, health checks will use HTTP2.
    path str
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.

    GetAlbBackendGroupGrpcBackendHealthcheckStreamHealthcheck

    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.
    receive string
    Optional text to search in reply.
    send string
    Optional message to send. If empty, it's a connect-only health check.
    receive str
    Optional text to search in reply.
    send str
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.

    GetAlbBackendGroupGrpcBackendLoadBalancingConfig

    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Integer
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Integer
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    locality_aware_routing_percent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panic_threshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strict_locality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.

    GetAlbBackendGroupGrpcBackendTls

    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupGrpcBackendTlsValidationContext
    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupGrpcBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupGrpcBackendTlsValidationContext
    sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupGrpcBackendTlsValidationContext
    sni str
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validation_context GetAlbBackendGroupGrpcBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext Property Map

    GetAlbBackendGroupGrpcBackendTlsValidationContext

    GetAlbBackendGroupHttpBackend

    Healthcheck GetAlbBackendGroupHttpBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    Http2 bool
    If set, health checks will use HTTP2.
    LoadBalancingConfig GetAlbBackendGroupHttpBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds List<string>
    References target groups for the backend.
    Tls GetAlbBackendGroupHttpBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    Healthcheck GetAlbBackendGroupHttpBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    Http2 bool
    If set, health checks will use HTTP2.
    LoadBalancingConfig GetAlbBackendGroupHttpBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds []string
    References target groups for the backend.
    Tls GetAlbBackendGroupHttpBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupHttpBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    http2 Boolean
    If set, health checks will use HTTP2.
    loadBalancingConfig GetAlbBackendGroupHttpBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Integer
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls GetAlbBackendGroupHttpBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight Integer
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupHttpBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    http2 boolean
    If set, health checks will use HTTP2.
    loadBalancingConfig GetAlbBackendGroupHttpBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name string
    • Name of the Backend Group.
    port number
    Port for incoming traffic.
    targetGroupIds string[]
    References target groups for the backend.
    tls GetAlbBackendGroupHttpBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupHttpBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    http2 bool
    If set, health checks will use HTTP2.
    load_balancing_config GetAlbBackendGroupHttpBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name str
    • Name of the Backend Group.
    port int
    Port for incoming traffic.
    target_group_ids Sequence[str]
    References target groups for the backend.
    tls GetAlbBackendGroupHttpBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck Property Map
    Healthcheck specification that will be used by this backend. Structure is documented below.
    http2 Boolean
    If set, health checks will use HTTP2.
    loadBalancingConfig Property Map
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Number
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls Property Map
    Tls specification that will be used by this backend. Structure is documented below.
    weight Number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.

    GetAlbBackendGroupHttpBackendHealthcheck

    GrpcHealthcheck GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    GrpcHealthcheck GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent float64
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Integer
    Optional alternative port for health checking.
    healthyThreshold Integer
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Integer
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort number
    Optional alternative port for health checking.
    healthyThreshold number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval string
    Interval between health checks.
    intervalJitterPercent number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout string
    Time to wait for a health check response.
    unhealthyThreshold number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpc_healthcheck GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheck_port int
    Optional alternative port for health checking.
    healthy_threshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    http_healthcheck GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval str
    Interval between health checks.
    interval_jitter_percent float
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    stream_healthcheck GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout str
    Time to wait for a health check response.
    unhealthy_threshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck Property Map
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Number
    Optional alternative port for health checking.
    healthyThreshold Number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck Property Map
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck Property Map
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.

    GetAlbBackendGroupHttpBackendHealthcheckGrpcHealthcheck

    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    service_name str
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.

    GetAlbBackendGroupHttpBackendHealthcheckHttpHealthcheck

    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.
    host string
    Optional "Host" HTTP header value.
    http2 boolean
    If set, health checks will use HTTP2.
    path string
    HTTP path.
    host str
    Optional "Host" HTTP header value.
    http2 bool
    If set, health checks will use HTTP2.
    path str
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.

    GetAlbBackendGroupHttpBackendHealthcheckStreamHealthcheck

    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.
    receive string
    Optional text to search in reply.
    send string
    Optional message to send. If empty, it's a connect-only health check.
    receive str
    Optional text to search in reply.
    send str
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.

    GetAlbBackendGroupHttpBackendLoadBalancingConfig

    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Integer
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Integer
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    locality_aware_routing_percent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panic_threshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strict_locality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.

    GetAlbBackendGroupHttpBackendTls

    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupHttpBackendTlsValidationContext
    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupHttpBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupHttpBackendTlsValidationContext
    sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupHttpBackendTlsValidationContext
    sni str
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validation_context GetAlbBackendGroupHttpBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext Property Map

    GetAlbBackendGroupHttpBackendTlsValidationContext

    GetAlbBackendGroupStreamBackend

    Healthcheck GetAlbBackendGroupStreamBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    LoadBalancingConfig GetAlbBackendGroupStreamBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds List<string>
    References target groups for the backend.
    Tls GetAlbBackendGroupStreamBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    Healthcheck GetAlbBackendGroupStreamBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    LoadBalancingConfig GetAlbBackendGroupStreamBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    Name string
    • Name of the Backend Group.
    Port int
    Port for incoming traffic.
    TargetGroupIds []string
    References target groups for the backend.
    Tls GetAlbBackendGroupStreamBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    Weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupStreamBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig GetAlbBackendGroupStreamBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Integer
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls GetAlbBackendGroupStreamBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight Integer
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupStreamBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig GetAlbBackendGroupStreamBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name string
    • Name of the Backend Group.
    port number
    Port for incoming traffic.
    targetGroupIds string[]
    References target groups for the backend.
    tls GetAlbBackendGroupStreamBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck GetAlbBackendGroupStreamBackendHealthcheck
    Healthcheck specification that will be used by this backend. Structure is documented below.
    load_balancing_config GetAlbBackendGroupStreamBackendLoadBalancingConfig
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name str
    • Name of the Backend Group.
    port int
    Port for incoming traffic.
    target_group_ids Sequence[str]
    References target groups for the backend.
    tls GetAlbBackendGroupStreamBackendTls
    Tls specification that will be used by this backend. Structure is documented below.
    weight int
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.
    healthcheck Property Map
    Healthcheck specification that will be used by this backend. Structure is documented below.
    loadBalancingConfig Property Map
    Load Balancing Config specification that will be used by this backend. Structure is documented below.
    name String
    • Name of the Backend Group.
    port Number
    Port for incoming traffic.
    targetGroupIds List<String>
    References target groups for the backend.
    tls Property Map
    Tls specification that will be used by this backend. Structure is documented below.
    weight Number
    Weight of the backend. Traffic will be split between backends of the same BackendGroup according to their weights.

    GetAlbBackendGroupStreamBackendHealthcheck

    GrpcHealthcheck GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    GrpcHealthcheck GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    HealthcheckPort int
    Optional alternative port for health checking.
    HealthyThreshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    HttpHealthcheck GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Interval string
    Interval between health checks.
    IntervalJitterPercent float64
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    StreamHealthcheck GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    Timeout string
    Time to wait for a health check response.
    UnhealthyThreshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Integer
    Optional alternative port for health checking.
    healthyThreshold Integer
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Double
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Integer
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort number
    Optional alternative port for health checking.
    healthyThreshold number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval string
    Interval between health checks.
    intervalJitterPercent number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout string
    Time to wait for a health check response.
    unhealthyThreshold number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpc_healthcheck GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheck_port int
    Optional alternative port for health checking.
    healthy_threshold int
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    http_healthcheck GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval str
    Interval between health checks.
    interval_jitter_percent float
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    stream_healthcheck GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout str
    Time to wait for a health check response.
    unhealthy_threshold int
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.
    grpcHealthcheck Property Map
    Grpc Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    healthcheckPort Number
    Optional alternative port for health checking.
    healthyThreshold Number
    Number of consecutive successful health checks required to promote endpoint into the healthy state. 0 means 1. Note that during startup, only a single successful health check is required to mark a host healthy.
    httpHealthcheck Property Map
    Http Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    interval String
    Interval between health checks.
    intervalJitterPercent Number
    An optional jitter amount as a percentage of interval. If specified, during every interval value of (interval_ms * interval_jitter_percent / 100) will be added to the wait time.
    streamHealthcheck Property Map
    Stream Healthcheck specification that will be used by this healthcheck. Structure is documented below.
    timeout String
    Time to wait for a health check response.
    unhealthyThreshold Number
    Number of consecutive failed health checks required to demote endpoint into the unhealthy state. 0 means 1. Note that for HTTP health checks, a single 503 immediately makes endpoint unhealthy.

    GetAlbBackendGroupStreamBackendHealthcheckGrpcHealthcheck

    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    ServiceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName string
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    service_name str
    Optional service name for grpc.health.v1.HealthCheckRequest message.
    serviceName String
    Optional service name for grpc.health.v1.HealthCheckRequest message.

    GetAlbBackendGroupStreamBackendHealthcheckHttpHealthcheck

    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    Host string
    Optional "Host" HTTP header value.
    Http2 bool
    If set, health checks will use HTTP2.
    Path string
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.
    host string
    Optional "Host" HTTP header value.
    http2 boolean
    If set, health checks will use HTTP2.
    path string
    HTTP path.
    host str
    Optional "Host" HTTP header value.
    http2 bool
    If set, health checks will use HTTP2.
    path str
    HTTP path.
    host String
    Optional "Host" HTTP header value.
    http2 Boolean
    If set, health checks will use HTTP2.
    path String
    HTTP path.

    GetAlbBackendGroupStreamBackendHealthcheckStreamHealthcheck

    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    Receive string
    Optional text to search in reply.
    Send string
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.
    receive string
    Optional text to search in reply.
    send string
    Optional message to send. If empty, it's a connect-only health check.
    receive str
    Optional text to search in reply.
    send str
    Optional message to send. If empty, it's a connect-only health check.
    receive String
    Optional text to search in reply.
    send String
    Optional message to send. If empty, it's a connect-only health check.

    GetAlbBackendGroupStreamBackendLoadBalancingConfig

    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    LocalityAwareRoutingPercent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    PanicThreshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    StrictLocality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Integer
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Integer
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    locality_aware_routing_percent int
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panic_threshold int
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strict_locality bool
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.
    localityAwareRoutingPercent Number
    Percent of traffic to be sent to the same availability zone. The rest will be equally divided between other zones.
    panicThreshold Number
    If percentage of healthy hosts in the backend is lower than panic_threshold, traffic will be routed to all backends no matter what the health status is. This helps to avoid healthy backends overloading when everything is bad. Zero means no panic threshold.
    strictLocality Boolean
    If set, will route requests only to the same availability zone. Balancer won't know about endpoints in other zones.

    GetAlbBackendGroupStreamBackendTls

    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupStreamBackendTlsValidationContext
    Sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    ValidationContext GetAlbBackendGroupStreamBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupStreamBackendTlsValidationContext
    sni string
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext GetAlbBackendGroupStreamBackendTlsValidationContext
    sni str
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validation_context GetAlbBackendGroupStreamBackendTlsValidationContext
    sni String
    SNI string for TLS connections.

    • validation_context.0.trusted_ca_id - Trusted CA certificate ID in the Certificate Manager.
    • validation_context.0.trusted_ca_bytes - PEM-encoded trusted CA certificate chain.
    validationContext Property Map

    GetAlbBackendGroupStreamBackendTlsValidationContext

    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