Interface DomainNameProps

All Superinterfaces:
DomainNameOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:13.691Z") @Stability(Stable) public interface DomainNameProps extends software.amazon.jsii.JsiiSerializable, DomainNameOptions
Example:

 Object acmCertificateForExampleCom;
 RestApi restApi;
 DomainName.Builder.create(this, "custom-domain")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .mapping(restApi)
         .basePath("orders/v1/api")
         .build();
 
  • Method Details

    • getMapping

      @Stability(Stable) @Nullable default IRestApi getMapping()
      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, use addBasePathMapping or addApiMapping.

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

    • builder

      @Stability(Stable) static DomainNameProps.Builder builder()
      Returns:
      a DomainNameProps.Builder of DomainNameProps