Class Domain.Builder
java.lang.Object
software.amazon.awscdk.services.amplify.alpha.Domain.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Domain>
- Enclosing class:
Domain
@Stability(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 TypeMethodDescription(experimental) The application to which the domain must be connected.autoSubdomainCreationPatterns
(List<String> autoSubdomainCreationPatterns) (experimental) Branches which should automatically create subdomains.autoSubDomainIamRole
(IRole autoSubDomainIamRole) (experimental) The IAM role with access to Route53 when using enableAutoSubdomain.build()
static Domain.Builder
customCertificate
(ICertificate customCertificate) (experimental) The type of SSL/TLS certificate to use for your custom domain.domainName
(String domainName) (experimental) The name of the domain.enableAutoSubdomain
(Boolean enableAutoSubdomain) (experimental) Automatically create subdomains for connected branches.subDomains
(List<? extends SubDomain> subDomains) (experimental) Subdomains.
-
Method Details
-
create
@Stability(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(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
-
customCertificate
(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
- Parameters:
customCertificate
- The type of SSL/TLS certificate to use for your custom domain. This parameter is required.- Returns:
this
-
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
(experimental) Automatically create subdomains for connected branches.Default: false
- Parameters:
enableAutoSubdomain
- Automatically create subdomains for connected branches. This parameter is required.- Returns:
this
-
subDomains
(experimental) Subdomains.Default: - use `addSubDomain()` to add subdomains
- Parameters:
subDomains
- Subdomains. This parameter is required.- Returns:
this
-
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
(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
-