GatewayRoute class

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", {
    spec: {
        httpRoute: {
            action: {
                target: {
                    virtualService: {
                        virtualServiceName: exampleAwsAppmeshVirtualService.name,
                    },
                },
            },
            match: {
                prefix: "/",
            },
        },
    },
    name: "example-gateway-route",
    meshName: "example-service-mesh",
    virtualGatewayName: exampleAwsAppmeshVirtualGateway.name,
    tags: {
        Environment: "test",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.appmesh.GatewayRoute("example",
    spec={
        "http_route": {
            "action": {
                "target": {
                    "virtual_service": {
                        "virtual_service_name": example_aws_appmesh_virtual_service["name"],
                    },
                },
            },
            "match": {
                "prefix": "/",
            },
        },
    },
    name="example-gateway-route",
    mesh_name="example-service-mesh",
    virtual_gateway_name=example_aws_appmesh_virtual_gateway["name"],
    tags={
        "Environment": "test",
    })
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()
    {
        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 = "/",
                },
            },
        },
        Name = "example-gateway-route",
        MeshName = "example-service-mesh",
        VirtualGatewayName = exampleAwsAppmeshVirtualGateway.Name,
        Tags =
        {
            { "Environment", "test" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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("/"),
					},
				},
			},
			Name:               pulumi.String("example-gateway-route"),
			MeshName:           pulumi.String("example-service-mesh"),
			VirtualGatewayName: pulumi.Any(exampleAwsAppmeshVirtualGateway.Name),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appmesh_gatewayroute" "example" {
  spec = {
    http_route = {
      action = {
        target = {
          virtual_service = {
            virtual_service_name = exampleAwsAppmeshVirtualService.name
          }
        }
      }
      match = {
        prefix = "/"
      }
    }
  }
  name                 = "example-gateway-route"
  mesh_name            = "example-service-mesh"
  virtual_gateway_name = exampleAwsAppmeshVirtualGateway.name
  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.ArrayList;
import java.util.Arrays;
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()
            .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())
            .name("example-gateway-route")
            .meshName("example-service-mesh")
            .virtualGatewayName(exampleAwsAppmeshVirtualGateway.name())
            .tags(Map.of("Environment", "test"))
            .build());

    }
}
resources:
  example:
    type: aws:appmesh:GatewayRoute
    properties:
      spec:
        httpRoute:
          action:
            target:
              virtualService:
                virtualServiceName: ${exampleAwsAppmeshVirtualService.name}
          match:
            prefix: /
      name: example-gateway-route
      meshName: example-service-mesh
      virtualGatewayName: ${exampleAwsAppmeshVirtualGateway.name}
      tags:
        Environment: test

Import

Using pulumi import, import App Mesh gateway routes using meshName and virtualGatewayName together with the gateway route's name. For example:

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

Constructors

GatewayRoute(String name, {GatewayRouteArgs? args, CustomResourceOptions? options})
Creates a new GatewayRoute. name The Pulumi resource name. args Arguments used to configure this GatewayRoute. The set of arguments for GatewayRoute. options Resource options controlling this resource's behavior.
GatewayRoute.reference(String urn)
Creates a typed reference to an existing GatewayRoute resource.

Properties

arn ↔ Output<String>
ARN of the gateway route.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdDate ↔ Output<String>
Creation date of the gateway route.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastUpdatedDate ↔ Output<String>
Last update date of the gateway route.
latefinal
meshName ↔ Output<String>
Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length.
latefinal
meshOwner ↔ Output<String>
AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
latefinal
name ↔ Output<String>
Name to use for the gateway route. Must be between 1 and 255 characters in length.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceOwner ↔ Output<String>
Resource owner's AWS account ID.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spec ↔ Output<GatewayRouteSpec>
Gateway route specification to apply.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
virtualGatewayName ↔ Output<String>
Name of the virtual gateway to associate the gateway route with. Must be between 1 and 255 characters in length.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {GatewayRouteState? state, CustomResourceOptions? options}) → GatewayRoute
Gets an existing GatewayRoute resource's state with the given name and id.