Package software.amazon.awscdk.services.apigateway

Class DomainNameProps.Jsii$Proxy

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.DomainNameProps

    DomainNameProps.Builder, DomainNameProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(DomainNameProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the DomainNameProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getBasePath()
    The base path name that callers of the API must provide in the URL after the domain name (e.g.
    final ICertificate
    getCertificate()
    The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.
    final String
    getDomainName()
    The custom domain name for your API.
    final EndpointType
    getEndpointType()
    The type of endpoint for this DomainName.
    final IRestApi
    getMapping()
    If specified, all requests to this domain will be mapped to the production deployment of this API.
    final MTLSConfig
    getMtls()
    The mutual TLS authentication configuration for a custom domain name.
    final SecurityPolicy
    getSecurityPolicy()
    The Transport Layer Security (TLS) version + cipher suite for this domain name.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • 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(DomainNameProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DomainNameProps.Builder.

  • Method Details

    • getMapping

      public final IRestApi getMapping()
      Description copied from interface: DomainNameProps
      If specified, all requests to this domain will be mapped to the production deployment of this API.

      If you wish to map this domain to multiple APIs with different base paths, don't specify this option and use addBasePathMapping.

      Default: - you will have to call `addBasePathMapping` to map this domain to API endpoints.

      Specified by:
      getMapping in interface DomainNameProps

    • getCertificate

      public final ICertificate getCertificate()
      Description copied from interface: DomainNameOptions
      The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.

      For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.

      Specified by:
      getCertificate in interface DomainNameOptions

    • getDomainName

      public final String getDomainName()
      Description copied from interface: DomainNameOptions
      The custom domain name for your API.

      Uppercase letters are not supported.

      Specified by:
      getDomainName in interface DomainNameOptions

    • getBasePath

      public final String getBasePath()
      Description copied from interface: DomainNameOptions
      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 DomainNameOptions

    • getEndpointType

      public final EndpointType getEndpointType()
      Description copied from interface: DomainNameOptions
      The type of endpoint for this DomainName.

      Default: REGIONAL

      Specified by:
      getEndpointType in interface DomainNameOptions

    • getMtls

      public final MTLSConfig getMtls()
      Description copied from interface: DomainNameOptions
      The mutual TLS authentication configuration for a custom domain name.

      Default: - mTLS is not configured.

      Specified by:
      getMtls in interface DomainNameOptions

    • getSecurityPolicy

      public final SecurityPolicy getSecurityPolicy()
      Description copied from interface: DomainNameOptions
      The Transport Layer Security (TLS) version + cipher suite for this domain name.

      Default: SecurityPolicy.TLS_1_0

      Specified by:
      getSecurityPolicy in interface DomainNameOptions
      See Also:

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