Interface DomainNameOptions

All Superinterfaces:
All Known Subinterfaces:
All Known Implementing Classes:
DomainNameOptions.Jsii$Proxy, DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:13.690Z") @Stability(Stable) public interface DomainNameOptions extends

 Object acmCertificateForExampleCom;
 RestApi api = RestApi.Builder.create(this, "MyDomain")
  • Method Details

    • getCertificate

      @Stability(Stable) @NotNull ICertificate getCertificate()
      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.

    • getDomainName

      @Stability(Stable) @NotNull String getDomainName()
      The custom domain name for your API.

      Uppercase letters are not supported.

    • getBasePath

      @Stability(Stable) @Nullable default String getBasePath()
      The base path name that callers of the API must provide in the URL after the domain name (e.g. If you specify this property, it can't be an empty string.

      Default: - map requests from the domain root (e.g. ``).

    • getEndpointType

      @Stability(Stable) @Nullable default EndpointType getEndpointType()
      The type of endpoint for this DomainName.

      Default: REGIONAL

    • getMtls

      @Stability(Stable) @Nullable default MTLSConfig getMtls()
      The mutual TLS authentication configuration for a custom domain name.

      Default: - mTLS is not configured.

    • getSecurityPolicy

      @Stability(Stable) @Nullable default SecurityPolicy getSecurityPolicy()
      The Transport Layer Security (TLS) version + cipher suite for this domain name.

      Default: SecurityPolicy.TLS_1_2

      See Also:
    • builder

      @Stability(Stable) static DomainNameOptions.Builder builder()
      a DomainNameOptions.Builder of DomainNameOptions