Yandex v0.13.0, Feb 22 22

yandex.AlbVirtualHost

Explore with Pulumi AI

Creates a virtual host that belongs to specified HTTP router and adds the specified routes to it. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var my_virtual_host = new Yandex.AlbVirtualHost("my-virtual-host", new Yandex.AlbVirtualHostArgs
        {
            HttpRouterId = yandex_alb_http_router.My_router.Id,
            Routes = 
            {
                new Yandex.Inputs.AlbVirtualHostRouteArgs
                {
                    Name = "my-route",
                    HttpRoute = new Yandex.Inputs.AlbVirtualHostRouteHttpRouteArgs
                    {
                        HttpRouteAction = new Yandex.Inputs.AlbVirtualHostRouteHttpRouteHttpRouteActionArgs
                        {
                            BackendGroupId = yandex_alb_backend_group.My_bg.Id,
                            Timeout = "3s",
                        },
                    },
                },
            },
        });
    }

}

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.NewAlbVirtualHost(ctx, "my-virtual-host", &yandex.AlbVirtualHostArgs{
			HttpRouterId: pulumi.Any(yandex_alb_http_router.My - router.Id),
			Routes: AlbVirtualHostRouteArray{
				&AlbVirtualHostRouteArgs{
					Name: pulumi.String("my-route"),
					HttpRoute: &AlbVirtualHostRouteHttpRouteArgs{
						HttpRouteAction: &AlbVirtualHostRouteHttpRouteHttpRouteActionArgs{
							BackendGroupId: pulumi.Any(yandex_alb_backend_group.My - bg.Id),
							Timeout:        pulumi.String("3s"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_yandex as yandex

my_virtual_host = yandex.AlbVirtualHost("my-virtual-host",
    http_router_id=yandex_alb_http_router["my-router"]["id"],
    routes=[yandex.AlbVirtualHostRouteArgs(
        name="my-route",
        http_route=yandex.AlbVirtualHostRouteHttpRouteArgs(
            http_route_action=yandex.AlbVirtualHostRouteHttpRouteHttpRouteActionArgs(
                backend_group_id=yandex_alb_backend_group["my-bg"]["id"],
                timeout="3s",
            ),
        ),
    )])

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

const my_virtual_host = new yandex.AlbVirtualHost("my-virtual-host", {
    httpRouterId: yandex_alb_http_router["my-router"].id,
    routes: [{
        name: "my-route",
        httpRoute: {
            httpRouteAction: {
                backendGroupId: yandex_alb_backend_group["my-bg"].id,
                timeout: "3s",
            },
        },
    }],
});

Coming soon!

Create AlbVirtualHost Resource

new AlbVirtualHost(name: string, args: AlbVirtualHostArgs, opts?: CustomResourceOptions);

@overload
def AlbVirtualHost(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   authorities: Optional[Sequence[str]] = None,
                   http_router_id: Optional[str] = None,
                   modify_request_headers: Optional[Sequence[AlbVirtualHostModifyRequestHeaderArgs]] = None,
                   modify_response_headers: Optional[Sequence[AlbVirtualHostModifyResponseHeaderArgs]] = None,
                   name: Optional[str] = None,
                   routes: Optional[Sequence[AlbVirtualHostRouteArgs]] = None)
@overload
def AlbVirtualHost(resource_name: str,
                   args: AlbVirtualHostArgs,
                   opts: Optional[ResourceOptions] = None)

func NewAlbVirtualHost(ctx *Context, name string, args AlbVirtualHostArgs, opts ...ResourceOption) (*AlbVirtualHost, error)

public AlbVirtualHost(string name, AlbVirtualHostArgs args, CustomResourceOptions? opts = null)

public AlbVirtualHost(String name, AlbVirtualHostArgs args)
public AlbVirtualHost(String name, AlbVirtualHostArgs args, CustomResourceOptions options)

type: yandex:AlbVirtualHost
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlbVirtualHostArgs: 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 AlbVirtualHostArgs: 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 AlbVirtualHostArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlbVirtualHostArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AlbVirtualHostArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AlbVirtualHost Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AlbVirtualHost resource accepts the following input properties:

HttpRouterId string
Authorities List<string>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
ModifyRequestHeaders List<AlbVirtualHostModifyRequestHeaderArgs>: Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders List<AlbVirtualHostModifyResponseHeaderArgs>: Apply the following modifications to the response headers. The structure is documented below.
Name string: name of the route.
Routes List<AlbVirtualHostRouteArgs>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

HttpRouterId string
Authorities []string: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
ModifyRequestHeaders []AlbVirtualHostModifyRequestHeaderArgs: Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders []AlbVirtualHostModifyResponseHeaderArgs: Apply the following modifications to the response headers. The structure is documented below.
Name string: name of the route.
Routes []AlbVirtualHostRouteArgs: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

httpRouterId String
authorities List<String>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
modifyRequestHeaders List<AlbVirtualHostModifyRequestHeaderArgs>: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders List<AlbVirtualHostModifyResponseHeaderArgs>: Apply the following modifications to the response headers. The structure is documented below.
name String: name of the route.
routes List<AlbVirtualHostRouteArgs>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

httpRouterId string
authorities string[]: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
modifyRequestHeaders AlbVirtualHostModifyRequestHeaderArgs[]: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders AlbVirtualHostModifyResponseHeaderArgs[]: Apply the following modifications to the response headers. The structure is documented below.
name string: name of the route.
routes AlbVirtualHostRouteArgs[]: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

http_router_id str
authorities Sequence[str]: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
modify_request_headers Sequence[AlbVirtualHostModifyRequestHeaderArgs]: Apply the following modifications to the request headers. The structure is documented below.
modify_response_headers Sequence[AlbVirtualHostModifyResponseHeaderArgs]: Apply the following modifications to the response headers. The structure is documented below.
name str: name of the route.
routes Sequence[AlbVirtualHostRouteArgs]: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

httpRouterId String
authorities List<String>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
modifyRequestHeaders List<Property Map>: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders List<Property Map>: Apply the following modifications to the response headers. The structure is documented below.
name String: name of the route.
routes List<Property Map>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AlbVirtualHost Resource

Get an existing AlbVirtualHost 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?: AlbVirtualHostState, opts?: CustomResourceOptions): AlbVirtualHost

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorities: Optional[Sequence[str]] = None,
        http_router_id: Optional[str] = None,
        modify_request_headers: Optional[Sequence[AlbVirtualHostModifyRequestHeaderArgs]] = None,
        modify_response_headers: Optional[Sequence[AlbVirtualHostModifyResponseHeaderArgs]] = None,
        name: Optional[str] = None,
        routes: Optional[Sequence[AlbVirtualHostRouteArgs]] = None) -> AlbVirtualHost

func GetAlbVirtualHost(ctx *Context, name string, id IDInput, state *AlbVirtualHostState, opts ...ResourceOption) (*AlbVirtualHost, error)

public static AlbVirtualHost Get(string name, Input<string> id, AlbVirtualHostState? state, CustomResourceOptions? opts = null)

public static AlbVirtualHost get(String name, Output<String> id, AlbVirtualHostState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Authorities List<string>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
HttpRouterId string
ModifyRequestHeaders List<AlbVirtualHostModifyRequestHeaderArgs>: Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders List<AlbVirtualHostModifyResponseHeaderArgs>: Apply the following modifications to the response headers. The structure is documented below.
Name string: name of the route.
Routes List<AlbVirtualHostRouteArgs>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

Authorities []string: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
HttpRouterId string
ModifyRequestHeaders []AlbVirtualHostModifyRequestHeaderArgs: Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders []AlbVirtualHostModifyResponseHeaderArgs: Apply the following modifications to the response headers. The structure is documented below.
Name string: name of the route.
Routes []AlbVirtualHostRouteArgs: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

authorities List<String>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
httpRouterId String
modifyRequestHeaders List<AlbVirtualHostModifyRequestHeaderArgs>: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders List<AlbVirtualHostModifyResponseHeaderArgs>: Apply the following modifications to the response headers. The structure is documented below.
name String: name of the route.
routes List<AlbVirtualHostRouteArgs>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

authorities string[]: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
httpRouterId string
modifyRequestHeaders AlbVirtualHostModifyRequestHeaderArgs[]: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders AlbVirtualHostModifyResponseHeaderArgs[]: Apply the following modifications to the response headers. The structure is documented below.
name string: name of the route.
routes AlbVirtualHostRouteArgs[]: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

authorities Sequence[str]: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
http_router_id str
modify_request_headers Sequence[AlbVirtualHostModifyRequestHeaderArgs]: Apply the following modifications to the request headers. The structure is documented below.
modify_response_headers Sequence[AlbVirtualHostModifyResponseHeaderArgs]: Apply the following modifications to the response headers. The structure is documented below.
name str: name of the route.
routes Sequence[AlbVirtualHostRouteArgs]: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

authorities List<String>: A list of domains (host/authority header) that will be matched to this virtual host. Wildcard hosts are supported in the form of '.foo.com' or '-bar.foo.com'. If not specified, all domains will be matched.
httpRouterId String
modifyRequestHeaders List<Property Map>: Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders List<Property Map>: Apply the following modifications to the response headers. The structure is documented below.
name String: name of the route.
routes List<Property Map>: A Route resource. Routes are matched in-order. Be careful when adding them to the end. For instance, having http '/' match first makes all other routes unused. The structure is documented below.

Supporting Types

AlbVirtualHostModifyRequestHeader

Name string: name of the route.
Append string: Append string to the header value.
Remove bool: If set, remove the header.
Replace string: New value for a header. Header values support the following formatters.

Name string: name of the route.
Append string: Append string to the header value.
Remove bool: If set, remove the header.
Replace string: New value for a header. Header values support the following formatters.

name String: name of the route.
append String: Append string to the header value.
remove Boolean: If set, remove the header.
replace String: New value for a header. Header values support the following formatters.

name string: name of the route.
append string: Append string to the header value.
remove boolean: If set, remove the header.
replace string: New value for a header. Header values support the following formatters.

name str: name of the route.
append str: Append string to the header value.
remove bool: If set, remove the header.
replace str: New value for a header. Header values support the following formatters.

name String: name of the route.
append String: Append string to the header value.
remove Boolean: If set, remove the header.
replace String: New value for a header. Header values support the following formatters.

AlbVirtualHostModifyResponseHeader

Name string: name of the route.
Append string: Append string to the header value.
Remove bool: If set, remove the header.
Replace string: New value for a header. Header values support the following formatters.

Name string: name of the route.
Append string: Append string to the header value.
Remove bool: If set, remove the header.
Replace string: New value for a header. Header values support the following formatters.

name String: name of the route.
append String: Append string to the header value.
remove Boolean: If set, remove the header.
replace String: New value for a header. Header values support the following formatters.

name string: name of the route.
append string: Append string to the header value.
remove boolean: If set, remove the header.
replace string: New value for a header. Header values support the following formatters.

name str: name of the route.
append str: Append string to the header value.
remove bool: If set, remove the header.
replace str: New value for a header. Header values support the following formatters.

name String: name of the route.
append String: Append string to the header value.
remove Boolean: If set, remove the header.
replace String: New value for a header. Header values support the following formatters.

AlbVirtualHostRoute

GrpcRoute AlbVirtualHostRouteGrpcRoute: GRPC route resource. The structure is documented below.
HttpRoute AlbVirtualHostRouteHttpRoute: HTTP route resource. The structure is documented below.
Name string: name of the route.

GrpcRoute AlbVirtualHostRouteGrpcRoute: GRPC route resource. The structure is documented below.
HttpRoute AlbVirtualHostRouteHttpRoute: HTTP route resource. The structure is documented below.
Name string: name of the route.

grpcRoute AlbVirtualHostRouteGrpcRoute: GRPC route resource. The structure is documented below.
httpRoute AlbVirtualHostRouteHttpRoute: HTTP route resource. The structure is documented below.
name String: name of the route.

grpcRoute AlbVirtualHostRouteGrpcRoute: GRPC route resource. The structure is documented below.
httpRoute AlbVirtualHostRouteHttpRoute: HTTP route resource. The structure is documented below.
name string: name of the route.

grpc_route AlbVirtualHostRouteGrpcRoute: GRPC route resource. The structure is documented below.
http_route AlbVirtualHostRouteHttpRoute: HTTP route resource. The structure is documented below.
name str: name of the route.

grpcRoute Property Map: GRPC route resource. The structure is documented below.
httpRoute Property Map: HTTP route resource. The structure is documented below.
name String: name of the route.

AlbVirtualHostRouteGrpcRoute

GrpcMatches List<AlbVirtualHostRouteGrpcRouteGrpcMatch>: Checks "/" prefix by default. The structure is documented below.
GrpcRouteAction AlbVirtualHostRouteGrpcRouteGrpcRouteAction: GRPC route action resource. The structure is documented below.
GrpcStatusResponseAction AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction: GRPC status response action resource. The structure is documented below.

GrpcMatches []AlbVirtualHostRouteGrpcRouteGrpcMatch: Checks "/" prefix by default. The structure is documented below.
GrpcRouteAction AlbVirtualHostRouteGrpcRouteGrpcRouteAction: GRPC route action resource. The structure is documented below.
GrpcStatusResponseAction AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction: GRPC status response action resource. The structure is documented below.

grpcMatches List<AlbVirtualHostRouteGrpcRouteGrpcMatch>: Checks "/" prefix by default. The structure is documented below.
grpcRouteAction AlbVirtualHostRouteGrpcRouteGrpcRouteAction: GRPC route action resource. The structure is documented below.
grpcStatusResponseAction AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction: GRPC status response action resource. The structure is documented below.

grpcMatches AlbVirtualHostRouteGrpcRouteGrpcMatch[]: Checks "/" prefix by default. The structure is documented below.
grpcRouteAction AlbVirtualHostRouteGrpcRouteGrpcRouteAction: GRPC route action resource. The structure is documented below.
grpcStatusResponseAction AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction: GRPC status response action resource. The structure is documented below.

grpc_matches Sequence[AlbVirtualHostRouteGrpcRouteGrpcMatch]: Checks "/" prefix by default. The structure is documented below.
grpc_route_action AlbVirtualHostRouteGrpcRouteGrpcRouteAction: GRPC route action resource. The structure is documented below.
grpc_status_response_action AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction: GRPC status response action resource. The structure is documented below.

grpcMatches List<Property Map>: Checks "/" prefix by default. The structure is documented below.
grpcRouteAction Property Map: GRPC route action resource. The structure is documented below.
grpcStatusResponseAction Property Map: GRPC status response action resource. The structure is documented below.

AlbVirtualHostRouteGrpcRouteGrpcMatch

Fqmn AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn: If not set, all services/methods are assumed. The structure is documented below.

Fqmn AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn: If not set, all services/methods are assumed. The structure is documented below.

fqmn AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn: If not set, all services/methods are assumed. The structure is documented below.

fqmn AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn: If not set, all services/methods are assumed. The structure is documented below.

fqmn AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn: If not set, all services/methods are assumed. The structure is documented below.

fqmn Property Map: If not set, all services/methods are assumed. The structure is documented below.

AlbVirtualHostRouteGrpcRouteGrpcMatchFqmn

Exact string: Match exactly.
Prefix string: Match prefix.

Exact string: Match exactly.
Prefix string: Match prefix.

exact String: Match exactly.
prefix String: Match prefix.

exact string: Match exactly.
prefix string: Match prefix.

exact str: Match exactly.
prefix str: Match prefix.

exact String: Match exactly.
prefix String: Match prefix.

AlbVirtualHostRouteGrpcRouteGrpcRouteAction

BackendGroupId string: Backend group to route requests.
AutoHostRewrite bool: If set, will automatically rewrite host.
HostRewrite string: Host rewrite specifier.
IdleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
MaxTimeout string: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

BackendGroupId string: Backend group to route requests.
AutoHostRewrite bool: If set, will automatically rewrite host.
HostRewrite string: Host rewrite specifier.
IdleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
MaxTimeout string: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

backendGroupId String: Backend group to route requests.
autoHostRewrite Boolean: If set, will automatically rewrite host.
hostRewrite String: Host rewrite specifier.
idleTimeout String: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
maxTimeout String: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

backendGroupId string: Backend group to route requests.
autoHostRewrite boolean: If set, will automatically rewrite host.
hostRewrite string: Host rewrite specifier.
idleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
maxTimeout string: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

backend_group_id str: Backend group to route requests.
auto_host_rewrite bool: If set, will automatically rewrite host.
host_rewrite str: Host rewrite specifier.
idle_timeout str: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
max_timeout str: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

backendGroupId String: Backend group to route requests.
autoHostRewrite Boolean: If set, will automatically rewrite host.
hostRewrite String: Host rewrite specifier.
idleTimeout String: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
maxTimeout String: Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

AlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction

Status string: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

Status string: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

status String: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

status string: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

status str: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

status String: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

AlbVirtualHostRouteHttpRoute

DirectResponseAction AlbVirtualHostRouteHttpRouteDirectResponseAction: Direct response action resource. The structure is documented below.
HttpMatches List<AlbVirtualHostRouteHttpRouteHttpMatch>: Checks "/" prefix by default. The structure is documented below.
HttpRouteAction AlbVirtualHostRouteHttpRouteHttpRouteAction: HTTP route action resource. The structure is documented below.
RedirectAction AlbVirtualHostRouteHttpRouteRedirectAction: Redirect action resource. The structure is documented below.

DirectResponseAction AlbVirtualHostRouteHttpRouteDirectResponseAction: Direct response action resource. The structure is documented below.
HttpMatches []AlbVirtualHostRouteHttpRouteHttpMatch: Checks "/" prefix by default. The structure is documented below.
HttpRouteAction AlbVirtualHostRouteHttpRouteHttpRouteAction: HTTP route action resource. The structure is documented below.
RedirectAction AlbVirtualHostRouteHttpRouteRedirectAction: Redirect action resource. The structure is documented below.

directResponseAction AlbVirtualHostRouteHttpRouteDirectResponseAction: Direct response action resource. The structure is documented below.
httpMatches List<AlbVirtualHostRouteHttpRouteHttpMatch>: Checks "/" prefix by default. The structure is documented below.
httpRouteAction AlbVirtualHostRouteHttpRouteHttpRouteAction: HTTP route action resource. The structure is documented below.
redirectAction AlbVirtualHostRouteHttpRouteRedirectAction: Redirect action resource. The structure is documented below.

directResponseAction AlbVirtualHostRouteHttpRouteDirectResponseAction: Direct response action resource. The structure is documented below.
httpMatches AlbVirtualHostRouteHttpRouteHttpMatch[]: Checks "/" prefix by default. The structure is documented below.
httpRouteAction AlbVirtualHostRouteHttpRouteHttpRouteAction: HTTP route action resource. The structure is documented below.
redirectAction AlbVirtualHostRouteHttpRouteRedirectAction: Redirect action resource. The structure is documented below.

direct_response_action AlbVirtualHostRouteHttpRouteDirectResponseAction: Direct response action resource. The structure is documented below.
http_matches Sequence[AlbVirtualHostRouteHttpRouteHttpMatch]: Checks "/" prefix by default. The structure is documented below.
http_route_action AlbVirtualHostRouteHttpRouteHttpRouteAction: HTTP route action resource. The structure is documented below.
redirect_action AlbVirtualHostRouteHttpRouteRedirectAction: Redirect action resource. The structure is documented below.

directResponseAction Property Map: Direct response action resource. The structure is documented below.
httpMatches List<Property Map>: Checks "/" prefix by default. The structure is documented below.
httpRouteAction Property Map: HTTP route action resource. The structure is documented below.
redirectAction Property Map: Redirect action resource. The structure is documented below.

AlbVirtualHostRouteHttpRouteDirectResponseAction

Body string: Response body text.
Status int: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

Body string: Response body text.
Status int: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

body String: Response body text.
status Integer: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

body string: Response body text.
status number: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

body str: Response body text.
status int: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

body String: Response body text.
status Number: The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

AlbVirtualHostRouteHttpRouteHttpMatch

HttpMethods List<string>: List of methods(strings).
Path AlbVirtualHostRouteHttpRouteHttpMatchPath: If not set, '/' is assumed. The structure is documented below.

HttpMethods []string: List of methods(strings).
Path AlbVirtualHostRouteHttpRouteHttpMatchPath: If not set, '/' is assumed. The structure is documented below.

httpMethods List<String>: List of methods(strings).
path AlbVirtualHostRouteHttpRouteHttpMatchPath: If not set, '/' is assumed. The structure is documented below.

httpMethods string[]: List of methods(strings).
path AlbVirtualHostRouteHttpRouteHttpMatchPath: If not set, '/' is assumed. The structure is documented below.

http_methods Sequence[str]: List of methods(strings).
path AlbVirtualHostRouteHttpRouteHttpMatchPath: If not set, '/' is assumed. The structure is documented below.

httpMethods List<String>: List of methods(strings).
path Property Map: If not set, '/' is assumed. The structure is documented below.

AlbVirtualHostRouteHttpRouteHttpMatchPath

Exact string: Match exactly.
Prefix string: Match prefix.

Exact string: Match exactly.
Prefix string: Match prefix.

exact String: Match exactly.
prefix String: Match prefix.

exact string: Match exactly.
prefix string: Match prefix.

exact str: Match exactly.
prefix str: Match prefix.

exact String: Match exactly.
prefix String: Match prefix.

AlbVirtualHostRouteHttpRouteHttpRouteAction

BackendGroupId string: Backend group to route requests.
AutoHostRewrite bool: If set, will automatically rewrite host.
HostRewrite string: Host rewrite specifier.
IdleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
PrefixRewrite string: If not empty, matched path prefix will be replaced by this value.
Timeout string: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
UpgradeTypes List<string>: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

BackendGroupId string: Backend group to route requests.
AutoHostRewrite bool: If set, will automatically rewrite host.
HostRewrite string: Host rewrite specifier.
IdleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
PrefixRewrite string: If not empty, matched path prefix will be replaced by this value.
Timeout string: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
UpgradeTypes []string: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

backendGroupId String: Backend group to route requests.
autoHostRewrite Boolean: If set, will automatically rewrite host.
hostRewrite String: Host rewrite specifier.
idleTimeout String: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
prefixRewrite String: If not empty, matched path prefix will be replaced by this value.
timeout String: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes List<String>: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

backendGroupId string: Backend group to route requests.
autoHostRewrite boolean: If set, will automatically rewrite host.
hostRewrite string: Host rewrite specifier.
idleTimeout string: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
prefixRewrite string: If not empty, matched path prefix will be replaced by this value.
timeout string: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes string[]: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

backend_group_id str: Backend group to route requests.
auto_host_rewrite bool: If set, will automatically rewrite host.
host_rewrite str: Host rewrite specifier.
idle_timeout str: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
prefix_rewrite str: If not empty, matched path prefix will be replaced by this value.
timeout str: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgrade_types Sequence[str]: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

backendGroupId String: Backend group to route requests.
autoHostRewrite Boolean: If set, will automatically rewrite host.
hostRewrite String: Host rewrite specifier.
idleTimeout String: Specifies the idle timeout (time without any data transfer for the active request) for the route. It is useful for streaming scenarios - one should set idle_timeout to something meaningful and max_timeout to the maximum time the stream is allowed to be alive. If not specified, there is no per-route idle timeout.
prefixRewrite String: If not empty, matched path prefix will be replaced by this value.
timeout String: Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes List<String>: List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

AlbVirtualHostRouteHttpRouteRedirectAction

RemoveQuery bool
ReplaceHost string: Replaces hostname.
ReplacePath string: Replace path.
ReplacePort int: Replaces port.
ReplacePrefix string: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
ReplaceScheme string: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
ResponseCode string: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

RemoveQuery bool
ReplaceHost string: Replaces hostname.
ReplacePath string: Replace path.
ReplacePort int: Replaces port.
ReplacePrefix string: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
ReplaceScheme string: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
ResponseCode string: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

removeQuery Boolean
replaceHost String: Replaces hostname.
replacePath String: Replace path.
replacePort Integer: Replaces port.
replacePrefix String: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme String: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode String: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

removeQuery boolean
replaceHost string: Replaces hostname.
replacePath string: Replace path.
replacePort number: Replaces port.
replacePrefix string: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme string: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode string: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

remove_query bool
replace_host str: Replaces hostname.
replace_path str: Replace path.
replace_port int: Replaces port.
replace_prefix str: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replace_scheme str: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
response_code str: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

removeQuery Boolean
replaceHost String: Replaces hostname.
replacePath String: Replace path.
replacePort Number: Replaces port.
replacePrefix String: Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme String: Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode String: The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

Import

A virtual host can be imported using the id of the resource, e.g.

 $ pulumi import yandex:index/albVirtualHost:AlbVirtualHost default virtual_host_id

Package Details

Repository: Yandex pulumi/pulumi-yandex
License: Apache-2.0
Notes: This Pulumi package is based on the yandex Terraform Provider.