software.amazon.awscdk.services.route53.patterns

Class HttpsRedirect.Builder

java.lang.Object

software.amazon.awscdk.services.route53.patterns.HttpsRedirect.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpsRedirect>

Enclosing class:

HttpsRedirect

@Stability(value=Stable)
public static final class HttpsRedirect.Builder
extends Object
implements software.amazon.jsii.Builder<HttpsRedirect>

A fluent builder for HttpsRedirect.

Method Summary

Modifier and Type	Method and Description
HttpsRedirect	build()
HttpsRedirect.Builder	certificate(ICertificate certificate) The AWS Certificate Manager (ACM) certificate that will be associated with the CloudFront distribution that will be created.
static HttpsRedirect.Builder	create(software.constructs.Construct scope, String id)
HttpsRedirect.Builder	recordNames(List<String> recordNames) The domain names that will redirect to `targetDomain`.
HttpsRedirect.Builder	targetDomain(String targetDomain) The redirect target fully qualified domain name (FQDN).
HttpsRedirect.Builder	zone(IHostedZone 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static HttpsRedirect.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HttpsRedirect.Builder.

targetDomain

@Stability(value=Stable)
public HttpsRedirect.Builder targetDomain(String targetDomain)

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.

Parameters:

targetDomain - The redirect target fully qualified domain name (FQDN). This parameter is required.

Returns:

this

zone

@Stability(value=Stable)
public HttpsRedirect.Builder zone(IHostedZone 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).

Parameters:

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. This parameter is required.

Returns:

this

certificate

@Stability(value=Stable)
public HttpsRedirect.Builder certificate(ICertificate 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)

Parameters:

certificate - The AWS Certificate Manager (ACM) certificate that will be associated with the CloudFront distribution that will be created. This parameter is required.

Returns:

this

recordNames

@Stability(value=Stable)
public HttpsRedirect.Builder recordNames(List<String> recordNames)

The domain names that will redirect to `targetDomain`.

Default: - the domain name of the hosted zone

Parameters:

recordNames - The domain names that will redirect to `targetDomain`. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public HttpsRedirect build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpsRedirect>