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

Class CfnDomainNameV2PropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDomainNameV2PropsMixin

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.459Z")
@Stability(Stable)
public class CfnDomainNameV2PropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGateway::DomainNameV2 resource specifies a custom domain name for your private APIs in API Gateway.

You can use a private custom domain name to provide a URL for your private API that's more intuitive and easier to recall.

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;
 Object policy;
 CfnDomainNameV2PropsMixin cfnDomainNameV2PropsMixin = CfnDomainNameV2PropsMixin.Builder.create(CfnDomainNameV2MixinProps.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         .endpointAccessMode("endpointAccessMode")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .ipAddressType("ipAddressType")
                 .types(List.of("types"))
                 .build())
         .policy(policy)
         .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-domainnamev2.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDomainNameV2PropsMixin.Builder	A fluent builder for CfnDomainNameV2PropsMixin.
static interface	CfnDomainNameV2PropsMixin.EndpointConfigurationProperty	The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

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
	CfnDomainNameV2PropsMixin(CfnDomainNameV2MixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::DomainNameV2.
	CfnDomainNameV2PropsMixin(CfnDomainNameV2MixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::DomainNameV2.
protected	CfnDomainNameV2PropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainNameV2PropsMixin(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 CfnDomainNameV2MixinProps	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

CfnDomainNameV2PropsMixin

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

CfnDomainNameV2PropsMixin

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

CfnDomainNameV2PropsMixin

@Stability(Stable)
public CfnDomainNameV2PropsMixin(@NotNull
 CfnDomainNameV2MixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnDomainNameV2PropsMixin

@Stability(Stable)
public CfnDomainNameV2PropsMixin(@NotNull
 CfnDomainNameV2MixinProps props)

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

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 CfnDomainNameV2MixinProps getProps()

getStrategy

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