Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDomainNamePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDomainNamePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.457Z")
@Stability(Stable)
public class CfnDomainNamePropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway.

To create a custom domain name for private APIs, use AWS::ApiGateway::DomainNameV2 .

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

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.apigateway.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDomainNamePropsMixin cfnDomainNamePropsMixin = CfnDomainNamePropsMixin.Builder.create(CfnDomainNameMixinProps.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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDomainNamePropsMixin.Builder	A fluent builder for CfnDomainNamePropsMixin.
static interface	CfnDomainNamePropsMixin.EndpointConfigurationProperty	The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.
static interface	CfnDomainNamePropsMixin.MutualTlsAuthenticationProperty	The mutual TLS authentication configuration for a custom domain name.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDomainNamePropsMixin(CfnDomainNameMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::DomainName.
	CfnDomainNamePropsMixin(CfnDomainNameMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::DomainName.
protected	CfnDomainNamePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainNamePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDomainNameMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDomainNamePropsMixin

protected CfnDomainNamePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomainNamePropsMixin

protected CfnDomainNamePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomainNamePropsMixin

@Stability(Stable)
public CfnDomainNamePropsMixin(@NotNull
 CfnDomainNameMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::DomainName.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDomainNamePropsMixin

@Stability(Stable)
public CfnDomainNamePropsMixin(@NotNull
 CfnDomainNameMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::DomainName.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDomainNameMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()