software.amazon.awscdk.services.amplify

Class Domain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.amplify.Domain

All Implemented Interfaces:

IDependable, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.155Z")
 @Stability(value=Experimental)
public class Domain
extends Resource

(experimental) An Amplify Console domain.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Domain.Builder (experimental) A fluent builder for Domain.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Domain(software.constructs.Construct scope, String id, DomainProps props)
protected	Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Domain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getArn() (experimental) The ARN of the domain.
String	getCertificateRecord() (experimental) The DNS Record for certificate verification.
List<String>	getDomainAutoSubDomainCreationPatterns() (experimental) Branch patterns for the automatically created subdomain.
String	getDomainAutoSubDomainIamRole() (experimental) The IAM service role for the subdomain.
IResolvable	getDomainEnableAutoSubDomain() (experimental) Specifies whether the automated creation of subdomains for branches is enabled.
String	getDomainName() (experimental) The name of the domain.
String	getDomainStatus() (experimental) The status of the domain association.
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, String prefix) (experimental) Maps a branch to a sub domain.
protected List<String>	validate() (experimental) Validate the current construct.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Domain

protected Domain(software.amazon.jsii.JsiiObjectRef objRef)

Domain

protected Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Domain

@Stability(value=Experimental)
public Domain(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             DomainProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

mapRoot

@Stability(value=Experimental)
 @NotNull
public Domain mapRoot(@NotNull
                                                               IBranch branch)

(experimental) Maps a branch to the domain root.

Parameters:

branch - This parameter is required.

mapSubDomain

@Stability(value=Experimental)
 @NotNull
public Domain mapSubDomain(@NotNull
                                                                    IBranch branch,
                                                                    @Nullable
                                                                    String prefix)

(experimental) Maps a branch to a sub domain.

Parameters:

branch - The branch. This parameter is required.

prefix - The prefix.

mapSubDomain

@Stability(value=Experimental)
 @NotNull
public Domain mapSubDomain(@NotNull
                                                                    IBranch branch)

(experimental) Maps a branch to a sub domain.

Parameters:

branch - The branch. This parameter is required.

validate

@Stability(value=Experimental)
 @NotNull
protected List<String> validate()

(experimental) Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getArn

@Stability(value=Experimental)
 @NotNull
public String getArn()

(experimental) The ARN of the domain.

getCertificateRecord

@Stability(value=Experimental)
 @NotNull
public String getCertificateRecord()

(experimental) The DNS Record for certificate verification.

getDomainAutoSubDomainCreationPatterns

@Stability(value=Experimental)
 @NotNull
public List<String> getDomainAutoSubDomainCreationPatterns()

(experimental) Branch patterns for the automatically created subdomain.

getDomainAutoSubDomainIamRole

@Stability(value=Experimental)
 @NotNull
public String getDomainAutoSubDomainIamRole()

(experimental) The IAM service role for the subdomain.

getDomainEnableAutoSubDomain

@Stability(value=Experimental)
 @NotNull
public IResolvable getDomainEnableAutoSubDomain()

(experimental) Specifies whether the automated creation of subdomains for branches is enabled.

getDomainName

@Stability(value=Experimental)
 @NotNull
public String getDomainName()

(experimental) The name of the domain.

getDomainStatus

@Stability(value=Experimental)
 @NotNull
public String getDomainStatus()

(experimental) The status of the domain association.

getStatusReason

@Stability(value=Experimental)
 @NotNull
public String getStatusReason()

(experimental) The reason for the current status of the domain.