Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Interface CfnDomainNameMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.524Z")
@Stability(Stable)
public interface CfnDomainNameMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDomainNamePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 CfnDomainNameMixinProps cfnDomainNameMixinProps = CfnDomainNameMixinProps.builder()
         .domainName("domainName")
         .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	CfnDomainNameMixinProps.Builder	A builder for CfnDomainNameMixinProps
static final class	CfnDomainNameMixinProps.Jsii$Proxy	An implementation for CfnDomainNameMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameMixinProps.Builder	builder()
default 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)
@Nullable
default 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 CfnDomainNamePropsMixin.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 CfnDomainNamePropsMixin.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 CfnDomainNameMixinProps.Builder builder()

Returns:

a CfnDomainNameMixinProps.Builder of CfnDomainNameMixinProps