Interface DomainNameProps
- All Superinterfaces:
EndpointOptions
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DomainNameProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-15T21:09:13.851Z")
@Stability(Stable)
public interface DomainNameProps
extends software.amazon.jsii.JsiiSerializable, EndpointOptions
properties used for creating the DomainName.
Example:
import software.amazon.awscdk.services.certificatemanager.*; import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpLambdaIntegration; Function handler; String certArn = "arn:aws:acm:us-east-1:111111111111:certificate"; String domainName = "example.com"; DomainName dn = DomainName.Builder.create(this, "DN") .domainName(domainName) .certificate(Certificate.fromCertificateArn(this, "cert", certArn)) .build(); HttpApi api = HttpApi.Builder.create(this, "HttpProxyProdApi") .defaultIntegration(new HttpLambdaIntegration("DefaultIntegration", handler)) // https://${dn.domainName}/foo goes to prodApi $default stage .defaultDomainMapping(DomainMappingOptions.builder() .domainName(dn) .mappingKey("foo") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forDomainNameProps
static final class
An implementation forDomainNameProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic DomainNameProps.Builder
builder()
The custom domain name.default MTLSConfig
getMtls()
The mutual TLS authentication configuration for a custom domain name.Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.EndpointOptions
getCertificate, getCertificateName, getEndpointType, getOwnershipCertificate, getSecurityPolicy
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDomainName
The custom domain name. -
getMtls
The mutual TLS authentication configuration for a custom domain name.Default: - mTLS is not configured.
-
builder
- Returns:
- a
DomainNameProps.Builder
ofDomainNameProps
-