Package com.pulumi.aws.apigateway

Class BasePathMapping

  • public class BasePathMapping
extends com.pulumi.resources.CustomResource
    Connects a custom domain name registered via `aws.apigateway.DomainName` with a deployed API so that its methods can be called via the custom domain name. ## Import For a non-root `basePath`: For a non-root `basePath` and a private custom domain name: Using `pulumi import`, import `aws.apigateway.BasePathMapping` using the domain name and base path or domain name, base path and domain name ID (for private custom domain names). For example: For an empty `basePath` or, in other words, a root path (`/`): ```sh $ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/ ``` For a non-root `basePath`: ```sh $ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/base-path ``` For a non-root `basePath` and a private custom domain name: ```sh $ pulumi import aws:apigateway/basePathMapping:BasePathMapping example api.internal.example.com/base-path/abcde12345 ```

    • 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.util.Optional<java.lang.String>> basePath()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> domainNameId()  
      static BasePathMapping get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BasePathMappingState 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> restApi()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> stageName()  

      • 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

      • BasePathMapping

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

      • BasePathMapping

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

      • BasePathMapping

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

      • basePath

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> basePath()
        Returns:
        Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        Already-registered domain name to connect the API to.

      • domainNameId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> domainNameId()
        Returns:
        Identifier for the domain name resource. Supported only for private custom domain names.

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

      • restApi

        public com.pulumi.core.Output<java.lang.String> restApi()
        Returns:
        ID of the API to connect.

      • stageName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> stageName()
        Returns:
        Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.

      • get

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