Package software.amazon.awscdk.services.apigateway

Class BasePathMappingProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.BasePathMappingProps.Jsii$Proxy
All Implemented Interfaces:
BasePathMappingOptions, BasePathMappingProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
BasePathMappingProps
@Stability(Stable) @Internal public static final class BasePathMappingProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements BasePathMappingProps
An implementation for BasePathMappingProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(BasePathMappingProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the BasePathMappingProps.Builder.

  • Method Details

    • getDomainName

      public final IDomainNameRef getDomainName()
      Description copied from interface: BasePathMappingProps
      The DomainName to associate with this base path mapping.
      Specified by:
      getDomainName in interface BasePathMappingProps

    • getRestApi

      public final IRestApiRef getRestApi()
      Description copied from interface: BasePathMappingProps
      The RestApi resource to target.
      Specified by:
      getRestApi in interface BasePathMappingProps

    • getAttachToStage

      public final Boolean getAttachToStage()
      Description copied from interface: BasePathMappingOptions
      Whether to attach the base path mapping to a stage.

      Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.

      Default: - true

      Specified by:
      getAttachToStage in interface BasePathMappingOptions

    • getBasePath

      public final String getBasePath()
      Description copied from interface: BasePathMappingOptions
      The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.

      Default: - map requests from the domain root (e.g. `example.com`). If this is undefined, no additional mappings will be allowed on this domain name.

      Specified by:
      getBasePath in interface BasePathMappingOptions

    • getStage

      public final Stage getStage()
      Description copied from interface: BasePathMappingOptions
      The Deployment stage of API [disable-awslint:ref-via-interface].

      Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL

      Specified by:
      getStage in interface BasePathMappingOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object