Package com.pulumi.aws.apigateway

Class BasePathMappingArgs

  • public final class BasePathMappingArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BasePathMappingArgs.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • basePath

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

      • region

        public java.util.Optional<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 java.util.Optional<com.pulumi.core.Output<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.