cdk-nextjs-standalone/lib/NextjsDomain.d.ts

Deploy a NextJS app to AWS using CDK and OpenNext.

import { ICertificate } from 'aws-cdk-lib/aws-certificatemanager';
import { Distribution } from 'aws-cdk-lib/aws-cloudfront';
import { IHostedZone } from 'aws-cdk-lib/aws-route53';
import { Construct } from 'constructs';
import { OptionalAaaaRecordProps, OptionalCertificateProps, OptionalHostedZoneProviderProps, OptionalARecordProps } from './generated-structs';
export interface NextjsDomainOverrides {
    readonly certificateProps?: OptionalCertificateProps;
    readonly hostedZoneProviderProps?: OptionalHostedZoneProviderProps;
    readonly aRecordProps?: OptionalARecordProps;
    readonly aaaaRecordProps?: OptionalAaaaRecordProps;
}
export interface NextjsDomainProps {
    /**
     * An easy to remember address of your website. Only supports domains hosted
     * on [Route 53](https://aws.amazon.com/route53/). Used as `domainName` for
     * ACM `Certificate` if {@link NextjsDomainProps.certificate} and
     * {@link NextjsDomainProps.certificateDomainName} are `undefined`.
     * @example "example.com"
     */
    readonly domainName: string;
    /**
     * Alternate domain names that should route to the Cloudfront Distribution.
     * For example, if you specificied `"example.com"` as your {@link NextjsDomainProps.domainName},
     * you could specify `["www.example.com", "api.example.com"]`.
     * Learn more about the [requirements](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-requirements)
     * and [restrictions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-restrictions)
     * for using alternate domain names with CloudFront.
     *
     * Note, in order to use alternate domain names, they must be covered by your
     * certificate. By default, the certificate created in this construct only covers
     * the {@link NextjsDomainProps.domainName}. Therefore, you'll need to specify
     * a wildcard domain name like `"*.example.com"` with {@link NextjsDomainProps.certificateDomainName}
     * so that this construct will create the certificate the covers the alternate
     * domain names. Otherwise, you can use {@link NextjsDomainProps.certificate}
     * to create the certificate yourself where you'll need to ensure it has a
     * wildcard or uses subject alternative names including the
     * alternative names specified here.
     * @example ["www.example.com", "api.example.com"]
     */
    readonly alternateNames?: string[];
    /**
     * You must create the hosted zone out-of-band.
     * You can lookup the hosted zone outside this construct and pass it in via this prop.
     * Alternatively if this prop is `undefined`, then the hosted zone will be
     * **looked up** (not created) via `HostedZone.fromLookup` with {@link NextjsDomainProps.domainName}.
     */
    readonly hostedZone?: IHostedZone;
    /**
     * If this prop is `undefined` then an ACM `Certificate` will be created based on {@link NextjsDomainProps.domainName}
     * with DNS Validation. This prop allows you to control the TLS/SSL
     * certificate created. The certificate you create must be in the `us-east-1`
     * (N. Virginia) region as required by AWS CloudFront.
     *
     * Set this option if you have an existing certificate in the `us-east-1` region in AWS Certificate Manager you want to use.
     */
    readonly certificate?: ICertificate;
    /**
     * The domain name used in this construct when creating an ACM `Certificate`. Useful
     * when passing {@link NextjsDomainProps.alternateNames} and you need to specify
     * a wildcard domain like "*.example.com". If `undefined`, then {@link NextjsDomainProps.domainName}
     * will be used.
     *
     * If {@link NextjsDomainProps.certificate} is passed, then this prop is ignored.
     */
    readonly certificateDomainName?: string;
    /**
     * Override props for every construct.
     */
    readonly overrides?: NextjsDomainOverrides;
}
/**
 * Use a custom domain with `Nextjs`. Requires a Route53 hosted zone to have been
 * created within the same AWS account. For DNS setups where you cannot use a
 * Route53 hosted zone in the same AWS account, use the `overrides.nextjsDistribution.distributionProps`
 * prop of {@link NextjsProps}.
 *
 * See {@link NextjsDomainProps} TS Doc comments for detailed docs on how to customize.
 * This construct is helpful to user to not have to worry about interdependencies
 * between Route53 Hosted Zone, CloudFront Distribution, and Route53 Hosted Zone Records.
 *
 * Note, if you're using another service for domain name registration, you can
 * still create a Route53 hosted zone. Please see [Configuring DNS Delegation from
 * CloudFlare to AWS Route53](https://veducate.co.uk/dns-delegation-route53/)
 * as an example.
 */
export declare class NextjsDomain extends Construct {
    /**
     * Concatentation of {@link NextjsDomainProps.domainName} and {@link NextjsDomainProps.alternateNames}.
     * Used in instantiation of CloudFront Distribution in NextjsDistribution
     */
    get domainNames(): string[];
    /**
     * Route53 Hosted Zone.
     */
    hostedZone: IHostedZone;
    /**
     * ACM Certificate.
     */
    certificate: ICertificate;
    private props;
    constructor(scope: Construct, id: string, props: NextjsDomainProps);
    private getHostedZone;
    private getCertificate;
    /**
     * Creates DNS records (A and AAAA) records for {@link NextjsDomainProps.domainName}
     * and {@link NextjsDomainProps.alternateNames} if defined.
     */
    createDnsRecords(distribution: Distribution): void;
}