software.amazon.awscdk.services.amplify

Class Domain.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.Domain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Domain>

Enclosing class:

Domain

@Stability(value=Experimental)
public static final class Domain.Builder
extends Object
implements software.amazon.jsii.Builder<Domain>

(experimental) A fluent builder for Domain.

Method Summary

Modifier and Type	Method and Description
Domain.Builder	app(IApp app) (experimental) The application to which the domain must be connected.
Domain.Builder	autoSubdomainCreationPatterns(List<String> autoSubdomainCreationPatterns) (experimental) Branches which should automatically create subdomains.
Domain.Builder	autoSubDomainIamRole(IRole autoSubDomainIamRole) (experimental) The IAM role with access to Route53 when using enableAutoSubdomain.
Domain	build()
static Domain.Builder	create(software.constructs.Construct scope, String id)
Domain.Builder	domainName(String domainName) (experimental) The name of the domain.
Domain.Builder	enableAutoSubdomain(Boolean enableAutoSubdomain) (experimental) Automatically create subdomains for connected branches.
Domain.Builder	subDomains(List<? extends SubDomain> subDomains) (experimental) Subdomains.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Domain.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Domain.Builder.

autoSubdomainCreationPatterns

@Stability(value=Experimental)
public Domain.Builder autoSubdomainCreationPatterns(List<String> autoSubdomainCreationPatterns)

(experimental) Branches which should automatically create subdomains.

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

Parameters:

autoSubdomainCreationPatterns - Branches which should automatically create subdomains. This parameter is required.

Returns:

this

domainName

@Stability(value=Experimental)
public Domain.Builder domainName(String domainName)

(experimental) The name of the domain.

Default: - the construct's id

Parameters:

domainName - The name of the domain. This parameter is required.

Returns:

this

enableAutoSubdomain

@Stability(value=Experimental)
public Domain.Builder enableAutoSubdomain(Boolean enableAutoSubdomain)

(experimental) Automatically create subdomains for connected branches.

Default: false

Parameters:

enableAutoSubdomain - Automatically create subdomains for connected branches. This parameter is required.

Returns:

this

subDomains

@Stability(value=Experimental)
public Domain.Builder subDomains(List<? extends SubDomain> subDomains)

(experimental) Subdomains.

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

Parameters:

subDomains - Subdomains. This parameter is required.

Returns:

this

app

@Stability(value=Experimental)
public Domain.Builder app(IApp app)

(experimental) The application to which the domain must be connected.

Parameters:

app - The application to which the domain must be connected. This parameter is required.

Returns:

this

autoSubDomainIamRole

@Stability(value=Experimental)
public Domain.Builder autoSubDomainIamRole(IRole autoSubDomainIamRole)

(experimental) The IAM role with access to Route53 when using enableAutoSubdomain.

Default: the IAM role from App.grantPrincipal

Parameters:

autoSubDomainIamRole - The IAM role with access to Route53 when using enableAutoSubdomain. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Domain build()

Specified by:

build in interface software.amazon.jsii.Builder<Domain>