Package software.amazon.awscdk.services.apigateway

Interface CfnDomainNameProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.109Z")
@Stability(Stable)
public interface CfnDomainNameProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomainName.

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.apigateway.*;
 CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         .endpointAccessMode("endpointAccessMode")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .ipAddressType("ipAddressType")
                 .types(List.of("types"))
                 .build())
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .regionalCertificateArn("regionalCertificateArn")
         .routingMode("routingMode")
         .securityPolicy("securityPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameProps.Builder	builder()
default String	getCertificateArn()	The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
default String	getDomainName()	The custom domain name as an API host name, for example, my-api.example.com .
default String	getEndpointAccessMode()	The endpoint access mode for your DomainName.
default Object	getEndpointConfiguration()	The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
default Object	getMutualTlsAuthentication()	The mutual TLS authentication configuration for a custom domain name.
default String	getOwnershipVerificationCertificateArn()	The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
default String	getRegionalCertificateArn()	The reference to an AWS -managed certificate that will be used for validating the regional domain name.
default String	getRoutingMode()	The routing mode for this domain name.
default String	getSecurityPolicy()	The Transport Layer Security (TLS) version + cipher suite for this DomainName.
default List<CfnTag>	getTags()	The collection of tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.

Certificate Manager is the only supported source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn

getDomainName

@Stability(Stable)
@Nullable
default String getDomainName()

The custom domain name as an API host name, for example, my-api.example.com .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname

getEndpointAccessMode

@Stability(Stable)
@Nullable
default String getEndpointAccessMode()

The endpoint access mode for your DomainName.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointaccessmode

getEndpointConfiguration

@Stability(Stable)
@Nullable
default Object getEndpointConfiguration()

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.

Returns union: either IResolvable or CfnDomainName.EndpointConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration

getMutualTlsAuthentication

@Stability(Stable)
@Nullable
default Object getMutualTlsAuthentication()

The mutual TLS authentication configuration for a custom domain name.

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Returns union: either IResolvable or CfnDomainName.MutualTlsAuthenticationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication

getOwnershipVerificationCertificateArn

@Stability(Stable)
@Nullable
default String getOwnershipVerificationCertificateArn()

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn

getRegionalCertificateArn

@Stability(Stable)
@Nullable
default String getRegionalCertificateArn()

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

Certificate Manager is the only supported source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn

getRoutingMode

@Stability(Stable)
@Nullable
default String getRoutingMode()

The routing mode for this domain name.

The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.

Default: - "BASE_PATH_MAPPING_ONLY"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-routingmode

getSecurityPolicy

@Stability(Stable)
@Nullable
default String getSecurityPolicy()

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The collection of tags.

Each tag element is associated with a given resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags

builder

@Stability(Stable)
static CfnDomainNameProps.Builder builder()

Returns:

a CfnDomainNameProps.Builder of CfnDomainNameProps