Package software.amazon.awscdk.services.amplify.alpha

Interface DomainOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DomainProps

All Known Implementing Classes:

DomainOptions.Jsii$Proxy, DomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:25.600Z")
@Stability(Experimental)
public interface DomainOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to add a domain to an application.

Example:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DomainOptions.Builder	A builder for DomainOptions
static final class	DomainOptions.Jsii$Proxy	An implementation for DomainOptions

Method Summary

Modifier and Type	Method	Description
static DomainOptions.Builder	builder()
default List<String>	getAutoSubdomainCreationPatterns()	(experimental) Branches which should automatically create subdomains.
default ICertificate	getCustomCertificate()	(experimental) The type of SSL/TLS certificate to use for your custom domain.
default String	getDomainName()	(experimental) The name of the domain.
default Boolean	getEnableAutoSubdomain()	(experimental) Automatically create subdomains for connected branches.
default List<SubDomain>	getSubDomains()	(experimental) Subdomains.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoSubdomainCreationPatterns

@Stability(Experimental)
@Nullable
default List<String> getAutoSubdomainCreationPatterns()

(experimental) Branches which should automatically create subdomains.

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

getCustomCertificate

@Stability(Experimental)
@Nullable
default ICertificate getCustomCertificate()

(experimental) The type of SSL/TLS certificate to use for your custom domain.

Default: - Amplify uses the default certificate that it provisions and manages for you

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()

Returns:

a DomainOptions.Builder of DomainOptions