@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:45.313Z") public class Domain extends Resource
Example:
App amplifyApp; Branch master; 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(master); // map master branch to domain root domain.mapSubDomain(master, "www"); domain.mapSubDomain(dev);
Modifier and Type | Class and Description |
---|---|
static class |
Domain.Builder
(experimental) A fluent builder for
Domain . |
IResource.Jsii$Default
Modifier | Constructor and Description |
---|---|
protected |
Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Domain(software.amazon.jsii.JsiiObjectRef objRef) |
|
Domain(software.constructs.Construct scope,
java.lang.String id,
DomainProps props) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getArn()
(experimental) The ARN of the domain.
|
java.lang.String |
getCertificateRecord()
(experimental) The DNS Record for certificate verification.
|
java.util.List<java.lang.String> |
getDomainAutoSubDomainCreationPatterns()
(experimental) Branch patterns for the automatically created subdomain.
|
java.lang.String |
getDomainAutoSubDomainIamRole()
(experimental) The IAM service role for the subdomain.
|
IResolvable |
getDomainEnableAutoSubDomain()
(experimental) Specifies whether the automated creation of subdomains for branches is enabled.
|
java.lang.String |
getDomainName()
(experimental) The name of the domain.
|
java.lang.String |
getDomainStatus()
(experimental) The status of the domain association.
|
java.lang.String |
getStatusReason()
(experimental) The reason for the current status of the domain.
|
Domain |
mapRoot(IBranch branch)
(experimental) Maps a branch to the domain root.
|
Domain |
mapSubDomain(IBranch branch)
(experimental) Maps a branch to a sub domain.
|
Domain |
mapSubDomain(IBranch branch,
java.lang.String prefix)
(experimental) Maps a branch to a sub domain.
|
protected java.util.List<java.lang.String> |
validate()
(experimental) Validate the current construct.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getNode
protected Domain(software.amazon.jsii.JsiiObjectRef objRef)
protected Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public Domain(software.constructs.Construct scope, java.lang.String id, DomainProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public Domain mapRoot(IBranch branch)
branch
- This parameter is required.public Domain mapSubDomain(IBranch branch, java.lang.String prefix)
branch
- The branch. This parameter is required.prefix
- The prefix.public Domain mapSubDomain(IBranch branch)
branch
- The branch. This parameter is required.protected java.util.List<java.lang.String> validate()
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
public java.lang.String getArn()
public java.lang.String getCertificateRecord()
public java.util.List<java.lang.String> getDomainAutoSubDomainCreationPatterns()
public java.lang.String getDomainAutoSubDomainIamRole()
public IResolvable getDomainEnableAutoSubDomain()
public java.lang.String getDomainName()
public java.lang.String getDomainStatus()
public java.lang.String getStatusReason()