Interface AppSyncDomainOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AppSyncDomainOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-10-14T12:28:05.157Z")
@Stability(Stable)
public interface AppSyncDomainOptions
extends software.amazon.jsii.JsiiSerializable
Domain name configuration for AppSync.
Example:
import software.amazon.awscdk.services.certificatemanager.*;
import software.amazon.awscdk.services.route53.*;
String myDomainName = "api.example.com";
Certificate certificate = Certificate.Builder.create(this, "cert").domainName(myDomainName).build();
AppSyncAuthProvider apiKeyProvider = AppSyncAuthProvider.builder()
.authorizationType(AppSyncAuthorizationType.API_KEY)
.build();
EventApi api = EventApi.Builder.create(this, "api")
.apiName("Api")
.ownerContact("OwnerContact")
.authorizationConfig(EventApiAuthConfig.builder()
.authProviders(List.of(apiKeyProvider))
.connectionAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
.defaultPublishAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
.defaultSubscribeAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
.build())
// Custom Domain Settings
.domainName(AppSyncDomainOptions.builder()
.certificate(certificate)
.domainName(myDomainName)
.build())
.build();
api.addChannelNamespace("default");
// You can get custom HTTP/Realtime endpoint
// You can get custom HTTP/Realtime endpoint
CfnOutput.Builder.create(this, "AWS AppSync Events HTTP endpoint").value(api.getCustomHttpEndpoint()).build();
CfnOutput.Builder.create(this, "AWS AppSync Events Realtime endpoint").value(api.getCustomRealtimeEndpoint()).build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forAppSyncDomainOptionsstatic final classAn implementation forAppSyncDomainOptions -
Method Summary
Modifier and TypeMethodDescriptionstatic AppSyncDomainOptions.Builderbuilder()The certificate to use with the domain name.The actual domain name.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCertificate
The certificate to use with the domain name. -
getDomainName
The actual domain name.For example,
api.example.com. -
builder
- Returns:
- a
AppSyncDomainOptions.BuilderofAppSyncDomainOptions
-