Package software.amazon.awscdk.services.apigateway

Class DomainName

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.apigateway.DomainName
All Implemented Interfaces:
IConstruct, IDependable, IResource, IDomainName, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.934Z") @Stability(Stable) public class DomainName extends Resource implements IDomainName
Example: 

 Object acm;
 DomainName.Builder.create(this, "domain-name")
         .domainName("example.com")
         .certificate(acm.Certificate.fromCertificateArn(this, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"))
         .mtls(MTLSConfig.builder()
                 .bucket(new Bucket(this, "bucket"))
                 .key("truststore.pem")
                 .version("version")
                 .build())
         .build();

  • Constructor Details

    • DomainName

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

    • DomainName

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

    • DomainName

      @Stability(Stable) public DomainName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DomainNameProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromDomainNameAttributes

      @Stability(Stable) @NotNull public static IDomainName fromDomainNameAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DomainNameAttributes attrs)
      Imports an existing domain name.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • addBasePathMapping

      @Stability(Stable) @NotNull public BasePathMapping addBasePathMapping(@NotNull IRestApi targetApi, @Nullable BasePathMappingOptions options)
      Maps this domain to an API endpoint.

      Parameters:
      targetApi - That target API endpoint, requests will be mapped to the deployment stage. This parameter is required.
      options - Options for mapping to base path with or without a stage.

    • addBasePathMapping

      @Stability(Stable) @NotNull public BasePathMapping addBasePathMapping(@NotNull IRestApi targetApi)
      Maps this domain to an API endpoint.

      Parameters:
      targetApi - That target API endpoint, requests will be mapped to the deployment stage. This parameter is required.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain name (e.g. example.com).
      Specified by:
      getDomainName in interface IDomainName

    • getDomainNameAliasDomainName

      @Stability(Stable) @NotNull public String getDomainNameAliasDomainName()
      The Route53 alias target to use in order to connect a record set to this domain through an alias.
      Specified by:
      getDomainNameAliasDomainName in interface IDomainName

    • getDomainNameAliasHostedZoneId

      @Stability(Stable) @NotNull public String getDomainNameAliasHostedZoneId()
      The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
      Specified by:
      getDomainNameAliasHostedZoneId in interface IDomainName