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

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

    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,
            }));
        }
    
    }
    
    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
    	})
    }
    

    Coming soon!

    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"])
    
    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,
    });
    

    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>
    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]
    func LookupAlbVirtualHost(ctx *Context, args *LookupAlbVirtualHostArgs, opts ...InvokeOption) (*LookupAlbVirtualHostResult, error)
    func LookupAlbVirtualHostOutput(ctx *Context, args *LookupAlbVirtualHostOutputArgs, opts ...InvokeOption) LookupAlbVirtualHostResultOutput

    > 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)
    }
    public static CompletableFuture<GetAlbVirtualHostResult> getAlbVirtualHost(GetAlbVirtualHostArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: yandex:index/getAlbVirtualHost:getAlbVirtualHost
      arguments:
        # arguments dictionary

    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 string

    Append string to the header value.

    Name string

    Name of the Virtual Host.

    Remove bool

    If set, remove the header.

    Replace string

    New value for a header. Header values support the following formatters.

    Append string

    Append string to the header value.

    Name string

    Name of the Virtual Host.

    Remove bool

    If set, remove the header.

    Replace string

    New value for a header. Header values support the following formatters.

    append String

    Append string to the header value.

    name String

    Name of the Virtual Host.

    remove Boolean

    If set, remove the header.

    replace String

    New value for a header. Header values support the following formatters.

    append string

    Append string to the header value.

    name string

    Name of the Virtual Host.

    remove boolean

    If set, remove the header.

    replace string

    New value for a header. Header values support the following formatters.

    append str

    Append string to the header value.

    name str

    Name of the Virtual Host.

    remove bool

    If set, remove the header.

    replace str

    New value for a header. Header values support the following formatters.

    append String

    Append string to the header value.

    name String

    Name of the Virtual Host.

    remove Boolean

    If set, remove the header.

    replace String

    New value for a header. Header values support the following formatters.

    GetAlbVirtualHostModifyResponseHeader

    Append string

    Append string to the header value.

    Name string

    Name of the Virtual Host.

    Remove bool

    If set, remove the header.

    Replace string

    New value for a header. Header values support the following formatters.

    Append string

    Append string to the header value.

    Name string

    Name of the Virtual Host.

    Remove bool

    If set, remove the header.

    Replace string

    New value for a header. Header values support the following formatters.

    append String

    Append string to the header value.

    name String

    Name of the Virtual Host.

    remove Boolean

    If set, remove the header.

    replace String

    New value for a header. Header values support the following formatters.

    append string

    Append string to the header value.

    name string

    Name of the Virtual Host.

    remove boolean

    If set, remove the header.

    replace string

    New value for a header. Header values support the following formatters.

    append str

    Append string to the header value.

    name str

    Name of the Virtual Host.

    remove bool

    If set, remove the header.

    replace str

    New value for a header. Header values support the following formatters.

    append String

    Append string to the header value.

    name String

    Name of the Virtual Host.

    remove Boolean

    If set, remove the header.

    replace String

    New value for a header. Header values support the following formatters.

    GetAlbVirtualHostRoute

    GrpcRoutes List<GetAlbVirtualHostRouteGrpcRoute>

    GRPC route resource. The structure is documented below.

    HttpRoutes List<GetAlbVirtualHostRouteHttpRoute>

    HTTP route resource. The structure is documented below.

    Name string

    Name of the Virtual Host.

    GrpcRoutes []GetAlbVirtualHostRouteGrpcRoute

    GRPC route resource. The structure is documented below.

    HttpRoutes []GetAlbVirtualHostRouteHttpRoute

    HTTP route resource. The structure is documented below.

    Name string

    Name of the Virtual Host.

    grpcRoutes List<GetAlbVirtualHostRouteGrpcRoute>

    GRPC route resource. The structure is documented below.

    httpRoutes List<GetAlbVirtualHostRouteHttpRoute>

    HTTP route resource. The structure is documented below.

    name String

    Name of the Virtual Host.

    grpcRoutes GetAlbVirtualHostRouteGrpcRoute[]

    GRPC route resource. The structure is documented below.

    httpRoutes GetAlbVirtualHostRouteHttpRoute[]

    HTTP route resource. The structure is documented below.

    name string

    Name of the Virtual Host.

    grpc_routes Sequence[GetAlbVirtualHostRouteGrpcRoute]

    GRPC route resource. The structure is documented below.

    http_routes Sequence[GetAlbVirtualHostRouteHttpRoute]

    HTTP route resource. The structure is documented below.

    name str

    Name of the Virtual Host.

    grpcRoutes List<Property Map>

    GRPC route resource. The structure is documented below.

    httpRoutes List<Property Map>

    HTTP route resource. The structure is documented below.

    name String

    Name of the Virtual Host.

    GetAlbVirtualHostRouteGrpcRoute

    GrpcMatches List<GetAlbVirtualHostRouteGrpcRouteGrpcMatch>

    Checks "/" prefix by default. The structure is documented below.

    GrpcRouteActions List<GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction>

    GRPC route action resource. The structure is documented below.

    GrpcStatusResponseActions List<GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction>

    (Required) GRPC status response action resource. The structure is documented below.

    GrpcMatches []GetAlbVirtualHostRouteGrpcRouteGrpcMatch

    Checks "/" prefix by default. The structure is documented below.

    GrpcRouteActions []GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction

    GRPC route action resource. The structure is documented below.

    GrpcStatusResponseActions []GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction

    (Required) GRPC status response action resource. The structure is documented below.

    grpcMatches List<GetAlbVirtualHostRouteGrpcRouteGrpcMatch>

    Checks "/" prefix by default. The structure is documented below.

    grpcRouteActions List<GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction>

    GRPC route action resource. The structure is documented below.

    grpcStatusResponseActions List<GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction>

    (Required) GRPC status response action resource. The structure is documented below.

    grpcMatches GetAlbVirtualHostRouteGrpcRouteGrpcMatch[]

    Checks "/" prefix by default. The structure is documented below.

    grpcRouteActions GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction[]

    GRPC route action resource. The structure is documented below.

    grpcStatusResponseActions GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction[]

    (Required) GRPC status response action resource. The structure is documented below.

    grpc_matches Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcMatch]

    Checks "/" prefix by default. The structure is documented below.

    grpc_route_actions Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction]

    GRPC route action resource. The structure is documented below.

    grpc_status_response_actions Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction]

    (Required) GRPC status response action resource. The structure is documented below.

    grpcMatches List<Property Map>

    Checks "/" prefix by default. The structure is documented below.

    grpcRouteActions List<Property Map>

    GRPC route action resource. The structure is documented below.

    grpcStatusResponseActions List<Property Map>

    (Required) GRPC status response action resource. The structure is documented below.

    GetAlbVirtualHostRouteGrpcRouteGrpcMatch

    Fqmns List<GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn>

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

    Fqmns []GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn

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

    fqmns List<GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn>

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

    fqmns GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn[]

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

    fqmns Sequence[GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn]

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

    fqmns List<Property Map>

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

    GetAlbVirtualHostRouteGrpcRouteGrpcMatchFqmn

    Exact string
    Prefix string
    Exact string
    Prefix string
    exact String
    prefix String
    exact string
    prefix string
    exact str
    prefix str
    exact String
    prefix String

    GetAlbVirtualHostRouteGrpcRouteGrpcRouteAction

    AutoHostRewrite bool

    If set, will automatically rewrite host.

    BackendGroupId string

    Backend group to route requests.

    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.

    AutoHostRewrite bool

    If set, will automatically rewrite host.

    BackendGroupId string

    Backend group to route requests.

    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.

    autoHostRewrite Boolean

    If set, will automatically rewrite host.

    backendGroupId String

    Backend group to route requests.

    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.

    autoHostRewrite boolean

    If set, will automatically rewrite host.

    backendGroupId string

    Backend group to route requests.

    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.

    auto_host_rewrite bool

    If set, will automatically rewrite host.

    backend_group_id str

    Backend group to route requests.

    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.

    autoHostRewrite Boolean

    If set, will automatically rewrite host.

    backendGroupId String

    Backend group to route requests.

    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.

    GetAlbVirtualHostRouteGrpcRouteGrpcStatusResponseAction

    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.

    GetAlbVirtualHostRouteHttpRoute

    DirectResponseActions List<GetAlbVirtualHostRouteHttpRouteDirectResponseAction>

    (Required) Direct response action resource. The structure is documented below.

    HttpMatches List<GetAlbVirtualHostRouteHttpRouteHttpMatch>

    Checks "/" prefix by default. The structure is documented below.

    HttpRouteActions List<GetAlbVirtualHostRouteHttpRouteHttpRouteAction>

    HTTP route action resource. The structure is documented below.

    RedirectActions List<GetAlbVirtualHostRouteHttpRouteRedirectAction>

    Redirect action resource. The structure is documented below.

    DirectResponseActions []GetAlbVirtualHostRouteHttpRouteDirectResponseAction

    (Required) Direct response action resource. The structure is documented below.

    HttpMatches []GetAlbVirtualHostRouteHttpRouteHttpMatch

    Checks "/" prefix by default. The structure is documented below.

    HttpRouteActions []GetAlbVirtualHostRouteHttpRouteHttpRouteAction

    HTTP route action resource. The structure is documented below.

    RedirectActions []GetAlbVirtualHostRouteHttpRouteRedirectAction

    Redirect action resource. The structure is documented below.

    directResponseActions List<GetAlbVirtualHostRouteHttpRouteDirectResponseAction>

    (Required) Direct response action resource. The structure is documented below.

    httpMatches List<GetAlbVirtualHostRouteHttpRouteHttpMatch>

    Checks "/" prefix by default. The structure is documented below.

    httpRouteActions List<GetAlbVirtualHostRouteHttpRouteHttpRouteAction>

    HTTP route action resource. The structure is documented below.

    redirectActions List<GetAlbVirtualHostRouteHttpRouteRedirectAction>

    Redirect action resource. The structure is documented below.

    directResponseActions GetAlbVirtualHostRouteHttpRouteDirectResponseAction[]

    (Required) Direct response action resource. The structure is documented below.

    httpMatches GetAlbVirtualHostRouteHttpRouteHttpMatch[]

    Checks "/" prefix by default. The structure is documented below.

    httpRouteActions GetAlbVirtualHostRouteHttpRouteHttpRouteAction[]

    HTTP route action resource. The structure is documented below.

    redirectActions GetAlbVirtualHostRouteHttpRouteRedirectAction[]

    Redirect action resource. The structure is documented below.

    direct_response_actions Sequence[GetAlbVirtualHostRouteHttpRouteDirectResponseAction]

    (Required) Direct response action resource. The structure is documented below.

    http_matches Sequence[GetAlbVirtualHostRouteHttpRouteHttpMatch]

    Checks "/" prefix by default. The structure is documented below.

    http_route_actions Sequence[GetAlbVirtualHostRouteHttpRouteHttpRouteAction]

    HTTP route action resource. The structure is documented below.

    redirect_actions Sequence[GetAlbVirtualHostRouteHttpRouteRedirectAction]

    Redirect action resource. The structure is documented below.

    directResponseActions List<Property Map>

    (Required) Direct response action resource. The structure is documented below.

    httpMatches List<Property Map>

    Checks "/" prefix by default. The structure is documented below.

    httpRouteActions List<Property Map>

    HTTP route action resource. The structure is documented below.

    redirectActions List<Property Map>

    Redirect action resource. The structure is documented below.

    GetAlbVirtualHostRouteHttpRouteDirectResponseAction

    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.

    GetAlbVirtualHostRouteHttpRouteHttpMatch

    HttpMethods List<string>

    List of methods(strings).

    Paths List<GetAlbVirtualHostRouteHttpRouteHttpMatchPath>

    If not set, '/' is assumed. The structure is documented below.

    HttpMethods []string

    List of methods(strings).

    Paths []GetAlbVirtualHostRouteHttpRouteHttpMatchPath

    If not set, '/' is assumed. The structure is documented below.

    httpMethods List<String>

    List of methods(strings).

    paths List<GetAlbVirtualHostRouteHttpRouteHttpMatchPath>

    If not set, '/' is assumed. The structure is documented below.

    httpMethods string[]

    List of methods(strings).

    paths GetAlbVirtualHostRouteHttpRouteHttpMatchPath[]

    If not set, '/' is assumed. The structure is documented below.

    http_methods Sequence[str]

    List of methods(strings).

    paths Sequence[GetAlbVirtualHostRouteHttpRouteHttpMatchPath]

    If not set, '/' is assumed. The structure is documented below.

    httpMethods List<String>

    List of methods(strings).

    paths List<Property Map>

    If not set, '/' is assumed. The structure is documented below.

    GetAlbVirtualHostRouteHttpRouteHttpMatchPath

    Exact string
    Prefix string
    Exact string
    Prefix string
    exact String
    prefix String
    exact string
    prefix string
    exact str
    prefix str
    exact String
    prefix String

    GetAlbVirtualHostRouteHttpRouteHttpRouteAction

    AutoHostRewrite bool

    If set, will automatically rewrite host.

    BackendGroupId string

    Backend group to route requests.

    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".

    AutoHostRewrite bool

    If set, will automatically rewrite host.

    BackendGroupId string

    Backend group to route requests.

    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".

    autoHostRewrite Boolean

    If set, will automatically rewrite host.

    backendGroupId String

    Backend group to route requests.

    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".

    autoHostRewrite boolean

    If set, will automatically rewrite host.

    backendGroupId string

    Backend group to route requests.

    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".

    auto_host_rewrite bool

    If set, will automatically rewrite host.

    backend_group_id str

    Backend group to route requests.

    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".

    autoHostRewrite Boolean

    If set, will automatically rewrite host.

    backendGroupId String

    Backend group to route requests.

    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".

    GetAlbVirtualHostRouteHttpRouteRedirectAction

    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.

    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