Package software.amazon.awscdk.services.apigatewayv2

Interface CfnDomainNameProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:13.473Z")
@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.apigatewayv2.*;
 CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .domainNameConfigurations(List.of(DomainNameConfigurationProperty.builder()
                 .certificateArn("certificateArn")
                 .certificateName("certificateName")
                 .endpointType("endpointType")
                 .ipAddressType("ipAddressType")
                 .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
                 .securityPolicy("securityPolicy")
                 .build()))
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .routingMode("routingMode")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-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()
String	getDomainName()	The custom domain name for your API in Amazon API Gateway.
default Object	getDomainNameConfigurations()	The domain name configurations.
default Object	getMutualTlsAuthentication()	The mutual TLS authentication configuration for a custom domain name.
default String	getRoutingMode()	The routing mode API Gateway uses to route traffic to your APIs.
default Map<String,String>	getTags()	The collection of tags associated with a domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The custom domain name for your API in Amazon API Gateway.

Uppercase letters and the underscore ( _ ) character are not supported.

See Also:

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

getDomainNameConfigurations

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

The domain name configurations.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomainName.DomainNameConfigurationProperty>

See Also:

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

getMutualTlsAuthentication

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

The mutual TLS authentication configuration for a custom domain name.

Returns union: either IResolvable or CfnDomainName.MutualTlsAuthenticationProperty

See Also:

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

getRoutingMode

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

The routing mode API Gateway uses to route traffic to your APIs.

Default: - "API_MAPPING_ONLY"

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The collection of tags associated with a domain name.

See Also:

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

builder

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

Returns:

a CfnDomainNameProps.Builder of CfnDomainNameProps