Package software.amazon.awscdk.services.apigatewayv2

Interface DomainNameProps

All Superinterfaces:

EndpointOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.243Z")
@Stability(Experimental)
public interface DomainNameProps
extends software.amazon.jsii.JsiiSerializable, EndpointOptions

(experimental) properties used for creating the DomainName.

Example:

 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.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

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DomainNameProps.Builder	builder()
String	getDomainName()	(experimental) The custom domain name.
default MTLSConfig	getMtls()	(experimental) 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

@Stability(Experimental)
@NotNull
String getDomainName()

(experimental) The custom domain name.

getMtls

@Stability(Experimental)
@Nullable
default MTLSConfig getMtls()

(experimental) The mutual TLS authentication configuration for a custom domain name.

Default: - mTLS is not configured.

builder

@Stability(Experimental)
static DomainNameProps.Builder builder()

Returns:

a DomainNameProps.Builder of DomainNameProps