HttpsRedirectProps

class aws_cdk.aws_route53_patterns.HttpsRedirectProps(*, target_domain, zone, certificate=None, record_names=None)

Bases: object

Properties to configure an HTTPS Redirect.

Parameters:

target_domain (str) – 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.
zone (IHostedZone) – 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. 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).
certificate (Optional[ICertificate]) – The AWS Certificate Manager (ACM) certificate that will be associated with the CloudFront distribution that will be created. If provided, the certificate must be stored in us-east-1 (N. Virginia) Default: - A new certificate is created in us-east-1 (N. Virginia)
record_names (Optional[Sequence[str]]) – The domain names that will redirect to targetDomain. Default: - the domain name of the hosted zone

ExampleMetadata:

infused

Example:

patterns.HttpsRedirect(self, "Redirect",
    record_names=["foo.example.com"],
    target_domain="bar.example.com",
    zone=route53.HostedZone.from_hosted_zone_attributes(self, "HostedZone",
        hosted_zone_id="ID",
        zone_name="example.com"
    )
)

Attributes

certificate

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

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

Default:

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

record_names

The domain names that will redirect to targetDomain.

Default:

the domain name of the hosted zone

target_domain

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.

zone

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.

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).