pulumi-aws-kotlin/com.pulumi.aws.appmesh.kotlin/VirtualGateway

VirtualGateway

class VirtualGateway : KotlinCustomResource

Provides an AWS App Mesh virtual gateway resource.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.appmesh.VirtualGateway("example", {
    name: "example-virtual-gateway",
    meshName: "example-service-mesh",
    spec: {
        listeners: [{
            portMapping: {
                port: 8080,
                protocol: "http",
            },
        }],
    },
    tags: {
        Environment: "test",
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.appmesh.VirtualGateway("example",
    name="example-virtual-gateway",
    mesh_name="example-service-mesh",
    spec=aws.appmesh.VirtualGatewaySpecArgs(
        listeners=[aws.appmesh.VirtualGatewaySpecListenerArgs(
            port_mapping=aws.appmesh.VirtualGatewaySpecListenerPortMappingArgs(
                port=8080,
                protocol="http",
            ),
        )],
    ),
    tags={
        "Environment": "test",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.AppMesh.VirtualGateway("example", new()
    {
        Name = "example-virtual-gateway",
        MeshName = "example-service-mesh",
        Spec = new Aws.AppMesh.Inputs.VirtualGatewaySpecArgs
        {
            Listeners = new[]
            {
                new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerArgs
                {
                    PortMapping = new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerPortMappingArgs
                    {
                        Port = 8080,
                        Protocol = "http",
                    },
                },
            },
        },
        Tags =
        {
            { "Environment", "test" },
        },
    });
});
Content copied to clipboard
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.NewVirtualGateway(ctx, "example", &appmesh.VirtualGatewayArgs{
			Name:     pulumi.String("example-virtual-gateway"),
			MeshName: pulumi.String("example-service-mesh"),
			Spec: &appmesh.VirtualGatewaySpecArgs{
				Listeners: appmesh.VirtualGatewaySpecListenerArray{
					&appmesh.VirtualGatewaySpecListenerArgs{
						PortMapping: &appmesh.VirtualGatewaySpecListenerPortMappingArgs{
							Port:     pulumi.Int(8080),
							Protocol: pulumi.String("http"),
						},
					},
				},
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appmesh.VirtualGateway;
import com.pulumi.aws.appmesh.VirtualGatewayArgs;
import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecArgs;
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 VirtualGateway("example", VirtualGatewayArgs.builder()
            .name("example-virtual-gateway")
            .meshName("example-service-mesh")
            .spec(VirtualGatewaySpecArgs.builder()
                .listeners(VirtualGatewaySpecListenerArgs.builder()
                    .portMapping(VirtualGatewaySpecListenerPortMappingArgs.builder()
                        .port(8080)
                        .protocol("http")
                        .build())
                    .build())
                .build())
            .tags(Map.of("Environment", "test"))
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:appmesh:VirtualGateway
    properties:
      name: example-virtual-gateway
      meshName: example-service-mesh
      spec:
        listeners:
          - portMapping:
              port: 8080
              protocol: http
      tags:
        Environment: test
Content copied to clipboard

Access Logs and TLS

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.appmesh.VirtualGateway("example", {
    name: "example-virtual-gateway",
    meshName: "example-service-mesh",
    spec: {
        listeners: [{
            portMapping: {
                port: 8080,
                protocol: "http",
            },
            tls: {
                certificate: {
                    acm: {
                        certificateArn: exampleAwsAcmCertificate.arn,
                    },
                },
                mode: "STRICT",
            },
        }],
        logging: {
            accessLog: {
                file: {
                    path: "/var/log/access.log",
                },
            },
        },
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.appmesh.VirtualGateway("example",
    name="example-virtual-gateway",
    mesh_name="example-service-mesh",
    spec=aws.appmesh.VirtualGatewaySpecArgs(
        listeners=[aws.appmesh.VirtualGatewaySpecListenerArgs(
            port_mapping=aws.appmesh.VirtualGatewaySpecListenerPortMappingArgs(
                port=8080,
                protocol="http",
            ),
            tls=aws.appmesh.VirtualGatewaySpecListenerTlsArgs(
                certificate=aws.appmesh.VirtualGatewaySpecListenerTlsCertificateArgs(
                    acm=aws.appmesh.VirtualGatewaySpecListenerTlsCertificateAcmArgs(
                        certificate_arn=example_aws_acm_certificate["arn"],
                    ),
                ),
                mode="STRICT",
            ),
        )],
        logging=aws.appmesh.VirtualGatewaySpecLoggingArgs(
            access_log=aws.appmesh.VirtualGatewaySpecLoggingAccessLogArgs(
                file=aws.appmesh.VirtualGatewaySpecLoggingAccessLogFileArgs(
                    path="/var/log/access.log",
                ),
            ),
        ),
    ))
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.AppMesh.VirtualGateway("example", new()
    {
        Name = "example-virtual-gateway",
        MeshName = "example-service-mesh",
        Spec = new Aws.AppMesh.Inputs.VirtualGatewaySpecArgs
        {
            Listeners = new[]
            {
                new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerArgs
                {
                    PortMapping = new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerPortMappingArgs
                    {
                        Port = 8080,
                        Protocol = "http",
                    },
                    Tls = new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerTlsArgs
                    {
                        Certificate = new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerTlsCertificateArgs
                        {
                            Acm = new Aws.AppMesh.Inputs.VirtualGatewaySpecListenerTlsCertificateAcmArgs
                            {
                                CertificateArn = exampleAwsAcmCertificate.Arn,
                            },
                        },
                        Mode = "STRICT",
                    },
                },
            },
            Logging = new Aws.AppMesh.Inputs.VirtualGatewaySpecLoggingArgs
            {
                AccessLog = new Aws.AppMesh.Inputs.VirtualGatewaySpecLoggingAccessLogArgs
                {
                    File = new Aws.AppMesh.Inputs.VirtualGatewaySpecLoggingAccessLogFileArgs
                    {
                        Path = "/var/log/access.log",
                    },
                },
            },
        },
    });
});
Content copied to clipboard
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.NewVirtualGateway(ctx, "example", &appmesh.VirtualGatewayArgs{
			Name:     pulumi.String("example-virtual-gateway"),
			MeshName: pulumi.String("example-service-mesh"),
			Spec: &appmesh.VirtualGatewaySpecArgs{
				Listeners: appmesh.VirtualGatewaySpecListenerArray{
					&appmesh.VirtualGatewaySpecListenerArgs{
						PortMapping: &appmesh.VirtualGatewaySpecListenerPortMappingArgs{
							Port:     pulumi.Int(8080),
							Protocol: pulumi.String("http"),
						},
						Tls: &appmesh.VirtualGatewaySpecListenerTlsArgs{
							Certificate: &appmesh.VirtualGatewaySpecListenerTlsCertificateArgs{
								Acm: &appmesh.VirtualGatewaySpecListenerTlsCertificateAcmArgs{
									CertificateArn: pulumi.Any(exampleAwsAcmCertificate.Arn),
								},
							},
							Mode: pulumi.String("STRICT"),
						},
					},
				},
				Logging: &appmesh.VirtualGatewaySpecLoggingArgs{
					AccessLog: &appmesh.VirtualGatewaySpecLoggingAccessLogArgs{
						File: &appmesh.VirtualGatewaySpecLoggingAccessLogFileArgs{
							Path: pulumi.String("/var/log/access.log"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appmesh.VirtualGateway;
import com.pulumi.aws.appmesh.VirtualGatewayArgs;
import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecArgs;
import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecLoggingArgs;
import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecLoggingAccessLogArgs;
import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecLoggingAccessLogFileArgs;
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 VirtualGateway("example", VirtualGatewayArgs.builder()
            .name("example-virtual-gateway")
            .meshName("example-service-mesh")
            .spec(VirtualGatewaySpecArgs.builder()
                .listeners(VirtualGatewaySpecListenerArgs.builder()
                    .portMapping(VirtualGatewaySpecListenerPortMappingArgs.builder()
                        .port(8080)
                        .protocol("http")
                        .build())
                    .tls(VirtualGatewaySpecListenerTlsArgs.builder()
                        .certificate(VirtualGatewaySpecListenerTlsCertificateArgs.builder()
                            .acm(VirtualGatewaySpecListenerTlsCertificateAcmArgs.builder()
                                .certificateArn(exampleAwsAcmCertificate.arn())
                                .build())
                            .build())
                        .mode("STRICT")
                        .build())
                    .build())
                .logging(VirtualGatewaySpecLoggingArgs.builder()
                    .accessLog(VirtualGatewaySpecLoggingAccessLogArgs.builder()
                        .file(VirtualGatewaySpecLoggingAccessLogFileArgs.builder()
                            .path("/var/log/access.log")
                            .build())
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:appmesh:VirtualGateway
    properties:
      name: example-virtual-gateway
      meshName: example-service-mesh
      spec:
        listeners:
          - portMapping:
              port: 8080
              protocol: http
            tls:
              certificate:
                acm:
                  certificateArn: ${exampleAwsAcmCertificate.arn}
              mode: STRICT
        logging:
          accessLog:
            file:
              path: /var/log/access.log
Content copied to clipboard

Import

Using pulumi import, import App Mesh virtual gateway using mesh_name together with the virtual gateway's name. For example:

$ pulumi import aws:appmesh/virtualGateway:VirtualGateway example mesh/gw1
Content copied to clipboard

Properties

Link copied to clipboard
val arn: Output<String>

ARN of the virtual gateway.

Link copied to clipboard
val createdDate: Output<String>

Creation date of the virtual gateway.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val lastUpdatedDate: Output<String>

Last update date of the virtual gateway.

Link copied to clipboard
val meshName: Output<String>

Name of the service mesh in which to create the virtual gateway. Must be between 1 and 255 characters in length.

Link copied to clipboard
val meshOwner: Output<String>

AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.

Link copied to clipboard
val name: Output<String>

Name to use for the virtual gateway. Must be between 1 and 255 characters in length.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val resourceOwner: Output<String>

Resource owner's AWS account ID.

Link copied to clipboard
val spec: Output<VirtualGatewaySpec>

Virtual gateway specification to apply.

Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>