Package software.amazon.awscdk.services.apigatewayv2

Class CfnDomainName

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnDomainName
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.182Z") @Stability(Stable) public class CfnDomainName extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::DomainName.

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.*;
 Object tags;
 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")
                 .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
                 .securityPolicy("securityPolicy")
                 .build()))
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .tags(tags)
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The collection of tags associated with a domain name.

    • getDomainName

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

      Uppercase letters are not supported.

    • setDomainName

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

      Uppercase letters are not supported.

    • getDomainNameConfigurations

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

    • 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.

    • 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.