@alma-cdk/domain

中文文档
0.0.14发布于 2022/11/08Apache-2.0TypeScriptCommonJS零依赖近 30 天下载 1727

Domain with certificate

原始使用文档
文档目录3 节
  1. 🚧 Project Stability
  2. Getting Started
  3. CloudFront helper


Alma CDK Domain

npm i -D @alma-cdk/domain

Simplifies creation of subdomain with a TLS certificate and configuration with services like AWS CloudFront.



🚧   Project Stability

experimental

This construct is still versioned with v0 major version and breaking changes might be introduced if necessary (without a major version bump), though we aim to keep the API as stable as possible (even within v0 development). We aim to publish v1.0.0 soon and after that breaking changes will be introduced via major version bumps.


Getting Started

import { Domain } from '@alma-cdk/domain';
import * as cloudfront from 'aws-cdk-lib/aws-cloudfront';
const domain = new Domain(this, 'Domain', {
  zone: 'example.com', // retrieve the zone via lookup, or provide IHostedZone
  subdomain: 'foobar', // optional subdomain
});

const distribution = new cloudfront.Distribution(this, 'Distribution', {
  /* other cloudfront configuration values removed for brevity */

  certificate: domain.certificate, // reference to created ICertificate
  domainNames: [domain.fqdn], // foobar.example.com
  enableIpv6: domain.enableIpv6, // true by default – set enableIpv6 prop to false during new Domain()
})

// assign CloudFront distribution to given fqdn with A + AAAA records
domain.addTarget(new targets.CloudFrontTarget(distribution))

CloudFront helper

Instead of assigning certificate, domainNames and enableIpv6 properties individually, you may choose to use the one-liner helper utility method configureCloudFront() to set all three values at once – don't forget to use ... object spread syntax:

const distribution = new cloudfront.Distribution(this, 'Distribution', {
  /* other cloudfront configuration values removed for brevity */

  // one-liner to configure certificate, domainNames and IPv6 support
  ...domain.configureCloudFront(),
})

// assign CloudFront distribution to given fqdn with A + AAAA records
domain.addTarget(new targets.CloudFrontTarget(distribution))

Note: The returned domain names configuration is domainNames: [domain.fqdn], meaning this only works in scenarios where your CloudFront distribution has only single domain name.

版本与发布记录

@alma-cdk/domain 共发布 7 个版本,首次发布于 2022/10/18;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.14latest2022/11/084 年前
0.0.132022/11/084 年前
0.0.122022/11/084 年前
0.0.112022/11/084 年前
0.0.102022/10/194 年前
0.0.92022/10/194 年前

关于 @alma-cdk/domain 的常见问题

@alma-cdk/domain 是什么?

Domain with certificate

如何安装 @alma-cdk/domain?

在项目目录运行 npm install @alma-cdk/domain,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:aws-cdk-lib(^2.24.1)、constructs(^10.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@alma-cdk/domain 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@alma-cdk/domain 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@alma-cdk/domain 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 14.17.6。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@alma-cdk/domain 可以商用吗?

@alma-cdk/domain 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@alma-cdk/domain 的下载量有多少?

根据 npm 官方下载统计,@alma-cdk/domain 在 2026/10/06 – 2026/11/04 这 30 天内被下载 1,727 次,日均约 58 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@alma-cdk/domain 还在维护吗?

最新版本 0.0.14 发布于 2022/11/08(4 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/10/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。