Interface DomainOptions

All Superinterfaces:
All Known Subinterfaces:
All Known Implementing Classes:
DomainOptions.Jsii$Proxy, DomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.136Z") @Stability(Experimental) public interface DomainOptions extends
(experimental) Options to add a domain to an application.


 App amplifyApp;
 Branch master;
 Branch dev;
 Domain domain = amplifyApp.addDomain("", DomainOptions.builder()
         .enableAutoSubdomain(true) // in case subdomains should be auto registered for branches
         .autoSubdomainCreationPatterns(List.of("*", "pr*"))
 domain.mapRoot(master); // map master branch to domain root
 domain.mapSubDomain(master, "www");
  • Method Details

    • getAutoSubdomainCreationPatterns

      @Stability(Experimental) @Nullable default List<String> getAutoSubdomainCreationPatterns()
      (experimental) Branches which should automatically create subdomains.

      Default: - all repository branches ['*', 'pr*']

    • getDomainName

      @Stability(Experimental) @Nullable default String getDomainName()
      (experimental) The name of the domain.

      Default: - the construct's id

    • getEnableAutoSubdomain

      @Stability(Experimental) @Nullable default Boolean getEnableAutoSubdomain()
      (experimental) Automatically create subdomains for connected branches.

      Default: false

    • getSubDomains

      @Stability(Experimental) @Nullable default List<SubDomain> getSubDomains()
      (experimental) Subdomains.

      Default: - use `addSubDomain()` to add subdomains

    • builder

      @Stability(Experimental) static DomainOptions.Builder builder()
      a DomainOptions.Builder of DomainOptions