Package: aws-solutions-constructs.aws-route53-alb
aws-route53-alb module---All classes are under active development and subject to non-backward compatible changes or removal in any
future version. These are not subject to theSemantic Versioningmodel.
This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_route53_albTypescript@aws-solutions-constructs/aws-route53-albJavasoftware.amazon.awsconstructs.services.route53albOverviewThis AWS Solutions Construct implements an Amazon Route53 Hosted Zone routing to an Application Load BalancerHere is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{Route53ToAlb}from'@aws-solutions-constructs/aws-route53-alb';//Note-allalbconstructsturnonELBloggingbydefault,sorequirethatanenvironmentincludingaccount//andregionbeprovidedwhencreatingthestack////newMyStack(app,'id',{env:{account:'123456789012',region:'us-east-1'}});newRoute53ToAlb(this,'Route53ToAlbPattern',{privateHostedZoneProps:{zoneName:'www.example.com',},publicApi:false,});Pythonfromaws_solutions_constructs.aws_route53_albimportRoute53ToAlbfromaws_cdkimport(aws_route53asroute53,Stack)fromconstructsimportConstruct# Note - all alb constructs turn on ELB logging by default, so require that an environment including account# and region be provided when creating the stack## MyStack(app, 'id', env=cdk.Environment(account='123456789012', region='us-east-1'))Route53ToAlb(self,'Route53ToAlbPattern',public_api=False,private_hosted_zone_props=route53.HostedZoneProps(zone_name='www.example.com',))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.route53.*;importsoftware.amazon.awsconstructs.services.route53alb.*;// Note - all alb constructs turn on ELB logging by default, so require that an environment including account// and region be provided when creating the stack//// new MyStack(app, "id", StackProps.builder()//         .env(Environment.builder()//                 .account("123456789012")//                 .region("us-east-1")//                 .build());newRoute53ToAlb(this,"Route53ToAlbPattern",newRoute53ToAlbProps.Builder().privateHostedZoneProps(newHostedZoneProps.Builder().zoneName("www.example.com").build()).publicApi(false).build());Pattern Construct PropsThis construct cannot create a new Public Hosted Zone, if you are creating a public API you must supply an existing Public Hosted Zone that will be reconfigured with a new Alias record. Public Hosted Zones are configured with public domain names and are not well suited to be launched and torn down dynamically, so this construct will only reconfigure existing Public Hosted Zones.This construct can create Private Hosted Zones. If you want a Private Hosted Zone, then you can either provide an existing Private Hosted Zone or a privateHostedZoneProps value with at least the Domain Name defined.NameTypeDescriptionprivateHostedZoneProps?route53.PrivateHostedZonePropsOptional custom properties for a new Private Hosted Zone. Cannot be specified for a public API. Cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct. Providing both this and existingHostedZoneInterfaceis an error.existingHostedZoneInterface?route53.IHostedZoneExisting Public or Private Hosted Zone (type must match publicApi setting). Specifying both this and privateHostedZoneProps is an error. If this is a Private Hosted Zone, the associated VPC must be provided as the existingVpc propertyloadBalancerProps?elasticloadbalancingv2.ApplicationLoadBalancerPropsOptional custom properties for a new loadBalancer. Providing both this and existingLoadBalancer is an error. This cannot specify a VPC, it will use the VPC in existingVpc or the VPC created by the construct.existingLoadBalancerObj?elasticloadbalancingv2.ApplicationLoadBalancerExisting Application Load Balancer to incorporate into the construct architecture. Providing both this and loadBalancerProps is an error. The VPC containing this loadBalancer must match the VPC provided in existingVpc.vpcProps?ec2.VpcPropsOptional custom properties for a VPC the construct will create. This VPC will be used by the new ALB and any Private Hosted Zone the construct creates (that's why loadBalancerProps and privateHostedZoneProps can't include a VPC). Providing both this and existingVpc is an error.existingVpc?ec2.IVpcAn existing VPC in which to deploy the construct. Providing both this and vpcProps is an error. If the client provides an existing load balancer and/or existing Private Hosted Zone, those constructs must exist in this VPC.logAlbAccessLogs?booleanWhether to turn on Access Logs for the Application Load Balancer. Uses an S3 bucket with associated storage costs.Enabling Access Logging is a best practice. default - truealbLoggingBucketProps?s3.BucketPropsOptional properties to customize the bucket used to store the ALB Access Logs. Supplying this and setting logAlbAccessLogs to false is an error. @default - none| publicApi | boolean | Whether the construct is deploying a private or public API. This has implications for the Hosted Zone, VPC and ALB. |Pattern PropertiesNameTypeDescriptionhostedZoneroute53.IHostedZoneThe hosted zone used by the construct (whether created by the construct or providedb by the client)vpcec2.IVpcThe VPC used by the construct (whether created by the construct or providedb by the client)loadBalancerelasticloadbalancingv2.ApplicationLoadBalancerThe Load Balancer used by the construct (whether created by the construct or providedb by the client)Default settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon Route53Adds an ALIAS record to the new or provided Hosted Zone that routes to the construct's ALBApplication Load BalancerCreates an Application Load Balancer with no Listener or target. The construct can incorporate an existing, fully configured ALB if provided.Architecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.