Class Domain
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.amplify.alpha.Domain
- All Implemented Interfaces:
IResource
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:25.599Z")
@Stability(Experimental)
public class Domain
extends Resource
(experimental) An Amplify Console domain.
Example:
App amplifyApp; Branch main; 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(main); // map main branch to domain root domain.mapSubDomain(main, "www"); domain.mapSubDomain(dev);
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
Domain
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Domain
(software.amazon.jsii.JsiiObjectRef objRef) Domain
(software.constructs.Construct scope, String id, DomainProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetArn()
(experimental) The ARN of the domain.(experimental) The DNS Record for certificate verification.(experimental) Branch patterns for the automatically created subdomain.(experimental) The IAM service role for the subdomain.(experimental) Specifies whether the automated creation of subdomains for branches is enabled.(experimental) The name of the domain.(experimental) The status of the domain association.(experimental) The reason for the current status of the domain.(experimental) Maps a branch to the domain root.mapSubDomain
(IBranch branch) (experimental) Maps a branch to a sub domain.mapSubDomain
(IBranch branch, String prefix) (experimental) Maps a branch to a sub domain.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, 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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Domain
protected Domain(software.amazon.jsii.JsiiObjectRef objRef) -
Domain
protected Domain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Domain
@Stability(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 Details
-
mapRoot
(experimental) Maps a branch to the domain root.- Parameters:
branch
- This parameter is required.
-
mapSubDomain
@Stability(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
(experimental) Maps a branch to a sub domain.- Parameters:
branch
- The branch. This parameter is required.
-
getArn
(experimental) The ARN of the domain. -
getCertificateRecord
(experimental) The DNS Record for certificate verification. -
getDomainAutoSubDomainCreationPatterns
(experimental) Branch patterns for the automatically created subdomain. -
getDomainAutoSubDomainIamRole
(experimental) The IAM service role for the subdomain. -
getDomainEnableAutoSubDomain
(experimental) Specifies whether the automated creation of subdomains for branches is enabled. -
getDomainName
(experimental) The name of the domain. -
getDomainStatus
(experimental) The status of the domain association. -
getStatusReason
(experimental) The reason for the current status of the domain.
-