VirtualRouter class

Provides an AWS App Mesh virtual router resource.

> Note: Because of backward incompatible API changes (see issue, and here), resource definitions created with provider versions earlier than v2.3.0 must be modified: remove serviceNames from the spec argument (AWS created aws.appmesh.VirtualService resources for each — import them with pulumi import); add a listener configuration block to the spec argument. Existing Pulumi state is automatically migrated.

Example Usage

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

const serviceb = new aws.appmesh.VirtualRouter("serviceb", {
    spec: {
        listeners: [{
            portMapping: {
                port: 8080,
                protocol: "http",
            },
        }],
    },
    name: "serviceB",
    meshName: simple.id,
});
import pulumi
import pulumi_aws as aws

serviceb = aws.appmesh.VirtualRouter("serviceb",
    spec={
        "listeners": [{
            "port_mapping": {
                "port": 8080,
                "protocol": "http",
            },
        }],
    },
    name="serviceB",
    mesh_name=simple["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var serviceb = new Aws.AppMesh.VirtualRouter("serviceb", new()
    {
        Spec = new Aws.AppMesh.Inputs.VirtualRouterSpecArgs
        {
            Listeners = new[]
            {
                new Aws.AppMesh.Inputs.VirtualRouterSpecListenerArgs
                {
                    PortMapping = new Aws.AppMesh.Inputs.VirtualRouterSpecListenerPortMappingArgs
                    {
                        Port = 8080,
                        Protocol = "http",
                    },
                },
            },
        },
        Name = "serviceB",
        MeshName = simple.Id,
    });

});
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.NewVirtualRouter(ctx, "serviceb", &appmesh.VirtualRouterArgs{
			Spec: &appmesh.VirtualRouterSpecArgs{
				Listeners: appmesh.VirtualRouterSpecListenerArray{
					&appmesh.VirtualRouterSpecListenerArgs{
						PortMapping: &appmesh.VirtualRouterSpecListenerPortMappingArgs{
							Port:     pulumi.Int(8080),
							Protocol: pulumi.String("http"),
						},
					},
				},
			},
			Name:     pulumi.String("serviceB"),
			MeshName: pulumi.Any(simple.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appmesh_virtualrouter" "serviceb" {
  spec = {
    listeners = [{
      "portMapping" = {
        "port"     = 8080
        "protocol" = "http"
      }
    }]
  }
  name      = "serviceB"
  mesh_name = simple.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appmesh.VirtualRouter;
import com.pulumi.aws.appmesh.VirtualRouterArgs;
import com.pulumi.aws.appmesh.inputs.VirtualRouterSpecArgs;
import com.pulumi.aws.appmesh.inputs.VirtualRouterSpecListenerArgs;
import com.pulumi.aws.appmesh.inputs.VirtualRouterSpecListenerPortMappingArgs;
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 serviceb = new VirtualRouter("serviceb", VirtualRouterArgs.builder()
            .spec(VirtualRouterSpecArgs.builder()
                .listeners(VirtualRouterSpecListenerArgs.builder()
                    .portMapping(VirtualRouterSpecListenerPortMappingArgs.builder()
                        .port(8080)
                        .protocol("http")
                        .build())
                    .build())
                .build())
            .name("serviceB")
            .meshName(simple.id())
            .build());

    }
}
resources:
  serviceb:
    type: aws:appmesh:VirtualRouter
    properties:
      spec:
        listeners:
          - portMapping:
              port: 8080
              protocol: http
      name: serviceB
      meshName: ${simple.id}

Import

Using pulumi import, import App Mesh virtual routers using meshName together with the virtual router's name. For example:

$ pulumi import aws:appmesh/virtualRouter:VirtualRouter serviceb simpleapp/serviceB

Constructors

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

Properties

arn ↔ Output<String>
ARN of the virtual router.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdDate ↔ Output<String>
Creation date of the virtual router.
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 virtual router.
latefinal
meshName ↔ Output<String>
Name of the service mesh in which to create the virtual router. 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 virtual router. 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<VirtualRouterSpec>
Virtual router specification to apply. See spec Block for details.
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

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, {VirtualRouterState? state, CustomResourceOptions? options}) → VirtualRouter
Gets an existing VirtualRouter resource's state with the given name and id.