Package software.amazon.awscdk.services.apigatewayv2

Class CfnDomainName

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.apigatewayv2.CfnDomainName
All Implemented Interfaces:
IInspectable, IDomainNameRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:13.470Z") @Stability(Stable) public class CfnDomainName extends CfnResource implements IInspectable, IDomainNameRef, ITaggable
The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

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.services.apigatewayv2.*;
 CfnDomainName cfnDomainName = CfnDomainName.Builder.create(this, "MyCfnDomainName")
         .domainName("domainName")
         // the properties below are optional
         .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:

  • 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

    • CfnDomainName

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

    • CfnDomainName

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

    • CfnDomainName

      @Stability(Stable) public CfnDomainName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDomainNameProps props)
      Create a new AWS::ApiGatewayV2::DomainName.

      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. This parameter is required.

  • Method Details

    • arnForDomainName

      @Stability(Stable) @NotNull public static String arnForDomainName(@NotNull IDomainNameRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDomainName

      @Stability(Stable) @NotNull public static Boolean isCfnDomainName(@NotNull Object x)
      Checks whether the given object is a CfnDomainName.

      Parameters:
      x - This parameter is required.

    • 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()
      Represents an Amazon Resource Name (ARN).

    • getAttrRegionalDomainName

      @Stability(Stable) @NotNull public String getAttrRegionalDomainName()
      The domain name associated with the regional endpoint for this custom domain name.

      You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

    • getAttrRegionalHostedZoneId

      @Stability(Stable) @NotNull public String getAttrRegionalHostedZoneId()
      The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

    • getCfnProperties

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

    • getDomainNameRef

      @Stability(Stable) @NotNull public DomainNameReference getDomainNameRef()
      A reference to a DomainName resource.
      Specified by:
      getDomainNameRef in interface IDomainNameRef

    • getTags

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

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The custom domain name for your API in Amazon API Gateway.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The custom domain name for your API in Amazon API Gateway.

    • getDomainNameConfigurations

      @Stability(Stable) @Nullable public Object getDomainNameConfigurations()
      The domain name configurations.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomainName.DomainNameConfigurationProperty>

    • setDomainNameConfigurations

      @Stability(Stable) public void setDomainNameConfigurations(@Nullable IResolvable value)
      The domain name configurations.

    • setDomainNameConfigurations

      @Stability(Stable) public void setDomainNameConfigurations(@Nullable List<Object> value)
      The domain name configurations.

    • getMutualTlsAuthentication

      @Stability(Stable) @Nullable public Object getMutualTlsAuthentication()
      The mutual TLS authentication configuration for a custom domain name.

      Returns union: either IResolvable or CfnDomainName.MutualTlsAuthenticationProperty

    • setMutualTlsAuthentication

      @Stability(Stable) public void setMutualTlsAuthentication(@Nullable IResolvable value)
      The mutual TLS authentication configuration for a custom domain name.

    • setMutualTlsAuthentication

      @Stability(Stable) public void setMutualTlsAuthentication(@Nullable CfnDomainName.MutualTlsAuthenticationProperty value)
      The mutual TLS authentication configuration for a custom domain name.

    • getRoutingMode

      @Stability(Stable) @Nullable public String getRoutingMode()
      The routing mode API Gateway uses to route traffic to your APIs.

    • setRoutingMode

      @Stability(Stable) public void setRoutingMode(@Nullable String value)
      The routing mode API Gateway uses to route traffic to your APIs.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The collection of tags associated with a domain name.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The collection of tags associated with a domain name.