software.amazon.awscdk.services.amplify

Interface DomainProps

All Superinterfaces:

DomainOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.123Z")
 @Stability(value=Experimental)
public interface DomainProps
extends software.amazon.jsii.JsiiSerializable, DomainOptions

(experimental) Properties for a Domain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 import software.amazon.awscdk.services.iam.*;
 App app;
 Branch branch;
 Role role;
 DomainProps domainProps = DomainProps.builder()
         .app(app)
         // the properties below are optional
         .autoSubdomainCreationPatterns(List.of("autoSubdomainCreationPatterns"))
         .autoSubDomainIamRole(role)
         .domainName("domainName")
         .enableAutoSubdomain(false)
         .subDomains(List.of(SubDomain.builder()
                 .branch(branch)
                 // the properties below are optional
                 .prefix("prefix")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DomainProps.Builder A builder for DomainProps
static class	DomainProps.Jsii$Proxy An implementation for DomainProps

Method Summary

Modifier and Type	Method and Description
static DomainProps.Builder	builder()
IApp	getApp() (experimental) The application to which the domain must be connected.
default IRole	getAutoSubDomainIamRole() (experimental) The IAM role with access to Route53 when using enableAutoSubdomain.

Methods inherited from interface software.amazon.awscdk.services.amplify.DomainOptions

getAutoSubdomainCreationPatterns, getDomainName, getEnableAutoSubdomain, getSubDomains

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApp

@Stability(value=Experimental)
 @NotNull
IApp getApp()

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

getAutoSubDomainIamRole

@Stability(value=Experimental)
 @Nullable
default IRole getAutoSubDomainIamRole()

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

Default: the IAM role from App.grantPrincipal

builder

@Stability(value=Experimental)
static DomainProps.Builder builder()

Specified by:

builder in interface DomainOptions

Returns:

a DomainProps.Builder of DomainProps