1. Packages
  2. AWS Classic
  3. API Docs
  4. appmesh
  5. getVirtualGateway

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws.appmesh.getVirtualGateway

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Data source for managing an AWS App Mesh Virtual Gateway.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.appmesh.getVirtualGateway({
        meshName: "mesh-gateway",
        name: "example-mesh",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appmesh.get_virtual_gateway(mesh_name="mesh-gateway",
        name="example-mesh")
    
    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.LookupVirtualGateway(ctx, &appmesh.LookupVirtualGatewayArgs{
    			MeshName: "mesh-gateway",
    			Name:     "example-mesh",
    		}, nil)
    		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 = Aws.AppMesh.GetVirtualGateway.Invoke(new()
        {
            MeshName = "mesh-gateway",
            Name = "example-mesh",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appmesh.AppmeshFunctions;
    import com.pulumi.aws.appmesh.inputs.GetVirtualGatewayArgs;
    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) {
            final var example = AppmeshFunctions.getVirtualGateway(GetVirtualGatewayArgs.builder()
                .meshName("mesh-gateway")
                .name("example-mesh")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:appmesh:getVirtualGateway
          Arguments:
            meshName: mesh-gateway
            name: example-mesh
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.AwsFunctions;
    import com.pulumi.aws.inputs.GetCallerIdentityArgs;
    import com.pulumi.aws.appmesh.AppmeshFunctions;
    import com.pulumi.aws.appmesh.inputs.GetVirtualGatewayArgs;
    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) {
            final var current = AwsFunctions.getCallerIdentity();
    
            final var test = AppmeshFunctions.getVirtualGateway(GetVirtualGatewayArgs.builder()
                .name("example.mesh.local")
                .meshName("example-mesh")
                .meshOwner(current.applyValue(getCallerIdentityResult -> getCallerIdentityResult.accountId()))
                .build());
    
        }
    }
    
    variables:
      current:
        fn::invoke:
          Function: aws:getCallerIdentity
          Arguments: {}
      test:
        fn::invoke:
          Function: aws:appmesh:getVirtualGateway
          Arguments:
            name: example.mesh.local
            meshName: example-mesh
            meshOwner: ${current.accountId}
    

    Using getVirtualGateway

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualGateway(args: GetVirtualGatewayArgs, opts?: InvokeOptions): Promise<GetVirtualGatewayResult>
    function getVirtualGatewayOutput(args: GetVirtualGatewayOutputArgs, opts?: InvokeOptions): Output<GetVirtualGatewayResult>
    def get_virtual_gateway(mesh_name: Optional[str] = None,
                            name: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVirtualGatewayResult
    def get_virtual_gateway_output(mesh_name: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetVirtualGatewayResult]
    func LookupVirtualGateway(ctx *Context, args *LookupVirtualGatewayArgs, opts ...InvokeOption) (*LookupVirtualGatewayResult, error)
    func LookupVirtualGatewayOutput(ctx *Context, args *LookupVirtualGatewayOutputArgs, opts ...InvokeOption) LookupVirtualGatewayResultOutput

    > Note: This function is named LookupVirtualGateway in the Go SDK.

    public static class GetVirtualGateway 
    {
        public static Task<GetVirtualGatewayResult> InvokeAsync(GetVirtualGatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualGatewayResult> Invoke(GetVirtualGatewayInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualGatewayResult> getVirtualGateway(GetVirtualGatewayArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:appmesh/getVirtualGateway:getVirtualGateway
      arguments:
        # arguments dictionary

    The following arguments are supported:

    MeshName string
    Name of the service mesh in which the virtual gateway exists.
    Name string
    Name of the virtual gateway.
    Tags Dictionary<string, string>
    Map of tags.
    MeshName string
    Name of the service mesh in which the virtual gateway exists.
    Name string
    Name of the virtual gateway.
    Tags map[string]string
    Map of tags.
    meshName String
    Name of the service mesh in which the virtual gateway exists.
    name String
    Name of the virtual gateway.
    tags Map<String,String>
    Map of tags.
    meshName string
    Name of the service mesh in which the virtual gateway exists.
    name string
    Name of the virtual gateway.
    tags {[key: string]: string}
    Map of tags.
    mesh_name str
    Name of the service mesh in which the virtual gateway exists.
    name str
    Name of the virtual gateway.
    tags Mapping[str, str]
    Map of tags.
    meshName String
    Name of the service mesh in which the virtual gateway exists.
    name String
    Name of the virtual gateway.
    tags Map<String>
    Map of tags.

    getVirtualGateway Result

    The following output properties are available:

    Arn string
    ARN of the virtual gateway.
    CreatedDate string
    Creation date of the virtual gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last update date of the virtual gateway.
    MeshName string
    MeshOwner string
    Name string
    ResourceOwner string
    Resource owner's AWS account ID.
    Specs List<GetVirtualGatewaySpec>
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    Tags Dictionary<string, string>
    Map of tags.
    Arn string
    ARN of the virtual gateway.
    CreatedDate string
    Creation date of the virtual gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last update date of the virtual gateway.
    MeshName string
    MeshOwner string
    Name string
    ResourceOwner string
    Resource owner's AWS account ID.
    Specs []GetVirtualGatewaySpec
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    Tags map[string]string
    Map of tags.
    arn String
    ARN of the virtual gateway.
    createdDate String
    Creation date of the virtual gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last update date of the virtual gateway.
    meshName String
    meshOwner String
    name String
    resourceOwner String
    Resource owner's AWS account ID.
    specs List<GetVirtualGatewaySpec>
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    tags Map<String,String>
    Map of tags.
    arn string
    ARN of the virtual gateway.
    createdDate string
    Creation date of the virtual gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate string
    Last update date of the virtual gateway.
    meshName string
    meshOwner string
    name string
    resourceOwner string
    Resource owner's AWS account ID.
    specs GetVirtualGatewaySpec[]
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    tags {[key: string]: string}
    Map of tags.
    arn str
    ARN of the virtual gateway.
    created_date str
    Creation date of the virtual gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_date str
    Last update date of the virtual gateway.
    mesh_name str
    mesh_owner str
    name str
    resource_owner str
    Resource owner's AWS account ID.
    specs Sequence[GetVirtualGatewaySpec]
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    tags Mapping[str, str]
    Map of tags.
    arn String
    ARN of the virtual gateway.
    createdDate String
    Creation date of the virtual gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last update date of the virtual gateway.
    meshName String
    meshOwner String
    name String
    resourceOwner String
    Resource owner's AWS account ID.
    specs List<Property Map>
    Virtual gateway specification. See the aws.appmesh.VirtualGateway resource for details.
    tags Map<String>
    Map of tags.

    Supporting Types

    GetVirtualGatewaySpec

    GetVirtualGatewaySpecBackendDefault

    GetVirtualGatewaySpecBackendDefaultClientPolicy

    GetVirtualGatewaySpecBackendDefaultClientPolicyTl

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlCertificate

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateFile

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlCertificateSd

    SecretName string
    SecretName string
    secretName String
    secretName string
    secretName String

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidation

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeName

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationSubjectAlternativeNameMatch

    Exacts List<string>
    Exacts []string
    exacts List<String>
    exacts string[]
    exacts Sequence[str]
    exacts List<String>

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrust

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustAcm

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustFile

    GetVirtualGatewaySpecBackendDefaultClientPolicyTlValidationTrustSd

    SecretName string
    SecretName string
    secretName String
    secretName string
    secretName String

    GetVirtualGatewaySpecListener

    GetVirtualGatewaySpecListenerConnectionPool

    GetVirtualGatewaySpecListenerConnectionPoolGrpc

    maxRequests Integer

    GetVirtualGatewaySpecListenerConnectionPoolHttp

    GetVirtualGatewaySpecListenerConnectionPoolHttp2

    maxRequests Integer

    GetVirtualGatewaySpecListenerHealthCheck

    healthyThreshold Integer
    intervalMillis Integer
    path String
    port Integer
    protocol String
    timeoutMillis Integer
    unhealthyThreshold Integer

    GetVirtualGatewaySpecListenerPortMapping

    Port int
    Protocol string
    Port int
    Protocol string
    port Integer
    protocol String
    port number
    protocol string
    port int
    protocol str
    port Number
    protocol String

    GetVirtualGatewaySpecListenerTl

    GetVirtualGatewaySpecListenerTlCertificate

    GetVirtualGatewaySpecListenerTlCertificateAcm

    GetVirtualGatewaySpecListenerTlCertificateFile

    GetVirtualGatewaySpecListenerTlCertificateSd

    SecretName string
    SecretName string
    secretName String
    secretName string
    secretName String

    GetVirtualGatewaySpecListenerTlValidation

    GetVirtualGatewaySpecListenerTlValidationSubjectAlternativeName

    GetVirtualGatewaySpecListenerTlValidationSubjectAlternativeNameMatch

    Exacts List<string>
    Exacts []string
    exacts List<String>
    exacts string[]
    exacts Sequence[str]
    exacts List<String>

    GetVirtualGatewaySpecListenerTlValidationTrust

    GetVirtualGatewaySpecListenerTlValidationTrustFile

    GetVirtualGatewaySpecListenerTlValidationTrustSd

    SecretName string
    SecretName string
    secretName String
    secretName string
    secretName String

    GetVirtualGatewaySpecLogging

    GetVirtualGatewaySpecLoggingAccessLog

    GetVirtualGatewaySpecLoggingAccessLogFile

    GetVirtualGatewaySpecLoggingAccessLogFileFormat

    GetVirtualGatewaySpecLoggingAccessLogFileFormatJson

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi