Package software.amazon.awscdk.services.apigateway

Interface CfnDomainNameV2Props

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameV2Props.Jsii$Proxy

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

Properties for defining a CfnDomainNameV2.

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.*;
 Object policy;
 CfnDomainNameV2Props cfnDomainNameV2Props = CfnDomainNameV2Props.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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameV2Props.Builder	builder()
default String	getCertificateArn()	The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
default String	getDomainName()	Represents a custom domain name as a user-friendly host name of an API (RestApi).
default String	getEndpointAccessMode()	The endpoint access mode for your DomainName.
default Object	getEndpointConfiguration()	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.
default Object	getPolicy()	A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.
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 the private endpoint for this domain name.

AWS Certificate Manager is the only supported source.

See Also:

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

getDomainName

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

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-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-domainnamev2.html#cfn-apigateway-domainnamev2-endpointaccessmode

getEndpointConfiguration

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

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.

Returns union: either IResolvable or CfnDomainNameV2.EndpointConfigurationProperty

See Also:

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

getPolicy

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

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.

You can use Fn::ToJsonString to enter your policy . For more information, see Fn::ToJsonString .

See Also:

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

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 private APIs.

Default: - "BASE_PATH_MAPPING_ONLY"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-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-domainnamev2.html#cfn-apigateway-domainnamev2-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-domainnamev2.html#cfn-apigateway-domainnamev2-tags

builder

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

Returns:

a CfnDomainNameV2Props.Builder of CfnDomainNameV2Props