software.amazon.awscdk.services.appsync

Interface DomainOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.811Z")
 @Stability(value=Experimental)
public interface DomainOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Domain name configuration for AppSync.

Example:

 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 // hosted zone and route53 features
 String hostedZoneId;
 String zoneName = "example.com";
 String myDomainName = "api.example.com";
 Certificate certificate = Certificate.Builder.create(this, "cert").domainName(myDomainName).build();
 GraphqlApi api = GraphqlApi.Builder.create(this, "api")
         .name("myApi")
         .domainName(DomainOptions.builder()
                 .certificate(certificate)
                 .domainName(myDomainName)
                 .build())
         .build();
 // hosted zone for adding appsync domain
 IHostedZone zone = HostedZone.fromHostedZoneAttributes(this, "HostedZone", HostedZoneAttributes.builder()
         .hostedZoneId(hostedZoneId)
         .zoneName(zoneName)
         .build());
 // create a cname to the appsync domain. will map to something like xxxx.cloudfront.net
 // create a cname to the appsync domain. will map to something like xxxx.cloudfront.net
 CnameRecord.Builder.create(this, "CnameApiRecord")
         .recordName("api")
         .zone(zone)
         .domainName(myDomainName)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DomainOptions.Builder	builder()
ICertificate	getCertificate() (experimental) The certificate to use with the domain name.
String	getDomainName() (experimental) The actual domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificate

@Stability(value=Experimental)
 @NotNull
ICertificate getCertificate()

(experimental) The certificate to use with the domain name.

getDomainName

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

(experimental) The actual domain name.

For example, api.example.com.

builder

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

Returns:

a DomainOptions.Builder of DomainOptions