1. Packages
  2. AWS
  3. API Docs
  4. appmesh
  5. GatewayRoute
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.appmesh.GatewayRoute

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides an AWS App Mesh gateway route resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appmesh.GatewayRoute("example", {
        name: "example-gateway-route",
        meshName: "example-service-mesh",
        virtualGatewayName: exampleAwsAppmeshVirtualGateway.name,
        spec: {
            httpRoute: {
                action: {
                    target: {
                        virtualService: {
                            virtualServiceName: exampleAwsAppmeshVirtualService.name,
                        },
                    },
                },
                match: {
                    prefix: "/",
                },
            },
        },
        tags: {
            Environment: "test",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appmesh.GatewayRoute("example",
        name="example-gateway-route",
        mesh_name="example-service-mesh",
        virtual_gateway_name=example_aws_appmesh_virtual_gateway["name"],
        spec={
            "http_route": {
                "action": {
                    "target": {
                        "virtual_service": {
                            "virtual_service_name": example_aws_appmesh_virtual_service["name"],
                        },
                    },
                },
                "match": {
                    "prefix": "/",
                },
            },
        },
        tags={
            "Environment": "test",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appmesh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appmesh.NewGatewayRoute(ctx, "example", &appmesh.GatewayRouteArgs{
    			Name:               pulumi.String("example-gateway-route"),
    			MeshName:           pulumi.String("example-service-mesh"),
    			VirtualGatewayName: pulumi.Any(exampleAwsAppmeshVirtualGateway.Name),
    			Spec: &appmesh.GatewayRouteSpecArgs{
    				HttpRoute: &appmesh.GatewayRouteSpecHttpRouteArgs{
    					Action: &appmesh.GatewayRouteSpecHttpRouteActionArgs{
    						Target: &appmesh.GatewayRouteSpecHttpRouteActionTargetArgs{
    							VirtualService: &appmesh.GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs{
    								VirtualServiceName: pulumi.Any(exampleAwsAppmeshVirtualService.Name),
    							},
    						},
    					},
    					Match: &appmesh.GatewayRouteSpecHttpRouteMatchArgs{
    						Prefix: pulumi.String("/"),
    					},
    				},
    			},
    			Tags: pulumi.StringMap{
    				"Environment": pulumi.String("test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppMesh.GatewayRoute("example", new()
        {
            Name = "example-gateway-route",
            MeshName = "example-service-mesh",
            VirtualGatewayName = exampleAwsAppmeshVirtualGateway.Name,
            Spec = new Aws.AppMesh.Inputs.GatewayRouteSpecArgs
            {
                HttpRoute = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteArgs
                {
                    Action = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionArgs
                    {
                        Target = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionTargetArgs
                        {
                            VirtualService = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs
                            {
                                VirtualServiceName = exampleAwsAppmeshVirtualService.Name,
                            },
                        },
                    },
                    Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchArgs
                    {
                        Prefix = "/",
                    },
                },
            },
            Tags = 
            {
                { "Environment", "test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appmesh.GatewayRoute;
    import com.pulumi.aws.appmesh.GatewayRouteArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecHttpRouteArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecHttpRouteActionArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecHttpRouteActionTargetArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs;
    import com.pulumi.aws.appmesh.inputs.GatewayRouteSpecHttpRouteMatchArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new GatewayRoute("example", GatewayRouteArgs.builder()
                .name("example-gateway-route")
                .meshName("example-service-mesh")
                .virtualGatewayName(exampleAwsAppmeshVirtualGateway.name())
                .spec(GatewayRouteSpecArgs.builder()
                    .httpRoute(GatewayRouteSpecHttpRouteArgs.builder()
                        .action(GatewayRouteSpecHttpRouteActionArgs.builder()
                            .target(GatewayRouteSpecHttpRouteActionTargetArgs.builder()
                                .virtualService(GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs.builder()
                                    .virtualServiceName(exampleAwsAppmeshVirtualService.name())
                                    .build())
                                .build())
                            .build())
                        .match(GatewayRouteSpecHttpRouteMatchArgs.builder()
                            .prefix("/")
                            .build())
                        .build())
                    .build())
                .tags(Map.of("Environment", "test"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appmesh:GatewayRoute
        properties:
          name: example-gateway-route
          meshName: example-service-mesh
          virtualGatewayName: ${exampleAwsAppmeshVirtualGateway.name}
          spec:
            httpRoute:
              action:
                target:
                  virtualService:
                    virtualServiceName: ${exampleAwsAppmeshVirtualService.name}
              match:
                prefix: /
          tags:
            Environment: test
    

    Create GatewayRoute Resource

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

    Constructor syntax

    new GatewayRoute(name: string, args: GatewayRouteArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayRoute(resource_name: str,
                     args: GatewayRouteArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayRoute(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     mesh_name: Optional[str] = None,
                     spec: Optional[GatewayRouteSpecArgs] = None,
                     virtual_gateway_name: Optional[str] = None,
                     mesh_owner: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewGatewayRoute(ctx *Context, name string, args GatewayRouteArgs, opts ...ResourceOption) (*GatewayRoute, error)
    public GatewayRoute(string name, GatewayRouteArgs args, CustomResourceOptions? opts = null)
    public GatewayRoute(String name, GatewayRouteArgs args)
    public GatewayRoute(String name, GatewayRouteArgs args, CustomResourceOptions options)
    
    type: aws:appmesh:GatewayRoute
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gatewayRouteResource = new Aws.AppMesh.GatewayRoute("gatewayRouteResource", new()
    {
        MeshName = "string",
        Spec = new Aws.AppMesh.Inputs.GatewayRouteSpecArgs
        {
            GrpcRoute = new Aws.AppMesh.Inputs.GatewayRouteSpecGrpcRouteArgs
            {
                Action = new Aws.AppMesh.Inputs.GatewayRouteSpecGrpcRouteActionArgs
                {
                    Target = new Aws.AppMesh.Inputs.GatewayRouteSpecGrpcRouteActionTargetArgs
                    {
                        VirtualService = new Aws.AppMesh.Inputs.GatewayRouteSpecGrpcRouteActionTargetVirtualServiceArgs
                        {
                            VirtualServiceName = "string",
                        },
                        Port = 0,
                    },
                },
                Match = new Aws.AppMesh.Inputs.GatewayRouteSpecGrpcRouteMatchArgs
                {
                    ServiceName = "string",
                    Port = 0,
                },
            },
            Http2Route = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteArgs
            {
                Action = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionArgs
                {
                    Target = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionTargetArgs
                    {
                        VirtualService = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionTargetVirtualServiceArgs
                        {
                            VirtualServiceName = "string",
                        },
                        Port = 0,
                    },
                    Rewrite = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionRewriteArgs
                    {
                        Hostname = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionRewriteHostnameArgs
                        {
                            DefaultTargetHostname = "string",
                        },
                        Path = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionRewritePathArgs
                        {
                            Exact = "string",
                        },
                        Prefix = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteActionRewritePrefixArgs
                        {
                            DefaultPrefix = "string",
                            Value = "string",
                        },
                    },
                },
                Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchArgs
                {
                    Headers = new[]
                    {
                        new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchHeaderArgs
                        {
                            Name = "string",
                            Invert = false,
                            Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchHeaderMatchArgs
                            {
                                Exact = "string",
                                Prefix = "string",
                                Range = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchHeaderMatchRangeArgs
                                {
                                    End = 0,
                                    Start = 0,
                                },
                                Regex = "string",
                                Suffix = "string",
                            },
                        },
                    },
                    Hostname = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchHostnameArgs
                    {
                        Exact = "string",
                        Suffix = "string",
                    },
                    Path = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchPathArgs
                    {
                        Exact = "string",
                        Regex = "string",
                    },
                    Port = 0,
                    Prefix = "string",
                    QueryParameters = new[]
                    {
                        new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchQueryParameterArgs
                        {
                            Name = "string",
                            Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttp2RouteMatchQueryParameterMatchArgs
                            {
                                Exact = "string",
                            },
                        },
                    },
                },
            },
            HttpRoute = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteArgs
            {
                Action = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionArgs
                {
                    Target = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionTargetArgs
                    {
                        VirtualService = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs
                        {
                            VirtualServiceName = "string",
                        },
                        Port = 0,
                    },
                    Rewrite = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionRewriteArgs
                    {
                        Hostname = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionRewriteHostnameArgs
                        {
                            DefaultTargetHostname = "string",
                        },
                        Path = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionRewritePathArgs
                        {
                            Exact = "string",
                        },
                        Prefix = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteActionRewritePrefixArgs
                        {
                            DefaultPrefix = "string",
                            Value = "string",
                        },
                    },
                },
                Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchArgs
                {
                    Headers = new[]
                    {
                        new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchHeaderArgs
                        {
                            Name = "string",
                            Invert = false,
                            Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchHeaderMatchArgs
                            {
                                Exact = "string",
                                Prefix = "string",
                                Range = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchHeaderMatchRangeArgs
                                {
                                    End = 0,
                                    Start = 0,
                                },
                                Regex = "string",
                                Suffix = "string",
                            },
                        },
                    },
                    Hostname = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchHostnameArgs
                    {
                        Exact = "string",
                        Suffix = "string",
                    },
                    Path = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchPathArgs
                    {
                        Exact = "string",
                        Regex = "string",
                    },
                    Port = 0,
                    Prefix = "string",
                    QueryParameters = new[]
                    {
                        new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchQueryParameterArgs
                        {
                            Name = "string",
                            Match = new Aws.AppMesh.Inputs.GatewayRouteSpecHttpRouteMatchQueryParameterMatchArgs
                            {
                                Exact = "string",
                            },
                        },
                    },
                },
            },
            Priority = 0,
        },
        VirtualGatewayName = "string",
        MeshOwner = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := appmesh.NewGatewayRoute(ctx, "gatewayRouteResource", &appmesh.GatewayRouteArgs{
    	MeshName: pulumi.String("string"),
    	Spec: &appmesh.GatewayRouteSpecArgs{
    		GrpcRoute: &appmesh.GatewayRouteSpecGrpcRouteArgs{
    			Action: &appmesh.GatewayRouteSpecGrpcRouteActionArgs{
    				Target: &appmesh.GatewayRouteSpecGrpcRouteActionTargetArgs{
    					VirtualService: &appmesh.GatewayRouteSpecGrpcRouteActionTargetVirtualServiceArgs{
    						VirtualServiceName: pulumi.String("string"),
    					},
    					Port: pulumi.Int(0),
    				},
    			},
    			Match: &appmesh.GatewayRouteSpecGrpcRouteMatchArgs{
    				ServiceName: pulumi.String("string"),
    				Port:        pulumi.Int(0),
    			},
    		},
    		Http2Route: &appmesh.GatewayRouteSpecHttp2RouteArgs{
    			Action: &appmesh.GatewayRouteSpecHttp2RouteActionArgs{
    				Target: &appmesh.GatewayRouteSpecHttp2RouteActionTargetArgs{
    					VirtualService: &appmesh.GatewayRouteSpecHttp2RouteActionTargetVirtualServiceArgs{
    						VirtualServiceName: pulumi.String("string"),
    					},
    					Port: pulumi.Int(0),
    				},
    				Rewrite: &appmesh.GatewayRouteSpecHttp2RouteActionRewriteArgs{
    					Hostname: &appmesh.GatewayRouteSpecHttp2RouteActionRewriteHostnameArgs{
    						DefaultTargetHostname: pulumi.String("string"),
    					},
    					Path: &appmesh.GatewayRouteSpecHttp2RouteActionRewritePathArgs{
    						Exact: pulumi.String("string"),
    					},
    					Prefix: &appmesh.GatewayRouteSpecHttp2RouteActionRewritePrefixArgs{
    						DefaultPrefix: pulumi.String("string"),
    						Value:         pulumi.String("string"),
    					},
    				},
    			},
    			Match: &appmesh.GatewayRouteSpecHttp2RouteMatchArgs{
    				Headers: appmesh.GatewayRouteSpecHttp2RouteMatchHeaderArray{
    					&appmesh.GatewayRouteSpecHttp2RouteMatchHeaderArgs{
    						Name:   pulumi.String("string"),
    						Invert: pulumi.Bool(false),
    						Match: &appmesh.GatewayRouteSpecHttp2RouteMatchHeaderMatchArgs{
    							Exact:  pulumi.String("string"),
    							Prefix: pulumi.String("string"),
    							Range: &appmesh.GatewayRouteSpecHttp2RouteMatchHeaderMatchRangeArgs{
    								End:   pulumi.Int(0),
    								Start: pulumi.Int(0),
    							},
    							Regex:  pulumi.String("string"),
    							Suffix: pulumi.String("string"),
    						},
    					},
    				},
    				Hostname: &appmesh.GatewayRouteSpecHttp2RouteMatchHostnameArgs{
    					Exact:  pulumi.String("string"),
    					Suffix: pulumi.String("string"),
    				},
    				Path: &appmesh.GatewayRouteSpecHttp2RouteMatchPathArgs{
    					Exact: pulumi.String("string"),
    					Regex: pulumi.String("string"),
    				},
    				Port:   pulumi.Int(0),
    				Prefix: pulumi.String("string"),
    				QueryParameters: appmesh.GatewayRouteSpecHttp2RouteMatchQueryParameterArray{
    					&appmesh.GatewayRouteSpecHttp2RouteMatchQueryParameterArgs{
    						Name: pulumi.String("string"),
    						Match: &appmesh.GatewayRouteSpecHttp2RouteMatchQueryParameterMatchArgs{
    							Exact: pulumi.String("string"),
    						},
    					},
    				},
    			},
    		},
    		HttpRoute: &appmesh.GatewayRouteSpecHttpRouteArgs{
    			Action: &appmesh.GatewayRouteSpecHttpRouteActionArgs{
    				Target: &appmesh.GatewayRouteSpecHttpRouteActionTargetArgs{
    					VirtualService: &appmesh.GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs{
    						VirtualServiceName: pulumi.String("string"),
    					},
    					Port: pulumi.Int(0),
    				},
    				Rewrite: &appmesh.GatewayRouteSpecHttpRouteActionRewriteArgs{
    					Hostname: &appmesh.GatewayRouteSpecHttpRouteActionRewriteHostnameArgs{
    						DefaultTargetHostname: pulumi.String("string"),
    					},
    					Path: &appmesh.GatewayRouteSpecHttpRouteActionRewritePathArgs{
    						Exact: pulumi.String("string"),
    					},
    					Prefix: &appmesh.GatewayRouteSpecHttpRouteActionRewritePrefixArgs{
    						DefaultPrefix: pulumi.String("string"),
    						Value:         pulumi.String("string"),
    					},
    				},
    			},
    			Match: &appmesh.GatewayRouteSpecHttpRouteMatchArgs{
    				Headers: appmesh.GatewayRouteSpecHttpRouteMatchHeaderArray{
    					&appmesh.GatewayRouteSpecHttpRouteMatchHeaderArgs{
    						Name:   pulumi.String("string"),
    						Invert: pulumi.Bool(false),
    						Match: &appmesh.GatewayRouteSpecHttpRouteMatchHeaderMatchArgs{
    							Exact:  pulumi.String("string"),
    							Prefix: pulumi.String("string"),
    							Range: &appmesh.GatewayRouteSpecHttpRouteMatchHeaderMatchRangeArgs{
    								End:   pulumi.Int(0),
    								Start: pulumi.Int(0),
    							},
    							Regex:  pulumi.String("string"),
    							Suffix: pulumi.String("string"),
    						},
    					},
    				},
    				Hostname: &appmesh.GatewayRouteSpecHttpRouteMatchHostnameArgs{
    					Exact:  pulumi.String("string"),
    					Suffix: pulumi.String("string"),
    				},
    				Path: &appmesh.GatewayRouteSpecHttpRouteMatchPathArgs{
    					Exact: pulumi.String("string"),
    					Regex: pulumi.String("string"),
    				},
    				Port:   pulumi.Int(0),
    				Prefix: pulumi.String("string"),
    				QueryParameters: appmesh.GatewayRouteSpecHttpRouteMatchQueryParameterArray{
    					&appmesh.GatewayRouteSpecHttpRouteMatchQueryParameterArgs{
    						Name: pulumi.String("string"),
    						Match: &appmesh.GatewayRouteSpecHttpRouteMatchQueryParameterMatchArgs{
    							Exact: pulumi.String("string"),
    						},
    					},
    				},
    			},
    		},
    		Priority: pulumi.Int(0),
    	},
    	VirtualGatewayName: pulumi.String("string"),
    	MeshOwner:          pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var gatewayRouteResource = new GatewayRoute("gatewayRouteResource", GatewayRouteArgs.builder()
        .meshName("string")
        .spec(GatewayRouteSpecArgs.builder()
            .grpcRoute(GatewayRouteSpecGrpcRouteArgs.builder()
                .action(GatewayRouteSpecGrpcRouteActionArgs.builder()
                    .target(GatewayRouteSpecGrpcRouteActionTargetArgs.builder()
                        .virtualService(GatewayRouteSpecGrpcRouteActionTargetVirtualServiceArgs.builder()
                            .virtualServiceName("string")
                            .build())
                        .port(0)
                        .build())
                    .build())
                .match(GatewayRouteSpecGrpcRouteMatchArgs.builder()
                    .serviceName("string")
                    .port(0)
                    .build())
                .build())
            .http2Route(GatewayRouteSpecHttp2RouteArgs.builder()
                .action(GatewayRouteSpecHttp2RouteActionArgs.builder()
                    .target(GatewayRouteSpecHttp2RouteActionTargetArgs.builder()
                        .virtualService(GatewayRouteSpecHttp2RouteActionTargetVirtualServiceArgs.builder()
                            .virtualServiceName("string")
                            .build())
                        .port(0)
                        .build())
                    .rewrite(GatewayRouteSpecHttp2RouteActionRewriteArgs.builder()
                        .hostname(GatewayRouteSpecHttp2RouteActionRewriteHostnameArgs.builder()
                            .defaultTargetHostname("string")
                            .build())
                        .path(GatewayRouteSpecHttp2RouteActionRewritePathArgs.builder()
                            .exact("string")
                            .build())
                        .prefix(GatewayRouteSpecHttp2RouteActionRewritePrefixArgs.builder()
                            .defaultPrefix("string")
                            .value("string")
                            .build())
                        .build())
                    .build())
                .match(GatewayRouteSpecHttp2RouteMatchArgs.builder()
                    .headers(GatewayRouteSpecHttp2RouteMatchHeaderArgs.builder()
                        .name("string")
                        .invert(false)
                        .match(GatewayRouteSpecHttp2RouteMatchHeaderMatchArgs.builder()
                            .exact("string")
                            .prefix("string")
                            .range(GatewayRouteSpecHttp2RouteMatchHeaderMatchRangeArgs.builder()
                                .end(0)
                                .start(0)
                                .build())
                            .regex("string")
                            .suffix("string")
                            .build())
                        .build())
                    .hostname(GatewayRouteSpecHttp2RouteMatchHostnameArgs.builder()
                        .exact("string")
                        .suffix("string")
                        .build())
                    .path(GatewayRouteSpecHttp2RouteMatchPathArgs.builder()
                        .exact("string")
                        .regex("string")
                        .build())
                    .port(0)
                    .prefix("string")
                    .queryParameters(GatewayRouteSpecHttp2RouteMatchQueryParameterArgs.builder()
                        .name("string")
                        .match(GatewayRouteSpecHttp2RouteMatchQueryParameterMatchArgs.builder()
                            .exact("string")
                            .build())
                        .build())
                    .build())
                .build())
            .httpRoute(GatewayRouteSpecHttpRouteArgs.builder()
                .action(GatewayRouteSpecHttpRouteActionArgs.builder()
                    .target(GatewayRouteSpecHttpRouteActionTargetArgs.builder()
                        .virtualService(GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs.builder()
                            .virtualServiceName("string")
                            .build())
                        .port(0)
                        .build())
                    .rewrite(GatewayRouteSpecHttpRouteActionRewriteArgs.builder()
                        .hostname(GatewayRouteSpecHttpRouteActionRewriteHostnameArgs.builder()
                            .defaultTargetHostname("string")
                            .build())
                        .path(GatewayRouteSpecHttpRouteActionRewritePathArgs.builder()
                            .exact("string")
                            .build())
                        .prefix(GatewayRouteSpecHttpRouteActionRewritePrefixArgs.builder()
                            .defaultPrefix("string")
                            .value("string")
                            .build())
                        .build())
                    .build())
                .match(GatewayRouteSpecHttpRouteMatchArgs.builder()
                    .headers(GatewayRouteSpecHttpRouteMatchHeaderArgs.builder()
                        .name("string")
                        .invert(false)
                        .match(GatewayRouteSpecHttpRouteMatchHeaderMatchArgs.builder()
                            .exact("string")
                            .prefix("string")
                            .range(GatewayRouteSpecHttpRouteMatchHeaderMatchRangeArgs.builder()
                                .end(0)
                                .start(0)
                                .build())
                            .regex("string")
                            .suffix("string")
                            .build())
                        .build())
                    .hostname(GatewayRouteSpecHttpRouteMatchHostnameArgs.builder()
                        .exact("string")
                        .suffix("string")
                        .build())
                    .path(GatewayRouteSpecHttpRouteMatchPathArgs.builder()
                        .exact("string")
                        .regex("string")
                        .build())
                    .port(0)
                    .prefix("string")
                    .queryParameters(GatewayRouteSpecHttpRouteMatchQueryParameterArgs.builder()
                        .name("string")
                        .match(GatewayRouteSpecHttpRouteMatchQueryParameterMatchArgs.builder()
                            .exact("string")
                            .build())
                        .build())
                    .build())
                .build())
            .priority(0)
            .build())
        .virtualGatewayName("string")
        .meshOwner("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    gateway_route_resource = aws.appmesh.GatewayRoute("gatewayRouteResource",
        mesh_name="string",
        spec={
            "grpc_route": {
                "action": {
                    "target": {
                        "virtual_service": {
                            "virtual_service_name": "string",
                        },
                        "port": 0,
                    },
                },
                "match": {
                    "service_name": "string",
                    "port": 0,
                },
            },
            "http2_route": {
                "action": {
                    "target": {
                        "virtual_service": {
                            "virtual_service_name": "string",
                        },
                        "port": 0,
                    },
                    "rewrite": {
                        "hostname": {
                            "default_target_hostname": "string",
                        },
                        "path": {
                            "exact": "string",
                        },
                        "prefix": {
                            "default_prefix": "string",
                            "value": "string",
                        },
                    },
                },
                "match": {
                    "headers": [{
                        "name": "string",
                        "invert": False,
                        "match": {
                            "exact": "string",
                            "prefix": "string",
                            "range": {
                                "end": 0,
                                "start": 0,
                            },
                            "regex": "string",
                            "suffix": "string",
                        },
                    }],
                    "hostname": {
                        "exact": "string",
                        "suffix": "string",
                    },
                    "path": {
                        "exact": "string",
                        "regex": "string",
                    },
                    "port": 0,
                    "prefix": "string",
                    "query_parameters": [{
                        "name": "string",
                        "match": {
                            "exact": "string",
                        },
                    }],
                },
            },
            "http_route": {
                "action": {
                    "target": {
                        "virtual_service": {
                            "virtual_service_name": "string",
                        },
                        "port": 0,
                    },
                    "rewrite": {
                        "hostname": {
                            "default_target_hostname": "string",
                        },
                        "path": {
                            "exact": "string",
                        },
                        "prefix": {
                            "default_prefix": "string",
                            "value": "string",
                        },
                    },
                },
                "match": {
                    "headers": [{
                        "name": "string",
                        "invert": False,
                        "match": {
                            "exact": "string",
                            "prefix": "string",
                            "range": {
                                "end": 0,
                                "start": 0,
                            },
                            "regex": "string",
                            "suffix": "string",
                        },
                    }],
                    "hostname": {
                        "exact": "string",
                        "suffix": "string",
                    },
                    "path": {
                        "exact": "string",
                        "regex": "string",
                    },
                    "port": 0,
                    "prefix": "string",
                    "query_parameters": [{
                        "name": "string",
                        "match": {
                            "exact": "string",
                        },
                    }],
                },
            },
            "priority": 0,
        },
        virtual_gateway_name="string",
        mesh_owner="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const gatewayRouteResource = new aws.appmesh.GatewayRoute("gatewayRouteResource", {
        meshName: "string",
        spec: {
            grpcRoute: {
                action: {
                    target: {
                        virtualService: {
                            virtualServiceName: "string",
                        },
                        port: 0,
                    },
                },
                match: {
                    serviceName: "string",
                    port: 0,
                },
            },
            http2Route: {
                action: {
                    target: {
                        virtualService: {
                            virtualServiceName: "string",
                        },
                        port: 0,
                    },
                    rewrite: {
                        hostname: {
                            defaultTargetHostname: "string",
                        },
                        path: {
                            exact: "string",
                        },
                        prefix: {
                            defaultPrefix: "string",
                            value: "string",
                        },
                    },
                },
                match: {
                    headers: [{
                        name: "string",
                        invert: false,
                        match: {
                            exact: "string",
                            prefix: "string",
                            range: {
                                end: 0,
                                start: 0,
                            },
                            regex: "string",
                            suffix: "string",
                        },
                    }],
                    hostname: {
                        exact: "string",
                        suffix: "string",
                    },
                    path: {
                        exact: "string",
                        regex: "string",
                    },
                    port: 0,
                    prefix: "string",
                    queryParameters: [{
                        name: "string",
                        match: {
                            exact: "string",
                        },
                    }],
                },
            },
            httpRoute: {
                action: {
                    target: {
                        virtualService: {
                            virtualServiceName: "string",
                        },
                        port: 0,
                    },
                    rewrite: {
                        hostname: {
                            defaultTargetHostname: "string",
                        },
                        path: {
                            exact: "string",
                        },
                        prefix: {
                            defaultPrefix: "string",
                            value: "string",
                        },
                    },
                },
                match: {
                    headers: [{
                        name: "string",
                        invert: false,
                        match: {
                            exact: "string",
                            prefix: "string",
                            range: {
                                end: 0,
                                start: 0,
                            },
                            regex: "string",
                            suffix: "string",
                        },
                    }],
                    hostname: {
                        exact: "string",
                        suffix: "string",
                    },
                    path: {
                        exact: "string",
                        regex: "string",
                    },
                    port: 0,
                    prefix: "string",
                    queryParameters: [{
                        name: "string",
                        match: {
                            exact: "string",
                        },
                    }],
                },
            },
            priority: 0,
        },
        virtualGatewayName: "string",
        meshOwner: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:appmesh:GatewayRoute
    properties:
        meshName: string
        meshOwner: string
        name: string
        spec:
            grpcRoute:
                action:
                    target:
                        port: 0
                        virtualService:
                            virtualServiceName: string
                match:
                    port: 0
                    serviceName: string
            http2Route:
                action:
                    rewrite:
                        hostname:
                            defaultTargetHostname: string
                        path:
                            exact: string
                        prefix:
                            defaultPrefix: string
                            value: string
                    target:
                        port: 0
                        virtualService:
                            virtualServiceName: string
                match:
                    headers:
                        - invert: false
                          match:
                            exact: string
                            prefix: string
                            range:
                                end: 0
                                start: 0
                            regex: string
                            suffix: string
                          name: string
                    hostname:
                        exact: string
                        suffix: string
                    path:
                        exact: string
                        regex: string
                    port: 0
                    prefix: string
                    queryParameters:
                        - match:
                            exact: string
                          name: string
            httpRoute:
                action:
                    rewrite:
                        hostname:
                            defaultTargetHostname: string
                        path:
                            exact: string
                        prefix:
                            defaultPrefix: string
                            value: string
                    target:
                        port: 0
                        virtualService:
                            virtualServiceName: string
                match:
                    headers:
                        - invert: false
                          match:
                            exact: string
                            prefix: string
                            range:
                                end: 0
                                start: 0
                            regex: string
                            suffix: string
                          name: string
                    hostname:
                        exact: string
                        suffix: string
                    path:
                        exact: string
                        regex: string
                    port: 0
                    prefix: string
                    queryParameters:
                        - match:
                            exact: string
                          name: string
            priority: 0
        tags:
            string: string
        virtualGatewayName: string
    

    GatewayRoute Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GatewayRoute resource accepts the following input properties:

    MeshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    Spec GatewayRouteSpec
    Gateway route specification to apply.
    VirtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    MeshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    Name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    MeshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    Spec GatewayRouteSpecArgs
    Gateway route specification to apply.
    VirtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    MeshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    Name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    meshName String
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    spec GatewayRouteSpec
    Gateway route specification to apply.
    virtualGatewayName String
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    meshOwner String
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name String
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    meshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    spec GatewayRouteSpec
    Gateway route specification to apply.
    virtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    meshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    mesh_name str
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    spec GatewayRouteSpecArgs
    Gateway route specification to apply.
    virtual_gateway_name str
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    mesh_owner str
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name str
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    meshName String
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    spec Property Map
    Gateway route specification to apply.
    virtualGatewayName String
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    meshOwner String
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name String
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the gateway route.
    CreatedDate string
    Creation date of the gateway route.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last update date of the gateway route.
    ResourceOwner string
    Resource owner's AWS account ID.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the gateway route.
    CreatedDate string
    Creation date of the gateway route.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last update date of the gateway route.
    ResourceOwner string
    Resource owner's AWS account ID.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the gateway route.
    createdDate String
    Creation date of the gateway route.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last update date of the gateway route.
    resourceOwner String
    Resource owner's AWS account ID.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the gateway route.
    createdDate string
    Creation date of the gateway route.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate string
    Last update date of the gateway route.
    resourceOwner string
    Resource owner's AWS account ID.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the gateway route.
    created_date str
    Creation date of the gateway route.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_date str
    Last update date of the gateway route.
    resource_owner str
    Resource owner's AWS account ID.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the gateway route.
    createdDate String
    Creation date of the gateway route.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last update date of the gateway route.
    resourceOwner String
    Resource owner's AWS account ID.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing GatewayRoute Resource

    Get an existing GatewayRoute 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?: GatewayRouteState, opts?: CustomResourceOptions): GatewayRoute
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            created_date: Optional[str] = None,
            last_updated_date: Optional[str] = None,
            mesh_name: Optional[str] = None,
            mesh_owner: Optional[str] = None,
            name: Optional[str] = None,
            resource_owner: Optional[str] = None,
            spec: Optional[GatewayRouteSpecArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            virtual_gateway_name: Optional[str] = None) -> GatewayRoute
    func GetGatewayRoute(ctx *Context, name string, id IDInput, state *GatewayRouteState, opts ...ResourceOption) (*GatewayRoute, error)
    public static GatewayRoute Get(string name, Input<string> id, GatewayRouteState? state, CustomResourceOptions? opts = null)
    public static GatewayRoute get(String name, Output<String> id, GatewayRouteState 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:
    Arn string
    ARN of the gateway route.
    CreatedDate string
    Creation date of the gateway route.
    LastUpdatedDate string
    Last update date of the gateway route.
    MeshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    MeshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    Name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    ResourceOwner string
    Resource owner's AWS account ID.
    Spec GatewayRouteSpec
    Gateway route specification to apply.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VirtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    Arn string
    ARN of the gateway route.
    CreatedDate string
    Creation date of the gateway route.
    LastUpdatedDate string
    Last update date of the gateway route.
    MeshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    MeshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    Name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    ResourceOwner string
    Resource owner's AWS account ID.
    Spec GatewayRouteSpecArgs
    Gateway route specification to apply.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VirtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    arn String
    ARN of the gateway route.
    createdDate String
    Creation date of the gateway route.
    lastUpdatedDate String
    Last update date of the gateway route.
    meshName String
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    meshOwner String
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name String
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    resourceOwner String
    Resource owner's AWS account ID.
    spec GatewayRouteSpec
    Gateway route specification to apply.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    virtualGatewayName String
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    arn string
    ARN of the gateway route.
    createdDate string
    Creation date of the gateway route.
    lastUpdatedDate string
    Last update date of the gateway route.
    meshName string
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    meshOwner string
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name string
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    resourceOwner string
    Resource owner's AWS account ID.
    spec GatewayRouteSpec
    Gateway route specification to apply.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    virtualGatewayName string
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    arn str
    ARN of the gateway route.
    created_date str
    Creation date of the gateway route.
    last_updated_date str
    Last update date of the gateway route.
    mesh_name str
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    mesh_owner str
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name str
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    resource_owner str
    Resource owner's AWS account ID.
    spec GatewayRouteSpecArgs
    Gateway route specification to apply.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    virtual_gateway_name str
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
    arn String
    ARN of the gateway route.
    createdDate String
    Creation date of the gateway route.
    lastUpdatedDate String
    Last update date of the gateway route.
    meshName String
    Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
    meshOwner String
    AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
    name String
    Name to use for the gateway route. Must be between 1 and 255 characters in length.
    resourceOwner String
    Resource owner's AWS account ID.
    spec Property Map
    Gateway route specification to apply.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    virtualGatewayName String
    Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.

    Supporting Types

    GatewayRouteSpec, GatewayRouteSpecArgs

    GrpcRoute GatewayRouteSpecGrpcRoute
    Specification of a gRPC gateway route.
    Http2Route GatewayRouteSpecHttp2Route
    Specification of an HTTP/2 gateway route.
    HttpRoute GatewayRouteSpecHttpRoute
    Specification of an HTTP gateway route.
    Priority int
    Priority for the gateway route, between 0 and 1000.
    GrpcRoute GatewayRouteSpecGrpcRoute
    Specification of a gRPC gateway route.
    Http2Route GatewayRouteSpecHttp2Route
    Specification of an HTTP/2 gateway route.
    HttpRoute GatewayRouteSpecHttpRoute
    Specification of an HTTP gateway route.
    Priority int
    Priority for the gateway route, between 0 and 1000.
    grpcRoute GatewayRouteSpecGrpcRoute
    Specification of a gRPC gateway route.
    http2Route GatewayRouteSpecHttp2Route
    Specification of an HTTP/2 gateway route.
    httpRoute GatewayRouteSpecHttpRoute
    Specification of an HTTP gateway route.
    priority Integer
    Priority for the gateway route, between 0 and 1000.
    grpcRoute GatewayRouteSpecGrpcRoute
    Specification of a gRPC gateway route.
    http2Route GatewayRouteSpecHttp2Route
    Specification of an HTTP/2 gateway route.
    httpRoute GatewayRouteSpecHttpRoute
    Specification of an HTTP gateway route.
    priority number
    Priority for the gateway route, between 0 and 1000.
    grpc_route GatewayRouteSpecGrpcRoute
    Specification of a gRPC gateway route.
    http2_route GatewayRouteSpecHttp2Route
    Specification of an HTTP/2 gateway route.
    http_route GatewayRouteSpecHttpRoute
    Specification of an HTTP gateway route.
    priority int
    Priority for the gateway route, between 0 and 1000.
    grpcRoute Property Map
    Specification of a gRPC gateway route.
    http2Route Property Map
    Specification of an HTTP/2 gateway route.
    httpRoute Property Map
    Specification of an HTTP gateway route.
    priority Number
    Priority for the gateway route, between 0 and 1000.

    GatewayRouteSpecGrpcRoute, GatewayRouteSpecGrpcRouteArgs

    Action GatewayRouteSpecGrpcRouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecGrpcRouteMatch
    Criteria for determining a request match.
    Action GatewayRouteSpecGrpcRouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecGrpcRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecGrpcRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecGrpcRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecGrpcRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecGrpcRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecGrpcRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecGrpcRouteMatch
    Criteria for determining a request match.
    action Property Map
    Action to take if a match is determined.
    match Property Map
    Criteria for determining a request match.

    GatewayRouteSpecGrpcRouteAction, GatewayRouteSpecGrpcRouteActionArgs

    Target GatewayRouteSpecGrpcRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    Target GatewayRouteSpecGrpcRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    target GatewayRouteSpecGrpcRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    target GatewayRouteSpecGrpcRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    target GatewayRouteSpecGrpcRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    target Property Map
    Target that traffic is routed to when a request matches the gateway route.

    GatewayRouteSpecGrpcRouteActionTarget, GatewayRouteSpecGrpcRouteActionTargetArgs

    VirtualService GatewayRouteSpecGrpcRouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    VirtualService GatewayRouteSpecGrpcRouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecGrpcRouteActionTargetVirtualService
    Virtual service gateway route target.
    port Integer
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecGrpcRouteActionTargetVirtualService
    Virtual service gateway route target.
    port number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtual_service GatewayRouteSpecGrpcRouteActionTargetVirtualService
    Virtual service gateway route target.
    port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService Property Map
    Virtual service gateway route target.
    port Number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.

    GatewayRouteSpecGrpcRouteActionTargetVirtualService, GatewayRouteSpecGrpcRouteActionTargetVirtualServiceArgs

    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtual_service_name str
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.

    GatewayRouteSpecGrpcRouteMatch, GatewayRouteSpecGrpcRouteMatchArgs

    ServiceName string
    Fully qualified domain name for the service to match from the request.
    Port int
    The port number to match from the request.
    ServiceName string
    Fully qualified domain name for the service to match from the request.
    Port int
    The port number to match from the request.
    serviceName String
    Fully qualified domain name for the service to match from the request.
    port Integer
    The port number to match from the request.
    serviceName string
    Fully qualified domain name for the service to match from the request.
    port number
    The port number to match from the request.
    service_name str
    Fully qualified domain name for the service to match from the request.
    port int
    The port number to match from the request.
    serviceName String
    Fully qualified domain name for the service to match from the request.
    port Number
    The port number to match from the request.

    GatewayRouteSpecHttp2Route, GatewayRouteSpecHttp2RouteArgs

    Action GatewayRouteSpecHttp2RouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecHttp2RouteMatch
    Criteria for determining a request match.
    Action GatewayRouteSpecHttp2RouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecHttp2RouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttp2RouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttp2RouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttp2RouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttp2RouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttp2RouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttp2RouteMatch
    Criteria for determining a request match.
    action Property Map
    Action to take if a match is determined.
    match Property Map
    Criteria for determining a request match.

    GatewayRouteSpecHttp2RouteAction, GatewayRouteSpecHttp2RouteActionArgs

    Target GatewayRouteSpecHttp2RouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    Rewrite GatewayRouteSpecHttp2RouteActionRewrite
    Gateway route action to rewrite.
    Target GatewayRouteSpecHttp2RouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    Rewrite GatewayRouteSpecHttp2RouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttp2RouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttp2RouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttp2RouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttp2RouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttp2RouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttp2RouteActionRewrite
    Gateway route action to rewrite.
    target Property Map
    Target that traffic is routed to when a request matches the gateway route.
    rewrite Property Map
    Gateway route action to rewrite.

    GatewayRouteSpecHttp2RouteActionRewrite, GatewayRouteSpecHttp2RouteActionRewriteArgs

    hostname Property Map
    Host name to rewrite.
    path Property Map
    Exact path to rewrite.
    prefix Property Map
    Specified beginning characters to rewrite.

    GatewayRouteSpecHttp2RouteActionRewriteHostname, GatewayRouteSpecHttp2RouteActionRewriteHostnameArgs

    DefaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    DefaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname String
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    default_target_hostname str
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname String
    Default target host name to write to. Valid values: ENABLED, DISABLED.

    GatewayRouteSpecHttp2RouteActionRewritePath, GatewayRouteSpecHttp2RouteActionRewritePathArgs

    Exact string
    The exact path to match on.
    Exact string
    The exact path to match on.
    exact String
    The exact path to match on.
    exact string
    The exact path to match on.
    exact str
    The exact path to match on.
    exact String
    The exact path to match on.

    GatewayRouteSpecHttp2RouteActionRewritePrefix, GatewayRouteSpecHttp2RouteActionRewritePrefixArgs

    DefaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    Value string
    Value used to replace the incoming route prefix when rewritten.
    DefaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    Value string
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix String
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value String
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value string
    Value used to replace the incoming route prefix when rewritten.
    default_prefix str
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value str
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix String
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value String
    Value used to replace the incoming route prefix when rewritten.

    GatewayRouteSpecHttp2RouteActionTarget, GatewayRouteSpecHttp2RouteActionTargetArgs

    VirtualService GatewayRouteSpecHttp2RouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    VirtualService GatewayRouteSpecHttp2RouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecHttp2RouteActionTargetVirtualService
    Virtual service gateway route target.
    port Integer
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecHttp2RouteActionTargetVirtualService
    Virtual service gateway route target.
    port number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtual_service GatewayRouteSpecHttp2RouteActionTargetVirtualService
    Virtual service gateway route target.
    port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService Property Map
    Virtual service gateway route target.
    port Number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.

    GatewayRouteSpecHttp2RouteActionTargetVirtualService, GatewayRouteSpecHttp2RouteActionTargetVirtualServiceArgs

    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtual_service_name str
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.

    GatewayRouteSpecHttp2RouteMatch, GatewayRouteSpecHttp2RouteMatchArgs

    Headers List<GatewayRouteSpecHttp2RouteMatchHeader>
    Client request headers to match on.
    Hostname GatewayRouteSpecHttp2RouteMatchHostname
    Host name to match on.
    Path GatewayRouteSpecHttp2RouteMatchPath
    Client request path to match on.
    Port int
    The port number to match from the request.
    Prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    QueryParameters List<GatewayRouteSpecHttp2RouteMatchQueryParameter>
    Client request query parameters to match on.
    Headers []GatewayRouteSpecHttp2RouteMatchHeader
    Client request headers to match on.
    Hostname GatewayRouteSpecHttp2RouteMatchHostname
    Host name to match on.
    Path GatewayRouteSpecHttp2RouteMatchPath
    Client request path to match on.
    Port int
    The port number to match from the request.
    Prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    QueryParameters []GatewayRouteSpecHttp2RouteMatchQueryParameter
    Client request query parameters to match on.
    headers List<GatewayRouteSpecHttp2RouteMatchHeader>
    Client request headers to match on.
    hostname GatewayRouteSpecHttp2RouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttp2RouteMatchPath
    Client request path to match on.
    port Integer
    The port number to match from the request.
    prefix String
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters List<GatewayRouteSpecHttp2RouteMatchQueryParameter>
    Client request query parameters to match on.
    headers GatewayRouteSpecHttp2RouteMatchHeader[]
    Client request headers to match on.
    hostname GatewayRouteSpecHttp2RouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttp2RouteMatchPath
    Client request path to match on.
    port number
    The port number to match from the request.
    prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters GatewayRouteSpecHttp2RouteMatchQueryParameter[]
    Client request query parameters to match on.
    headers Sequence[GatewayRouteSpecHttp2RouteMatchHeader]
    Client request headers to match on.
    hostname GatewayRouteSpecHttp2RouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttp2RouteMatchPath
    Client request path to match on.
    port int
    The port number to match from the request.
    prefix str
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    query_parameters Sequence[GatewayRouteSpecHttp2RouteMatchQueryParameter]
    Client request query parameters to match on.
    headers List<Property Map>
    Client request headers to match on.
    hostname Property Map
    Host name to match on.
    path Property Map
    Client request path to match on.
    port Number
    The port number to match from the request.
    prefix String
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters List<Property Map>
    Client request query parameters to match on.

    GatewayRouteSpecHttp2RouteMatchHeader, GatewayRouteSpecHttp2RouteMatchHeaderArgs

    Name string
    Name for the HTTP header in the client request that will be matched on.
    Invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    Match GatewayRouteSpecHttp2RouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    Name string
    Name for the HTTP header in the client request that will be matched on.
    Invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    Match GatewayRouteSpecHttp2RouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name String
    Name for the HTTP header in the client request that will be matched on.
    invert Boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttp2RouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name string
    Name for the HTTP header in the client request that will be matched on.
    invert boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttp2RouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name str
    Name for the HTTP header in the client request that will be matched on.
    invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttp2RouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name String
    Name for the HTTP header in the client request that will be matched on.
    invert Boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match Property Map
    Method and value to match the header value sent with a request. Specify one match method.

    GatewayRouteSpecHttp2RouteMatchHeaderMatch, GatewayRouteSpecHttp2RouteMatchHeaderMatchArgs

    Exact string
    Header value sent by the client must match the specified value exactly.
    Prefix string
    Header value sent by the client must begin with the specified characters.
    Range GatewayRouteSpecHttp2RouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    Regex string
    Header value sent by the client must include the specified characters.
    Suffix string
    Header value sent by the client must end with the specified characters.
    Exact string
    Header value sent by the client must match the specified value exactly.
    Prefix string
    Header value sent by the client must begin with the specified characters.
    Range GatewayRouteSpecHttp2RouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    Regex string
    Header value sent by the client must include the specified characters.
    Suffix string
    Header value sent by the client must end with the specified characters.
    exact String
    Header value sent by the client must match the specified value exactly.
    prefix String
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttp2RouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex String
    Header value sent by the client must include the specified characters.
    suffix String
    Header value sent by the client must end with the specified characters.
    exact string
    Header value sent by the client must match the specified value exactly.
    prefix string
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttp2RouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex string
    Header value sent by the client must include the specified characters.
    suffix string
    Header value sent by the client must end with the specified characters.
    exact str
    Header value sent by the client must match the specified value exactly.
    prefix str
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttp2RouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex str
    Header value sent by the client must include the specified characters.
    suffix str
    Header value sent by the client must end with the specified characters.
    exact String
    Header value sent by the client must match the specified value exactly.
    prefix String
    Header value sent by the client must begin with the specified characters.
    range Property Map
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex String
    Header value sent by the client must include the specified characters.
    suffix String
    Header value sent by the client must end with the specified characters.

    GatewayRouteSpecHttp2RouteMatchHeaderMatchRange, GatewayRouteSpecHttp2RouteMatchHeaderMatchRangeArgs

    End int
    End of the range.
    Start int
    Start of the range.
    End int
    End of the range.
    Start int
    Start of the range.
    end Integer
    End of the range.
    start Integer
    Start of the range.
    end number
    End of the range.
    start number
    Start of the range.
    end int
    End of the range.
    start int
    Start of the range.
    end Number
    End of the range.
    start Number
    Start of the range.

    GatewayRouteSpecHttp2RouteMatchHostname, GatewayRouteSpecHttp2RouteMatchHostnameArgs

    Exact string
    Exact host name to match on.
    Suffix string
    Specified ending characters of the host name to match on.
    Exact string
    Exact host name to match on.
    Suffix string
    Specified ending characters of the host name to match on.
    exact String
    Exact host name to match on.
    suffix String
    Specified ending characters of the host name to match on.
    exact string
    Exact host name to match on.
    suffix string
    Specified ending characters of the host name to match on.
    exact str
    Exact host name to match on.
    suffix str
    Specified ending characters of the host name to match on.
    exact String
    Exact host name to match on.
    suffix String
    Specified ending characters of the host name to match on.

    GatewayRouteSpecHttp2RouteMatchPath, GatewayRouteSpecHttp2RouteMatchPathArgs

    Exact string
    The exact path to match on.
    Regex string
    The regex used to match the path.
    Exact string
    The exact path to match on.
    Regex string
    The regex used to match the path.
    exact String
    The exact path to match on.
    regex String
    The regex used to match the path.
    exact string
    The exact path to match on.
    regex string
    The regex used to match the path.
    exact str
    The exact path to match on.
    regex str
    The regex used to match the path.
    exact String
    The exact path to match on.
    regex String
    The regex used to match the path.

    GatewayRouteSpecHttp2RouteMatchQueryParameter, GatewayRouteSpecHttp2RouteMatchQueryParameterArgs

    Name string
    Name for the query parameter that will be matched on.
    Match GatewayRouteSpecHttp2RouteMatchQueryParameterMatch
    The query parameter to match on.
    Name string
    Name for the query parameter that will be matched on.
    Match GatewayRouteSpecHttp2RouteMatchQueryParameterMatch
    The query parameter to match on.
    name String
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttp2RouteMatchQueryParameterMatch
    The query parameter to match on.
    name string
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttp2RouteMatchQueryParameterMatch
    The query parameter to match on.
    name str
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttp2RouteMatchQueryParameterMatch
    The query parameter to match on.
    name String
    Name for the query parameter that will be matched on.
    match Property Map
    The query parameter to match on.

    GatewayRouteSpecHttp2RouteMatchQueryParameterMatch, GatewayRouteSpecHttp2RouteMatchQueryParameterMatchArgs

    Exact string
    The exact query parameter to match on.
    Exact string
    The exact query parameter to match on.
    exact String
    The exact query parameter to match on.
    exact string
    The exact query parameter to match on.
    exact str
    The exact query parameter to match on.
    exact String
    The exact query parameter to match on.

    GatewayRouteSpecHttpRoute, GatewayRouteSpecHttpRouteArgs

    Action GatewayRouteSpecHttpRouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecHttpRouteMatch
    Criteria for determining a request match.
    Action GatewayRouteSpecHttpRouteAction
    Action to take if a match is determined.
    Match GatewayRouteSpecHttpRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttpRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttpRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttpRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttpRouteMatch
    Criteria for determining a request match.
    action GatewayRouteSpecHttpRouteAction
    Action to take if a match is determined.
    match GatewayRouteSpecHttpRouteMatch
    Criteria for determining a request match.
    action Property Map
    Action to take if a match is determined.
    match Property Map
    Criteria for determining a request match.

    GatewayRouteSpecHttpRouteAction, GatewayRouteSpecHttpRouteActionArgs

    Target GatewayRouteSpecHttpRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    Rewrite GatewayRouteSpecHttpRouteActionRewrite
    Gateway route action to rewrite.
    Target GatewayRouteSpecHttpRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    Rewrite GatewayRouteSpecHttpRouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttpRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttpRouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttpRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttpRouteActionRewrite
    Gateway route action to rewrite.
    target GatewayRouteSpecHttpRouteActionTarget
    Target that traffic is routed to when a request matches the gateway route.
    rewrite GatewayRouteSpecHttpRouteActionRewrite
    Gateway route action to rewrite.
    target Property Map
    Target that traffic is routed to when a request matches the gateway route.
    rewrite Property Map
    Gateway route action to rewrite.

    GatewayRouteSpecHttpRouteActionRewrite, GatewayRouteSpecHttpRouteActionRewriteArgs

    hostname Property Map
    Host name to rewrite.
    path Property Map
    Exact path to rewrite.
    prefix Property Map
    Specified beginning characters to rewrite.

    GatewayRouteSpecHttpRouteActionRewriteHostname, GatewayRouteSpecHttpRouteActionRewriteHostnameArgs

    DefaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    DefaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname String
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname string
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    default_target_hostname str
    Default target host name to write to. Valid values: ENABLED, DISABLED.
    defaultTargetHostname String
    Default target host name to write to. Valid values: ENABLED, DISABLED.

    GatewayRouteSpecHttpRouteActionRewritePath, GatewayRouteSpecHttpRouteActionRewritePathArgs

    Exact string
    The exact path to match on.
    Exact string
    The exact path to match on.
    exact String
    The exact path to match on.
    exact string
    The exact path to match on.
    exact str
    The exact path to match on.
    exact String
    The exact path to match on.

    GatewayRouteSpecHttpRouteActionRewritePrefix, GatewayRouteSpecHttpRouteActionRewritePrefixArgs

    DefaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    Value string
    Value used to replace the incoming route prefix when rewritten.
    DefaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    Value string
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix String
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value String
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix string
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value string
    Value used to replace the incoming route prefix when rewritten.
    default_prefix str
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value str
    Value used to replace the incoming route prefix when rewritten.
    defaultPrefix String
    Default prefix used to replace the incoming route prefix when rewritten. Valid values: ENABLED, DISABLED.
    value String
    Value used to replace the incoming route prefix when rewritten.

    GatewayRouteSpecHttpRouteActionTarget, GatewayRouteSpecHttpRouteActionTargetArgs

    VirtualService GatewayRouteSpecHttpRouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    VirtualService GatewayRouteSpecHttpRouteActionTargetVirtualService
    Virtual service gateway route target.
    Port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecHttpRouteActionTargetVirtualService
    Virtual service gateway route target.
    port Integer
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService GatewayRouteSpecHttpRouteActionTargetVirtualService
    Virtual service gateway route target.
    port number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtual_service GatewayRouteSpecHttpRouteActionTargetVirtualService
    Virtual service gateway route target.
    port int
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.
    virtualService Property Map
    Virtual service gateway route target.
    port Number
    The port number that corresponds to the target for Virtual Service provider port. This is required when the provider (router or node) of the Virtual Service has multiple listeners.

    GatewayRouteSpecHttpRouteActionTargetVirtualService, GatewayRouteSpecHttpRouteActionTargetVirtualServiceArgs

    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    VirtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName string
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtual_service_name str
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.
    virtualServiceName String
    Name of the virtual service that traffic is routed to. Must be between 1 and 255 characters in length.

    GatewayRouteSpecHttpRouteMatch, GatewayRouteSpecHttpRouteMatchArgs

    Headers List<GatewayRouteSpecHttpRouteMatchHeader>
    Client request headers to match on.
    Hostname GatewayRouteSpecHttpRouteMatchHostname
    Host name to match on.
    Path GatewayRouteSpecHttpRouteMatchPath
    Client request path to match on.
    Port int
    The port number to match from the request.
    Prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    QueryParameters List<GatewayRouteSpecHttpRouteMatchQueryParameter>
    Client request query parameters to match on.
    Headers []GatewayRouteSpecHttpRouteMatchHeader
    Client request headers to match on.
    Hostname GatewayRouteSpecHttpRouteMatchHostname
    Host name to match on.
    Path GatewayRouteSpecHttpRouteMatchPath
    Client request path to match on.
    Port int
    The port number to match from the request.
    Prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    QueryParameters []GatewayRouteSpecHttpRouteMatchQueryParameter
    Client request query parameters to match on.
    headers List<GatewayRouteSpecHttpRouteMatchHeader>
    Client request headers to match on.
    hostname GatewayRouteSpecHttpRouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttpRouteMatchPath
    Client request path to match on.
    port Integer
    The port number to match from the request.
    prefix String
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters List<GatewayRouteSpecHttpRouteMatchQueryParameter>
    Client request query parameters to match on.
    headers GatewayRouteSpecHttpRouteMatchHeader[]
    Client request headers to match on.
    hostname GatewayRouteSpecHttpRouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttpRouteMatchPath
    Client request path to match on.
    port number
    The port number to match from the request.
    prefix string
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters GatewayRouteSpecHttpRouteMatchQueryParameter[]
    Client request query parameters to match on.
    headers Sequence[GatewayRouteSpecHttpRouteMatchHeader]
    Client request headers to match on.
    hostname GatewayRouteSpecHttpRouteMatchHostname
    Host name to match on.
    path GatewayRouteSpecHttpRouteMatchPath
    Client request path to match on.
    port int
    The port number to match from the request.
    prefix str
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    query_parameters Sequence[GatewayRouteSpecHttpRouteMatchQueryParameter]
    Client request query parameters to match on.
    headers List<Property Map>
    Client request headers to match on.
    hostname Property Map
    Host name to match on.
    path Property Map
    Client request path to match on.
    port Number
    The port number to match from the request.
    prefix String
    Path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name.
    queryParameters List<Property Map>
    Client request query parameters to match on.

    GatewayRouteSpecHttpRouteMatchHeader, GatewayRouteSpecHttpRouteMatchHeaderArgs

    Name string
    Name for the HTTP header in the client request that will be matched on.
    Invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    Match GatewayRouteSpecHttpRouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    Name string
    Name for the HTTP header in the client request that will be matched on.
    Invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    Match GatewayRouteSpecHttpRouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name String
    Name for the HTTP header in the client request that will be matched on.
    invert Boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttpRouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name string
    Name for the HTTP header in the client request that will be matched on.
    invert boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttpRouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name str
    Name for the HTTP header in the client request that will be matched on.
    invert bool
    If true, the match is on the opposite of the match method and value. Default is false.
    match GatewayRouteSpecHttpRouteMatchHeaderMatch
    Method and value to match the header value sent with a request. Specify one match method.
    name String
    Name for the HTTP header in the client request that will be matched on.
    invert Boolean
    If true, the match is on the opposite of the match method and value. Default is false.
    match Property Map
    Method and value to match the header value sent with a request. Specify one match method.

    GatewayRouteSpecHttpRouteMatchHeaderMatch, GatewayRouteSpecHttpRouteMatchHeaderMatchArgs

    Exact string
    Header value sent by the client must match the specified value exactly.
    Prefix string
    Header value sent by the client must begin with the specified characters.
    Range GatewayRouteSpecHttpRouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    Regex string
    Header value sent by the client must include the specified characters.
    Suffix string
    Header value sent by the client must end with the specified characters.
    Exact string
    Header value sent by the client must match the specified value exactly.
    Prefix string
    Header value sent by the client must begin with the specified characters.
    Range GatewayRouteSpecHttpRouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    Regex string
    Header value sent by the client must include the specified characters.
    Suffix string
    Header value sent by the client must end with the specified characters.
    exact String
    Header value sent by the client must match the specified value exactly.
    prefix String
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttpRouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex String
    Header value sent by the client must include the specified characters.
    suffix String
    Header value sent by the client must end with the specified characters.
    exact string
    Header value sent by the client must match the specified value exactly.
    prefix string
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttpRouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex string
    Header value sent by the client must include the specified characters.
    suffix string
    Header value sent by the client must end with the specified characters.
    exact str
    Header value sent by the client must match the specified value exactly.
    prefix str
    Header value sent by the client must begin with the specified characters.
    range GatewayRouteSpecHttpRouteMatchHeaderMatchRange
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex str
    Header value sent by the client must include the specified characters.
    suffix str
    Header value sent by the client must end with the specified characters.
    exact String
    Header value sent by the client must match the specified value exactly.
    prefix String
    Header value sent by the client must begin with the specified characters.
    range Property Map
    Object that specifies the range of numbers that the header value sent by the client must be included in.
    regex String
    Header value sent by the client must include the specified characters.
    suffix String
    Header value sent by the client must end with the specified characters.

    GatewayRouteSpecHttpRouteMatchHeaderMatchRange, GatewayRouteSpecHttpRouteMatchHeaderMatchRangeArgs

    End int
    End of the range.
    Start int
    Start of the range.
    End int
    End of the range.
    Start int
    Start of the range.
    end Integer
    End of the range.
    start Integer
    Start of the range.
    end number
    End of the range.
    start number
    Start of the range.
    end int
    End of the range.
    start int
    Start of the range.
    end Number
    End of the range.
    start Number
    Start of the range.

    GatewayRouteSpecHttpRouteMatchHostname, GatewayRouteSpecHttpRouteMatchHostnameArgs

    Exact string
    Exact host name to match on.
    Suffix string
    Specified ending characters of the host name to match on.
    Exact string
    Exact host name to match on.
    Suffix string
    Specified ending characters of the host name to match on.
    exact String
    Exact host name to match on.
    suffix String
    Specified ending characters of the host name to match on.
    exact string
    Exact host name to match on.
    suffix string
    Specified ending characters of the host name to match on.
    exact str
    Exact host name to match on.
    suffix str
    Specified ending characters of the host name to match on.
    exact String
    Exact host name to match on.
    suffix String
    Specified ending characters of the host name to match on.

    GatewayRouteSpecHttpRouteMatchPath, GatewayRouteSpecHttpRouteMatchPathArgs

    Exact string
    The exact path to match on.
    Regex string
    The regex used to match the path.
    Exact string
    The exact path to match on.
    Regex string
    The regex used to match the path.
    exact String
    The exact path to match on.
    regex String
    The regex used to match the path.
    exact string
    The exact path to match on.
    regex string
    The regex used to match the path.
    exact str
    The exact path to match on.
    regex str
    The regex used to match the path.
    exact String
    The exact path to match on.
    regex String
    The regex used to match the path.

    GatewayRouteSpecHttpRouteMatchQueryParameter, GatewayRouteSpecHttpRouteMatchQueryParameterArgs

    Name string
    Name for the query parameter that will be matched on.
    Match GatewayRouteSpecHttpRouteMatchQueryParameterMatch
    The query parameter to match on.
    Name string
    Name for the query parameter that will be matched on.
    Match GatewayRouteSpecHttpRouteMatchQueryParameterMatch
    The query parameter to match on.
    name String
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttpRouteMatchQueryParameterMatch
    The query parameter to match on.
    name string
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttpRouteMatchQueryParameterMatch
    The query parameter to match on.
    name str
    Name for the query parameter that will be matched on.
    match GatewayRouteSpecHttpRouteMatchQueryParameterMatch
    The query parameter to match on.
    name String
    Name for the query parameter that will be matched on.
    match Property Map
    The query parameter to match on.

    GatewayRouteSpecHttpRouteMatchQueryParameterMatch, GatewayRouteSpecHttpRouteMatchQueryParameterMatchArgs

    Exact string
    The exact query parameter to match on.
    Exact string
    The exact query parameter to match on.
    exact String
    The exact query parameter to match on.
    exact string
    The exact query parameter to match on.
    exact str
    The exact query parameter to match on.
    exact String
    The exact query parameter to match on.

    Import

    Using pulumi import, import App Mesh gateway routes using mesh_name and virtual_gateway_name together with the gateway route’s name. For example:

    $ pulumi import aws:appmesh/gatewayRoute:GatewayRoute example mesh/gw1/example-gateway-route
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi