Interface DomainProps

All Superinterfaces:
DomainOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-17T05:10:19.712Z") @Stability(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.alpha.*;
 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();
 
  • Method Details

    • getApp

      @Stability(Experimental) @NotNull IApp getApp()
      (experimental) The application to which the domain must be connected.
    • getAutoSubDomainIamRole

      @Stability(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(Experimental) static DomainProps.Builder builder()
      Returns:
      a DomainProps.Builder of DomainProps