software.amazon.awscdk.services.amplify

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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.408Z")
 @Stability(value=Experimental)
public interface DomainOptions
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 Branch branch;
 DomainOptions domainOptions = DomainOptions.builder()
         .autoSubdomainCreationPatterns(List.of("autoSubdomainCreationPatterns"))
         .domainName("domainName")
         .enableAutoSubdomain(false)
         .subDomains(List.of(SubDomain.builder()
                 .branch(branch)
                 // the properties below are optional
                 .prefix("prefix")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DomainOptions.Builder	builder()
default List<String>	getAutoSubdomainCreationPatterns() (experimental) Branches which should automatically create subdomains.
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 Detail

getAutoSubdomainCreationPatterns

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

(experimental) Branches which should automatically create subdomains.

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

getDomainName

@Stability(value=Experimental)
 @Nullable
default String getDomainName()

(experimental) The name of the domain.

Default: - the construct's id

getEnableAutoSubdomain

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableAutoSubdomain()

(experimental) Automatically create subdomains for connected branches.

Default: false

getSubDomains

@Stability(value=Experimental)
 @Nullable
default List<SubDomain> getSubDomains()

(experimental) Subdomains.

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

builder

@Stability(value=Experimental)
static DomainOptions.Builder builder()

Returns:

a DomainOptions.Builder of DomainOptions