Package software.amazon.awscdk.services.route53.patterns

Interface HttpsRedirectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpsRedirectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:57.479Z")
@Stability(Stable)
public interface HttpsRedirectProps
extends software.amazon.jsii.JsiiSerializable

Properties to configure an HTTPS Redirect.

Example:

 HttpsRedirect.Builder.create(this, "Redirect")
         .recordNames(List.of("foo.example.com"))
         .targetDomain("bar.example.com")
         .zone(HostedZone.fromHostedZoneAttributes(this, "HostedZone", HostedZoneAttributes.builder()
                 .hostedZoneId("ID")
                 .zoneName("example.com")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpsRedirectProps.Builder	A builder for HttpsRedirectProps
static final class	HttpsRedirectProps.Jsii$Proxy	An implementation for HttpsRedirectProps

Method Summary

Modifier and Type	Method	Description
static HttpsRedirectProps.Builder	builder()
default ICertificate	getCertificate()	The AWS Certificate Manager (ACM) certificate that will be associated with the CloudFront distribution that will be created.
default List<String>	getRecordNames()	The domain names that will redirect to targetDomain.
String	getTargetDomain()	The redirect target fully qualified domain name (FQDN).
IHostedZone	getZone()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetDomain

@Stability(Stable)
@NotNull
String getTargetDomain()

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.

getZone

@Stability(Stable)
@NotNull
IHostedZone getZone()

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

getCertificate

@Stability(Stable)
@Nullable
default ICertificate getCertificate()

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)

getRecordNames

@Stability(Stable)
@Nullable
default List<String> getRecordNames()

The domain names that will redirect to targetDomain.

Default: - the domain name of the hosted zone

builder

@Stability(Stable)
static HttpsRedirectProps.Builder builder()

Returns:

a HttpsRedirectProps.Builder of HttpsRedirectProps