Package software.amazon.awscdk.services.apigateway

Class CfnDomainNameV2

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigateway.CfnDomainNameV2
All Implemented Interfaces:
IInspectable, ITaggableV2, IDomainNameV2Ref, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.410Z") @Stability(Stable) public class CfnDomainNameV2 extends CfnResource implements IInspectable, IDomainNameV2Ref, ITaggableV2
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.services.apigateway.*;
 Object policy;
 CfnDomainNameV2 cfnDomainNameV2 = CfnDomainNameV2.Builder.create(this, "MyCfnDomainNameV2")
         .certificateArn("certificateArn")
         .domainName("domainName")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDomainNameV2

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

    • CfnDomainNameV2

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

    • CfnDomainNameV2

      @Stability(Stable) public CfnDomainNameV2(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDomainNameV2Props props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDomainNameV2

      @Stability(Stable) public CfnDomainNameV2(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDomainNameArn

      @Stability(Stable) @NotNull public String getAttrDomainNameArn()
      The ARN of the domain name.

    • getAttrDomainNameId

      @Stability(Stable) @NotNull public String getAttrDomainNameId()
      The domain name ID.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainNameV2Ref

      @Stability(Stable) @NotNull public DomainNameV2Reference getDomainNameV2Ref()
      A reference to a DomainNameV2 resource.
      Specified by:
      getDomainNameV2Ref in interface IDomainNameV2Ref

    • getCertificateArn

      @Stability(Stable) @Nullable public String getCertificateArn()
      The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.

    • setCertificateArn

      @Stability(Stable) public void setCertificateArn(@Nullable String value)
      The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.

    • getDomainName

      @Stability(Stable) @Nullable public String getDomainName()
      Represents a custom domain name as a user-friendly host name of an API (RestApi).

    • setDomainName

      @Stability(Stable) public void setDomainName(@Nullable String value)
      Represents a custom domain name as a user-friendly host name of an API (RestApi).

    • getEndpointConfiguration

      @Stability(Stable) @Nullable public 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

    • setEndpointConfiguration

      @Stability(Stable) public void setEndpointConfiguration(@Nullable IResolvable value)
      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.

    • setEndpointConfiguration

      @Stability(Stable) public void setEndpointConfiguration(@Nullable CfnDomainNameV2.EndpointConfigurationProperty value)
      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.

    • getPolicy

      @Stability(Stable) @Nullable public Object getPolicy()
      A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable Object value)
      A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration.

    • getRoutingMode

      @Stability(Stable) @Nullable public String getRoutingMode()
      The routing mode for this domain name.

    • setRoutingMode

      @Stability(Stable) public void setRoutingMode(@Nullable String value)
      The routing mode for this domain name.

    • getSecurityPolicy

      @Stability(Stable) @Nullable public String getSecurityPolicy()
      The Transport Layer Security (TLS) version + cipher suite for this DomainName.

    • setSecurityPolicy

      @Stability(Stable) public void setSecurityPolicy(@Nullable String value)
      The Transport Layer Security (TLS) version + cipher suite for this DomainName.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The collection of tags.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The collection of tags.