Class VirtualGateway


  • public class VirtualGateway
    extends com.pulumi.resources.CustomResource
    Provides an AWS App Mesh virtual gateway resource. ## Example Usage ### Basic
     
     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.VirtualGatewaySpecListenerArgs;
     import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerPortMappingArgs;
     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 VirtualGateway("example", VirtualGatewayArgs.builder()
                 .spec(VirtualGatewaySpecArgs.builder()
                     .listeners(VirtualGatewaySpecListenerArgs.builder()
                         .portMapping(VirtualGatewaySpecListenerPortMappingArgs.builder()
                             .port(8080)
                             .protocol("http")
                             .build())
                         .build())
                     .build())
                 .name("example-virtual-gateway")
                 .meshName("example-service-mesh")
                 .tags(Map.of("Environment", "test"))
                 .build());
     
         }
     }
     
     
    ### Access Logs and TLS
     
     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 com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerArgs;
     import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerPortMappingArgs;
     import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerTlsArgs;
     import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerTlsCertificateArgs;
     import com.pulumi.aws.appmesh.inputs.VirtualGatewaySpecListenerTlsCertificateAcmArgs;
     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 VirtualGateway("example", VirtualGatewayArgs.builder()
                 .spec(VirtualGatewaySpecArgs.builder()
                     .logging(VirtualGatewaySpecLoggingArgs.builder()
                         .accessLog(VirtualGatewaySpecLoggingAccessLogArgs.builder()
                             .file(VirtualGatewaySpecLoggingAccessLogFileArgs.builder()
                                 .path("/var/log/access.log")
                                 .build())
                             .build())
                         .build())
                     .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())
                     .build())
                 .name("example-virtual-gateway")
                 .meshName("example-service-mesh")
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import App Mesh virtual gateway using `meshName` together with the virtual gateway's `name`. For example: ```sh $ pulumi import aws:appmesh/virtualGateway:VirtualGateway example mesh/gw1 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdDate()  
      static VirtualGateway get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VirtualGatewayState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastUpdatedDate()  
      com.pulumi.core.Output<java.lang.String> meshName()  
      com.pulumi.core.Output<java.lang.String> meshOwner()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceOwner()  
      com.pulumi.core.Output<VirtualGatewaySpec> spec()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • VirtualGateway

        public VirtualGateway​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • VirtualGateway

        public VirtualGateway​(java.lang.String name,
                              VirtualGatewayArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • VirtualGateway

        public VirtualGateway​(java.lang.String name,
                              VirtualGatewayArgs args,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the virtual gateway.
      • createdDate

        public com.pulumi.core.Output<java.lang.String> createdDate()
        Returns:
        Creation date of the virtual gateway.
      • lastUpdatedDate

        public com.pulumi.core.Output<java.lang.String> lastUpdatedDate()
        Returns:
        Last update date of the virtual gateway.
      • meshName

        public com.pulumi.core.Output<java.lang.String> meshName()
        Returns:
        Name of the service mesh in which to create the virtual gateway. Must be between 1 and 255 characters in length.
      • meshOwner

        public com.pulumi.core.Output<java.lang.String> meshOwner()
        Returns:
        AWS account ID of the service mesh's owner. Defaults to the account ID the AWS provider is currently connected to.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name to use for the virtual gateway. Must be between 1 and 255 characters in length.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • resourceOwner

        public com.pulumi.core.Output<java.lang.String> resourceOwner()
        Returns:
        Resource owner's AWS account ID.
      • spec

        public com.pulumi.core.Output<VirtualGatewaySpec> spec()
        Returns:
        Virtual gateway specification to apply.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • get

        public static VirtualGateway get​(java.lang.String name,
                                         com.pulumi.core.Output<java.lang.String> id,
                                         @Nullable
                                         VirtualGatewayState state,
                                         @Nullable
                                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.