Skip to content
v2.274.0

HttpsRedirectProps Struct ​

Properties to configure an HTTPS Redirect.

Example ​

ts
new patterns.HttpsRedirect(this, 'Redirect', {
  recordNames: ['foo.example.com'],
  targetDomain: 'bar.example.com',
  zone: route53.HostedZone.fromHostedZoneAttributes(this, 'HostedZone', {
    hostedZoneId: 'ID',
    zoneName: 'example.com',
  }),
});

Properties ​

certificateoptionalICertificateRefcertificateoptionalICertificateRefcertificateoptionalICertificateRefCertificateoptionalICertificateRefCertificateoptionalICertificateRef#
The AWS Certificate Manager (ACM) certificate that will be associated with the CloudFront distribution that will be created.

Default: A new certificate is created in us-east-1 (N. Virginia)

If provided, the certificate must be stored in us-east-1 (N. Virginia)

recordNamesoptionalstring[]record_namesoptionaltyping.List[str]recordNamesoptionalList<String>RecordNamesoptionalstring[]RecordNamesoptional*[]*string#
The domain names that will redirect to `targetDomain`.

Default: the domain name of the hosted zone

targetDomainstringtarget_domainstrtargetDomainStringTargetDomainstringTargetDomain*stringrequired#
The redirect target fully qualified domain name (FQDN).

An alias record will be created that points to your CloudFront distribution. Root domain or sub-domain can be supplied.

Hosted zone of the domain which will be used to create alias record(s) from domain names in the hosted zone to the target domain.
notes

The hosted zone must contain entries for the domain name(s) supplied through recordNames that will redirect to the target domain.

Domain names in the hosted zone can include a specific domain (example.com) and its subdomains (acme.example.com, zenith.example.com).