AWS CDK Reference

Appearance

v2.275.0

HttpsRedirect L3 construct ​

Allows creating a domainA -> domainB redirect using CloudFront and S3.

You can specify multiple domains to be redirected.

Source
aws-route53-patterns/lib/website-redirect.ts

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',
  }),
});
python
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"
    )
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
new HttpsRedirect(this, "Redirect", new HttpsRedirectProps {
    RecordNames = new [] { "foo.example.com" },
    TargetDomain = "bar.example.com",
    Zone = HostedZone.FromHostedZoneAttributes(this, "HostedZone", new HostedZoneAttributes {
        HostedZoneId = "ID",
        ZoneName = "example.com"
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
patterns.NewHttpsRedirect(this, jsii.String("Redirect"), &HttpsRedirectProps{
	RecordNames: []*string{
		jsii.String("foo.example.com"),
	},
	TargetDomain: jsii.String("bar.example.com"),
	Zone: route53.HostedZone_FromHostedZoneAttributes(this, jsii.String("HostedZone"), &HostedZoneAttributes{
		HostedZoneId: jsii.String("ID"),
		ZoneName: jsii.String("example.com"),
	}),
})

Initializer ​

ts
new HttpsRedirect(scope: Construct, id: string, props: HttpsRedirectProps)
python
HttpsRedirect(scope: Construct, id: str, props: HttpsRedirectProps)
java
new HttpsRedirect(Construct scope, String id, HttpsRedirectProps props)
csharp
new HttpsRedirect(Construct scope, string id, HttpsRedirectProps props)
go
NewHttpsRedirect(Scope Construct, Id *string, Props HttpsRedirectProps)

Construct Props ​

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.

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

Properties ​

nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.

Methods ​

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining