Package com.pulumi.aws.apigatewayv2

Class ApiMapping

  • public class ApiMapping
extends com.pulumi.resources.CustomResource
    Manages an Amazon API Gateway Version 2 API mapping. More information can be found in the [Amazon API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html). ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.apigatewayv2.ApiMapping;
 import com.pulumi.aws.apigatewayv2.ApiMappingArgs;
 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 ApiMapping("example", ApiMappingArgs.builder()
             .apiId(exampleAwsApigatewayv2Api.id())
             .domainName(exampleAwsApigatewayv2DomainName.id())
             .stage(exampleAwsApigatewayv2Stage.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.apigatewayv2.ApiMapping` using the API mapping identifier and domain name. For example: ```sh $ pulumi import aws:apigatewayv2/apiMapping:ApiMapping example 1122334/ws-api.example.com ```

    • 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> apiId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> apiMappingKey()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      static ApiMapping get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ApiMappingState 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> region()  
      com.pulumi.core.Output<java.lang.String> stage()  

      • 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

      • ApiMapping

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

      • ApiMapping

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

      • ApiMapping

        public ApiMapping​(java.lang.String name,
                  ApiMappingArgs 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

      • apiId

        public com.pulumi.core.Output<java.lang.String> apiId()
        Returns:
        API identifier.

      • apiMappingKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> apiMappingKey()
        Returns:
        API mapping key. Refer to [REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-mappings.html), [HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-mappings.html) or [WebSocket API](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-mappings.html).

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Domain name. Use the `aws.apigatewayv2.DomainName` resource to configure a domain name.

      • 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.

      • stage

        public com.pulumi.core.Output<java.lang.String> stage()
        Returns:
        API stage. Use the `aws.apigatewayv2.Stage` resource to configure an API stage.

      • get

        public static ApiMapping get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             ApiMappingState 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.