1. Packages
  2. Yandex
  3. API Docs
  4. getAlbVirtualHost
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

yandex.getAlbVirtualHost

Explore with Pulumi AI

Get information about a Yandex ALB Virtual Host. For more information, see Yandex.Cloud Application Load Balancer.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var my_vh_data = Output.Create(Yandex.GetAlbVirtualHost.InvokeAsync(new Yandex.GetAlbVirtualHostArgs
        {
            Name = yandex_alb_virtual_host.My_vh.Name,
            HttpRouterId = yandex_alb_virtual_host.My_router.Id,
        }));
    }

}
Copy
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 := yandex_alb_virtual_host.My - vh.Name
		opt1 := yandex_alb_virtual_host.My - router.Id
		_, err := yandex.LookupAlbVirtualHost(ctx, &GetAlbVirtualHostArgs{
			Name:         &opt0,
			HttpRouterId: &opt1,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

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

const my-vh-data = yandex.getAlbVirtualHost({
    name: yandex_alb_virtual_host["my-vh"].name,
    httpRouterId: yandex_alb_virtual_host["my-router"].id,
});
Copy
import pulumi
import pulumi_yandex as yandex

my_vh_data = yandex.get_alb_virtual_host(name=yandex_alb_virtual_host["my-vh"]["name"],
    http_router_id=yandex_alb_virtual_host["my-router"]["id"])
Copy

Coming soon!

Using getAlbVirtualHost

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 getAlbVirtualHost(args: GetAlbVirtualHostArgs, opts?: InvokeOptions): Promise<GetAlbVirtualHostResult>
function getAlbVirtualHostOutput(args: GetAlbVirtualHostOutputArgs, opts?: InvokeOptions): Output<GetAlbVirtualHostResult>
Copy
def get_alb_virtual_host(http_router_id: Optional[str] = None,
                         name: Optional[str] = None,
                         virtual_host_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAlbVirtualHostResult
def get_alb_virtual_host_output(http_router_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         virtual_host_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAlbVirtualHostResult]
Copy
func LookupAlbVirtualHost(ctx *Context, args *LookupAlbVirtualHostArgs, opts ...InvokeOption) (*LookupAlbVirtualHostResult, error)
func LookupAlbVirtualHostOutput(ctx *Context, args *LookupAlbVirtualHostOutputArgs, opts ...InvokeOption) LookupAlbVirtualHostResultOutput
Copy

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

public static class GetAlbVirtualHost 
{
    public static Task<GetAlbVirtualHostResult> InvokeAsync(GetAlbVirtualHostArgs args, InvokeOptions? opts = null)
    public static Output<GetAlbVirtualHostResult> Invoke(GetAlbVirtualHostInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAlbVirtualHostResult> getAlbVirtualHost(GetAlbVirtualHostArgs args, InvokeOptions options)
public static Output<GetAlbVirtualHostResult> getAlbVirtualHost(GetAlbVirtualHostArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: yandex:index/getAlbVirtualHost:getAlbVirtualHost
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

HttpRouterId string
HTTP Router that the resource belongs to.
Name string
Name of the Virtual Host.
VirtualHostId string
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".
HttpRouterId string
HTTP Router that the resource belongs to.
Name string
Name of the Virtual Host.
VirtualHostId string
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".
httpRouterId String
HTTP Router that the resource belongs to.
name String
Name of the Virtual Host.
virtualHostId String
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".
httpRouterId string
HTTP Router that the resource belongs to.
name string
Name of the Virtual Host.
virtualHostId string
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".
http_router_id str
HTTP Router that the resource belongs to.
name str
Name of the Virtual Host.
virtual_host_id str
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".
httpRouterId String
HTTP Router that the resource belongs to.
name String
Name of the Virtual Host.
virtualHostId String
The ID of a specific Virtual Host. Virtual Host ID is concatenation of HTTP Router ID and Virtual Host name with / symbol between them. For Example, "http_router_id/vhost_name".

getAlbVirtualHost Result

The following output properties are available:

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
Id string
The provider-assigned unique ID for this managed resource.
ModifyRequestHeaders List<GetAlbVirtualHostModifyRequestHeader>
Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders List<GetAlbVirtualHostModifyResponseHeader>
Apply the following modifications to the response headers. The structure is documented below.
Name string
name of the route.
Routes List<GetAlbVirtualHostRoute>
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.
VirtualHostId 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.
HttpRouterId string
Id string
The provider-assigned unique ID for this managed resource.
ModifyRequestHeaders []GetAlbVirtualHostModifyRequestHeader
Apply the following modifications to the request headers. The structure is documented below.
ModifyResponseHeaders []GetAlbVirtualHostModifyResponseHeader
Apply the following modifications to the response headers. The structure is documented below.
Name string
name of the route.
Routes []GetAlbVirtualHostRoute
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.
VirtualHostId 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.
httpRouterId String
id String
The provider-assigned unique ID for this managed resource.
modifyRequestHeaders List<GetAlbVirtualHostModifyRequestHeader>
Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders List<GetAlbVirtualHostModifyResponseHeader>
Apply the following modifications to the response headers. The structure is documented below.
name String
name of the route.
routes List<GetAlbVirtualHostRoute>
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.
virtualHostId 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.
httpRouterId string
id string
The provider-assigned unique ID for this managed resource.
modifyRequestHeaders GetAlbVirtualHostModifyRequestHeader[]
Apply the following modifications to the request headers. The structure is documented below.
modifyResponseHeaders GetAlbVirtualHostModifyResponseHeader[]
Apply the following modifications to the response headers. The structure is documented below.
name string
name of the route.
routes GetAlbVirtualHostRoute[]
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.
virtualHostId string
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
id str
The provider-assigned unique ID for this managed resource.
modify_request_headers Sequence[GetAlbVirtualHostModifyRequestHeader]
Apply the following modifications to the request headers. The structure is documented below.
modify_response_headers Sequence[GetAlbVirtualHostModifyResponseHeader]
Apply the following modifications to the response headers. The structure is documented below.
name str
name of the route.
routes Sequence[GetAlbVirtualHostRoute]
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.
virtual_host_id str
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
id String
The provider-assigned unique ID for this managed resource.
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.
virtualHostId String

Supporting Types

GetAlbVirtualHostModifyRequestHeader

Append This property is required. string
Append string to the header value.
Name This property is required. string
Name of the Virtual Host.
Remove This property is required. bool
If set, remove the header.
Replace This property is required. string
New value for a header. Header values support the following formatters.
Append This property is required. string
Append string to the header value.
Name This property is required. string
Name of the Virtual Host.
Remove This property is required. bool
If set, remove the header.
Replace This property is required. string
New value for a header. Header values support the following formatters.
append This property is required. String
Append string to the header value.
name This property is required. String
Name of the Virtual Host.
remove This property is required. Boolean
If set, remove the header.
replace This property is required. String
New value for a header. Header values support the following formatters.
append This property is required. string
Append string to the header value.
name This property is required. string
Name of the Virtual Host.
remove This property is required. boolean
If set, remove the header.
replace This property is required. string
New value for a header. Header values support the following formatters.
append This property is required. str
Append string to the header value.
name This property is required. str
Name of the Virtual Host.
remove This property is required. bool
If set, remove the header.
replace This property is required. str
New value for a header. Header values support the following formatters.
append This property is required. String
Append string to the header value.
name This property is required. String
Name of the Virtual Host.
remove This property is required. Boolean
If set, remove the header.
replace This property is required. String
New value for a header. Header values support the following formatters.

GetAlbVirtualHostModifyResponseHeader

Append This property is required. string
Append string to the header value.
Name This property is required. string
Name of the Virtual Host.
Remove This property is required. bool
If set, remove the header.
Replace This property is required. string
New value for a header. Header values support the following formatters.
Append This property is required. string
Append string to the header value.
Name This property is required. string
Name of the Virtual Host.
Remove This property is required. bool
If set, remove the header.
Replace This property is required. string
New value for a header. Header values support the following formatters.
append This property is required. String
Append string to the header value.
name This property is required. String
Name of the Virtual Host.
remove This property is required. Boolean
If set, remove the header.
replace This property is required. String
New value for a header. Header values support the following formatters.
append This property is required. string
Append string to the header value.
name This property is required. string
Name of the Virtual Host.
remove This property is required. boolean
If set, remove the header.
replace This property is required. string
New value for a header. Header values support the following formatters.
append This property is required. str
Append string to the header value.
name This property is required. str
Name of the Virtual Host.
remove This property is required. bool
If set, remove the header.
replace This property is required. str
New value for a header. Header values support the following formatters.
append This property is required. String
Append string to the header value.
name This property is required. String
Name of the Virtual Host.
remove This property is required. Boolean
If set, remove the header.
replace This property is required. String
New value for a header. Header values support the following formatters.

GetAlbVirtualHostRoute

GrpcRoutes This property is required. List<GetAlbVirtualHostRouteGrpcRoute>
GRPC route resource. The structure is documented below.
HttpRoutes This property is required. List<GetAlbVirtualHostRouteHttpRoute>
HTTP route resource. The structure is documented below.
Name This property is required. string
Name of the Virtual Host.
GrpcRoutes This property is required. []GetAlbVirtualHostRouteGrpcRoute
GRPC route resource. The structure is documented below.
HttpRoutes This property is required. []GetAlbVirtualHostRouteHttpRoute
HTTP route resource. The structure is documented below.
Name This property is required. string
Name of the Virtual Host.
grpcRoutes This property is required. List<GetAlbVirtualHostRouteGrpcRoute>
GRPC route resource. The structure is documented below.
httpRoutes This property is required. List<GetAlbVirtualHostRouteHttpRoute>
HTTP route resource. The structure is documented below.
name This property is required. String
Name of the Virtual Host.
grpcRoutes This property is required. GetAlbVirtualHostRouteGrpcRoute[]
GRPC route resource. The structure is documented below.
httpRoutes This property is required. GetAlbVirtualHostRouteHttpRoute[]
HTTP route resource. The structure is documented below.
name This property is required. string
Name of the Virtual Host.
grpc_routes This property is required. Sequence[GetAlbVirtualHostRouteGrpcRoute]
GRPC route resource. The structure is documented below.
http_routes This property is required. Sequence[GetAlbVirtualHostRouteHttpRoute]
HTTP route resource. The structure is documented below.
name This property is required. str
Name of the Virtual Host.
grpcRoutes This property is required. List<Property Map>
GRPC route resource. The structure is documented below.
httpRoutes This property is required. List<Property Map>
HTTP route resource. The structure is documented below.
name This property is required. String
Name of the Virtual Host.

GetAlbVirtualHostRouteGrpcRoute

GrpcMatches This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcMatch>
Checks "/" prefix by default. The structure is documented below.
GrpcRouteActions This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction>
GRPC route action resource. The structure is documented below.
GrpcStatusResponseActions This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction>
(Required) GRPC status response action resource. The structure is documented below.
GrpcMatches This property is required. []GetAlbVirtualHostRouteGrpcRouteGrpcMatch
Checks "/" prefix by default. The structure is documented below.
GrpcRouteActions This property is required. []GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction
GRPC route action resource. The structure is documented below.
GrpcStatusResponseActions This property is required. []GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction
(Required) GRPC status response action resource. The structure is documented below.
grpcMatches This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcMatch>
Checks "/" prefix by default. The structure is documented below.
grpcRouteActions This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction>
GRPC route action resource. The structure is documented below.
grpcStatusResponseActions This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction>
(Required) GRPC status response action resource. The structure is documented below.
grpcMatches This property is required. GetAlbVirtualHostRouteGrpcRouteGrpcMatch[]
Checks "/" prefix by default. The structure is documented below.
grpcRouteActions This property is required. GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction[]
GRPC route action resource. The structure is documented below.
grpcStatusResponseActions This property is required. GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction[]
(Required) GRPC status response action resource. The structure is documented below.
grpc_matches This property is required. Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcMatch]
Checks "/" prefix by default. The structure is documented below.
grpc_route_actions This property is required. Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction]
GRPC route action resource. The structure is documented below.
grpc_status_response_actions This property is required. Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction]
(Required) GRPC status response action resource. The structure is documented below.
grpcMatches This property is required. List<Property Map>
Checks "/" prefix by default. The structure is documented below.
grpcRouteActions This property is required. List<Property Map>
GRPC route action resource. The structure is documented below.
grpcStatusResponseActions This property is required. List<Property Map>
(Required) GRPC status response action resource. The structure is documented below.

GetAlbVirtualHostRouteGrpcRouteGrpcMatch

Fqmns This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn>
If not set, all services/methods are assumed. The structure is documented below.
Fqmns This property is required. []GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn
If not set, all services/methods are assumed. The structure is documented below.
fqmns This property is required. List<GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn>
If not set, all services/methods are assumed. The structure is documented below.
fqmns This property is required. GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn[]
If not set, all services/methods are assumed. The structure is documented below.
fqmns This property is required. Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn]
If not set, all services/methods are assumed. The structure is documented below.
fqmns This property is required. List<Property Map>
If not set, all services/methods are assumed. The structure is documented below.

GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn

Exact This property is required. string
Prefix This property is required. string
Exact This property is required. string
Prefix This property is required. string
exact This property is required. String
prefix This property is required. String
exact This property is required. string
prefix This property is required. string
exact This property is required. str
prefix This property is required. str
exact This property is required. String
prefix This property is required. String

GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction

AutoHostRewrite This property is required. bool
If set, will automatically rewrite host.
BackendGroupId This property is required. string
Backend group to route requests.
HostRewrite This property is required. string
Host rewrite specifier.
IdleTimeout This property is required. 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 This property is required. string
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.
AutoHostRewrite This property is required. bool
If set, will automatically rewrite host.
BackendGroupId This property is required. string
Backend group to route requests.
HostRewrite This property is required. string
Host rewrite specifier.
IdleTimeout This property is required. 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 This property is required. string
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.
autoHostRewrite This property is required. Boolean
If set, will automatically rewrite host.
backendGroupId This property is required. String
Backend group to route requests.
hostRewrite This property is required. String
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. String
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.
autoHostRewrite This property is required. boolean
If set, will automatically rewrite host.
backendGroupId This property is required. string
Backend group to route requests.
hostRewrite This property is required. string
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. string
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.
auto_host_rewrite This property is required. bool
If set, will automatically rewrite host.
backend_group_id This property is required. str
Backend group to route requests.
host_rewrite This property is required. str
Host rewrite specifier.
idle_timeout This property is required. 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 This property is required. str
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.
autoHostRewrite This property is required. Boolean
If set, will automatically rewrite host.
backendGroupId This property is required. String
Backend group to route requests.
hostRewrite This property is required. String
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. String
Lower timeout may be specified by the client (using grpc-timeout header). If not set, default is 60 seconds.

GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction

Status This property is required. string
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
Status This property is required. string
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
status This property is required. String
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
status This property is required. string
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
status This property is required. str
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
status This property is required. String
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

GetAlbVirtualHostRouteHttpRoute

DirectResponseActions This property is required. List<GetAlbVirtualHostRouteHttpRouteDirectResponseAction>
(Required) Direct response action resource. The structure is documented below.
HttpMatches This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpMatch>
Checks "/" prefix by default. The structure is documented below.
HttpRouteActions This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpRouteAction>
HTTP route action resource. The structure is documented below.
RedirectActions This property is required. List<GetAlbVirtualHostRouteHttpRouteRedirectAction>
Redirect action resource. The structure is documented below.
DirectResponseActions This property is required. []GetAlbVirtualHostRouteHttpRouteDirectResponseAction
(Required) Direct response action resource. The structure is documented below.
HttpMatches This property is required. []GetAlbVirtualHostRouteHttpRouteHttpMatch
Checks "/" prefix by default. The structure is documented below.
HttpRouteActions This property is required. []GetAlbVirtualHostRouteHttpRouteHttpRouteAction
HTTP route action resource. The structure is documented below.
RedirectActions This property is required. []GetAlbVirtualHostRouteHttpRouteRedirectAction
Redirect action resource. The structure is documented below.
directResponseActions This property is required. List<GetAlbVirtualHostRouteHttpRouteDirectResponseAction>
(Required) Direct response action resource. The structure is documented below.
httpMatches This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpMatch>
Checks "/" prefix by default. The structure is documented below.
httpRouteActions This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpRouteAction>
HTTP route action resource. The structure is documented below.
redirectActions This property is required. List<GetAlbVirtualHostRouteHttpRouteRedirectAction>
Redirect action resource. The structure is documented below.
directResponseActions This property is required. GetAlbVirtualHostRouteHttpRouteDirectResponseAction[]
(Required) Direct response action resource. The structure is documented below.
httpMatches This property is required. GetAlbVirtualHostRouteHttpRouteHttpMatch[]
Checks "/" prefix by default. The structure is documented below.
httpRouteActions This property is required. GetAlbVirtualHostRouteHttpRouteHttpRouteAction[]
HTTP route action resource. The structure is documented below.
redirectActions This property is required. GetAlbVirtualHostRouteHttpRouteRedirectAction[]
Redirect action resource. The structure is documented below.
direct_response_actions This property is required. Sequence[GetAlbVirtualHostRouteHttpRouteDirectResponseAction]
(Required) Direct response action resource. The structure is documented below.
http_matches This property is required. Sequence[GetAlbVirtualHostRouteHttpRouteHttpMatch]
Checks "/" prefix by default. The structure is documented below.
http_route_actions This property is required. Sequence[GetAlbVirtualHostRouteHttpRouteHttpRouteAction]
HTTP route action resource. The structure is documented below.
redirect_actions This property is required. Sequence[GetAlbVirtualHostRouteHttpRouteRedirectAction]
Redirect action resource. The structure is documented below.
directResponseActions This property is required. List<Property Map>
(Required) Direct response action resource. The structure is documented below.
httpMatches This property is required. List<Property Map>
Checks "/" prefix by default. The structure is documented below.
httpRouteActions This property is required. List<Property Map>
HTTP route action resource. The structure is documented below.
redirectActions This property is required. List<Property Map>
Redirect action resource. The structure is documented below.

GetAlbVirtualHostRouteHttpRouteDirectResponseAction

Body This property is required. string
Response body text.
Status This property is required. int
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
Body This property is required. string
Response body text.
Status This property is required. int
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
body This property is required. String
Response body text.
status This property is required. Integer
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
body This property is required. string
Response body text.
status This property is required. number
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
body This property is required. str
Response body text.
status This property is required. int
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.
body This property is required. String
Response body text.
status This property is required. Number
The status of the response. Supported values are: ok, invalid_argumet, not_found, permission_denied, unauthenticated, unimplemented, internal, unavailable.

GetAlbVirtualHostRouteHttpRouteHttpMatch

HttpMethods This property is required. List<string>
List of methods(strings).
Paths This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpMatchPath>
If not set, '/' is assumed. The structure is documented below.
HttpMethods This property is required. []string
List of methods(strings).
Paths This property is required. []GetAlbVirtualHostRouteHttpRouteHttpMatchPath
If not set, '/' is assumed. The structure is documented below.
httpMethods This property is required. List<String>
List of methods(strings).
paths This property is required. List<GetAlbVirtualHostRouteHttpRouteHttpMatchPath>
If not set, '/' is assumed. The structure is documented below.
httpMethods This property is required. string[]
List of methods(strings).
paths This property is required. GetAlbVirtualHostRouteHttpRouteHttpMatchPath[]
If not set, '/' is assumed. The structure is documented below.
http_methods This property is required. Sequence[str]
List of methods(strings).
paths This property is required. Sequence[GetAlbVirtualHostRouteHttpRouteHttpMatchPath]
If not set, '/' is assumed. The structure is documented below.
httpMethods This property is required. List<String>
List of methods(strings).
paths This property is required. List<Property Map>
If not set, '/' is assumed. The structure is documented below.

GetAlbVirtualHostRouteHttpRouteHttpMatchPath

Exact This property is required. string
Prefix This property is required. string
Exact This property is required. string
Prefix This property is required. string
exact This property is required. String
prefix This property is required. String
exact This property is required. string
prefix This property is required. string
exact This property is required. str
prefix This property is required. str
exact This property is required. String
prefix This property is required. String

GetAlbVirtualHostRouteHttpRouteHttpRouteAction

AutoHostRewrite This property is required. bool
If set, will automatically rewrite host.
BackendGroupId This property is required. string
Backend group to route requests.
HostRewrite This property is required. string
Host rewrite specifier.
IdleTimeout This property is required. 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 This property is required. string
If not empty, matched path prefix will be replaced by this value.
Timeout This property is required. string
Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
UpgradeTypes This property is required. List<string>
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".
AutoHostRewrite This property is required. bool
If set, will automatically rewrite host.
BackendGroupId This property is required. string
Backend group to route requests.
HostRewrite This property is required. string
Host rewrite specifier.
IdleTimeout This property is required. 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 This property is required. string
If not empty, matched path prefix will be replaced by this value.
Timeout This property is required. string
Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
UpgradeTypes This property is required. []string
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".
autoHostRewrite This property is required. Boolean
If set, will automatically rewrite host.
backendGroupId This property is required. String
Backend group to route requests.
hostRewrite This property is required. String
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. String
If not empty, matched path prefix will be replaced by this value.
timeout This property is required. String
Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes This property is required. List<String>
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".
autoHostRewrite This property is required. boolean
If set, will automatically rewrite host.
backendGroupId This property is required. string
Backend group to route requests.
hostRewrite This property is required. string
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. string
If not empty, matched path prefix will be replaced by this value.
timeout This property is required. string
Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes This property is required. string[]
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".
auto_host_rewrite This property is required. bool
If set, will automatically rewrite host.
backend_group_id This property is required. str
Backend group to route requests.
host_rewrite This property is required. str
Host rewrite specifier.
idle_timeout This property is required. 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 This property is required. str
If not empty, matched path prefix will be replaced by this value.
timeout This property is required. 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 This property is required. Sequence[str]
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".
autoHostRewrite This property is required. Boolean
If set, will automatically rewrite host.
backendGroupId This property is required. String
Backend group to route requests.
hostRewrite This property is required. String
Host rewrite specifier.
idleTimeout This property is required. 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 This property is required. String
If not empty, matched path prefix will be replaced by this value.
timeout This property is required. String
Specifies the request timeout (overall time request processing is allowed to take) for the route. If not set, default is 60 seconds.
upgradeTypes This property is required. List<String>
List of upgrade types. Only specified upgrade types will be allowed. For example, "websocket".

GetAlbVirtualHostRouteHttpRouteRedirectAction

RemoveQuery This property is required. bool
ReplaceHost This property is required. string
Replaces hostname.
ReplacePath This property is required. string
Replace path.
ReplacePort This property is required. int
Replaces port.
ReplacePrefix This property is required. string
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
ReplaceScheme This property is required. string
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
ResponseCode This property is required. string
The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.
RemoveQuery This property is required. bool
ReplaceHost This property is required. string
Replaces hostname.
ReplacePath This property is required. string
Replace path.
ReplacePort This property is required. int
Replaces port.
ReplacePrefix This property is required. string
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
ReplaceScheme This property is required. string
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
ResponseCode This property is required. string
The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.
removeQuery This property is required. Boolean
replaceHost This property is required. String
Replaces hostname.
replacePath This property is required. String
Replace path.
replacePort This property is required. Integer
Replaces port.
replacePrefix This property is required. String
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme This property is required. String
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode This property is required. String
The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.
removeQuery This property is required. boolean
replaceHost This property is required. string
Replaces hostname.
replacePath This property is required. string
Replace path.
replacePort This property is required. number
Replaces port.
replacePrefix This property is required. string
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme This property is required. string
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode This property is required. 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 This property is required. bool
replace_host This property is required. str
Replaces hostname.
replace_path This property is required. str
Replace path.
replace_port This property is required. int
Replaces port.
replace_prefix This property is required. str
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replace_scheme This property is required. str
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
response_code This property is required. str
The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.
removeQuery This property is required. Boolean
replaceHost This property is required. String
Replaces hostname.
replacePath This property is required. String
Replace path.
replacePort This property is required. Number
Replaces port.
replacePrefix This property is required. String
Replace only matched prefix. Example: match:{ prefix_match: "/some" } redirect: { replace_prefix: "/other" } will redirect "/something" to "/otherthing".
replaceScheme This property is required. String
Replaces scheme. If the original scheme is http or https, will also remove the 80 or 443 port, if present.
responseCode This property is required. String
The HTTP status code to use in the redirect response. Supported values are: moved_permanently, found, see_other, temporary_redirect, permanent_redirect.

Package Details

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