cdk-nextjs-standalone
Version:
Deploy a NextJS app to AWS using CDK and OpenNext.
153 lines (152 loc) • 7.44 kB
TypeScript
import type { aws_certificatemanager, aws_cloudfront, aws_s3 } from 'aws-cdk-lib';
/**
* OptionalDistributionProps
*/
export interface OptionalDistributionProps {
/**
* Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution.
* To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
* `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`.
* To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`.
* @default - No AWS Web Application Firewall web access control list (web ACL).
* @stability stable
*/
readonly webAclId?: string;
/**
* The SSL method CloudFront will use for your distribution.
* Server Name Indication (SNI) - is an extension to the TLS computer networking protocol by which a client indicates
* which hostname it is attempting to connect to at the start of the handshaking process. This allows a server to present
* multiple certificates on the same IP address and TCP port number and hence allows multiple secure (HTTPS) websites
* (or any other service over TLS) to be served by the same IP address without requiring all those sites to use the same certificate.
*
* CloudFront can use SNI to host multiple distributions on the same IP - which a large majority of clients will support.
*
* If your clients cannot support SNI however - CloudFront can use dedicated IPs for your distribution - but there is a prorated monthly charge for
* using this feature. By default, we use SNI - but you can optionally enable dedicated IPs (VIP).
*
* See the CloudFront SSL for more details about pricing : https://aws.amazon.com/cloudfront/custom-ssl-domains/
* @default SSLMethod.SNI
* @stability stable
*/
readonly sslSupportMethod?: aws_cloudfront.SSLMethod;
/**
* Whether to enable additional CloudWatch metrics.
* @default false
* @stability stable
*/
readonly publishAdditionalMetrics?: boolean;
/**
* The price class that corresponds with the maximum price that you want to pay for CloudFront service.
* If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.
* If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location
* that has the lowest latency among the edge locations in your price class.
* @default PriceClass.PRICE_CLASS_ALL
* @stability stable
*/
readonly priceClass?: aws_cloudfront.PriceClass;
/**
* The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.
* CloudFront serves your objects only to browsers or devices that support at
* least the SSL version that you specify.
* @default - SecurityPolicyProtocol.TLS_V1_2_2021 if the '@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021' feature flag is set; otherwise, SecurityPolicyProtocol.TLS_V1_2_2019.
* @stability stable
*/
readonly minimumProtocolVersion?: aws_cloudfront.SecurityPolicyProtocol;
/**
* Specifies whether you want CloudFront to include cookies in access logs.
* @default false
* @stability stable
*/
readonly logIncludesCookies?: boolean;
/**
* An optional string that you want CloudFront to prefix to the access log filenames for this distribution.
* @default - no prefix
* @stability stable
*/
readonly logFilePrefix?: string;
/**
* The Amazon S3 bucket to store the access logs in.
* Make sure to set `objectOwnership` to `s3.ObjectOwnership.OBJECT_WRITER` in your custom bucket.
* @default - A bucket is created if `enableLogging` is true
* @stability stable
*/
readonly logBucket?: aws_s3.IBucket;
/**
* Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.
* For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support server name identification (SNI).
* @default HttpVersion.HTTP2
* @stability stable
*/
readonly httpVersion?: aws_cloudfront.HttpVersion;
/**
* Controls the countries in which your content is distributed.
* @default - No geographic restrictions
* @stability stable
*/
readonly geoRestriction?: aws_cloudfront.GeoRestriction;
/**
* How CloudFront should handle requests that are not successful (e.g., PageNotFound).
* @default - No custom error responses.
* @stability stable
*/
readonly errorResponses?: Array<aws_cloudfront.ErrorResponse>;
/**
* Enable access logging for the distribution.
* @default - false, unless `logBucket` is specified.
* @stability stable
*/
readonly enableLogging?: boolean;
/**
* Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address.
* If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses.
* This allows viewers to submit a second request, for an IPv4 address for your distribution.
* @default true
* @stability stable
*/
readonly enableIpv6?: boolean;
/**
* Enable or disable the distribution.
* @default true
* @stability stable
*/
readonly enabled?: boolean;
/**
* Alternative domain names for this distribution.
* If you want to use your own domain name, such as www.example.com, instead of the cloudfront.net domain name,
* you can add an alternate domain name to your distribution. If you attach a certificate to the distribution,
* you must add (at least one of) the domain names of the certificate to this list.
* @default - The distribution will only support the default generated name (e.g., d111111abcdef8.cloudfront.net)
* @stability stable
*/
readonly domainNames?: Array<string>;
/**
* The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/).
* @default - no default root object
* @stability stable
*/
readonly defaultRootObject?: string;
/**
* Any comments you want to include about the distribution.
* @default - no comment
* @stability stable
*/
readonly comment?: string;
/**
* A certificate to associate with the distribution.
* The certificate must be located in N. Virginia (us-east-1).
* @default - the CloudFront wildcard certificate (*.cloudfront.net) will be used.
* @stability stable
*/
readonly certificate?: aws_certificatemanager.ICertificate;
/**
* Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to.
* @default - no additional behaviors are added.
* @stability stable
*/
readonly additionalBehaviors?: Record<string, aws_cloudfront.BehaviorOptions>;
/**
* The default behavior for the distribution.
* @stability stable
*/
readonly defaultBehavior?: aws_cloudfront.BehaviorOptions;
}