@aws-cdk/aws-globalaccelerator

AWS::GlobalAccelerator Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. 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.

---

Introduction

AWS Global Accelerator is a service that improves the availability and performance of your applications with local or global users. It provides static IP addresses that act as a fixed entry point to your application endpoints in a single or multiple AWS Regions, such as your Application Load Balancers, Network Load Balancers or Amazon EC2 instances.

This module supports features under AWS Global Accelerator that allows users set up resources using the @aws-cdk/aws-globalaccelerator module.

Accelerator

The Accelerator resource is a Global Accelerator resource type that contains information about how you create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Application Load Balancers, Network Load Balancers, and Amazon EC2 instances.

To create the Accelerator:

import globalaccelerator = require('@aws-cdk/aws-globalaccelerator');

new globalaccelerator.Accelerator(stack, 'Accelerator');

Listener

The Listener resource is a Global Accelerator resource type that contains information about how you create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.

To create the Listener listening on TCP 80:

new globalaccelerator.Listener(stack, 'Listener', {
  accelerator,
  portRanges: [
    {
      fromPort: 80,
      toPort: 80,
    },
  ],
});

EndpointGroup

The EndpointGroup resource is a Global Accelerator resource type that contains information about how you create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region.

To create the EndpointGroup:

new globalaccelerator.EndpointGroup(stack, 'Group', { listener });

Add Endpoint into EndpointGroup

You may use the following methods to add endpoints into the EndpointGroup:

• addEndpoint to add a generic endpoint into the EndpointGroup.
• addLoadBalancer to add an Application Load Balancer or Network Load Balancer.
• addEc2Instance to add an EC2 Instance.
• addElasticIpAddress to add an Elastic IP Address.

const endpointGroup = new globalaccelerator.EndpointGroup(stack, 'Group', { listener });
const alb = new elbv2.ApplicationLoadBalancer(stack, 'ALB', { vpc, internetFacing: true  });
const nlb = new elbv2.NetworkLoadBalancer(stack, 'NLB', { vpc, internetFacing: true });
const eip = new ec2.CfnEIP(stack, 'ElasticIpAddress');
const instances = new Array<ec2.Instance>();

for ( let i = 0; i < 2; i++) {
  instances.push(new ec2.Instance(stack, `Instance${i}`, {
    vpc,
    machineImage: new ec2.AmazonLinuxImage(),
    instanceType: new ec2.InstanceType('t3.small'),
  }));
}

endpointGroup.addLoadBalancer('AlbEndpoint', alb);
endpointGroup.addLoadBalancer('NlbEndpoint', nlb);
endpointGroup.addElasticIpAddress('EipEndpoint', eip);
endpointGroup.addEc2Instance('InstanceEndpoint', instances[0]);
endpointGroup.addEndpoint('InstanceEndpoint2', instances[1].instanceId);

Changelog

1.57.0 (2020-08-07)

⚠ BREAKING CHANGES TO EXPERIMENTAL FEATURES

• apigatewayv2: The parameter for the method bind() on IHttpRouteIntegration has changed to accept one of type HttpRouteIntegrationBindOptions. The previous parameter IHttpRoute is now a property inside the new parameter under the key route.
• eks: The experimental eks.Cluster construct no longer supports setting kubectlEnabled: false. A temporary drop-in alternative is eks.LegacyCluster, but we have plans to completely remove support for it in an upcoming release since eks.Cluster has matured and should provide all the needed capabilities. Please comment on https://github.com/aws/aws-cdk/issues/9332 if there are use cases that are not supported by eks.Cluster.
• eks: endpoint access is configured to private and public by default instead of just public
• lambda.Version and apigateway.Deployment resources with auto-generated IDs will be replaced as we fixed a bug which ignored resource dependencies when generating these logical IDs.
• core: in unit tests, the node.path of constructs within stacks created the root of the tree via new Stack() will now have a prefix Default/ which represents an implicit App root.

Related: https://github.com/aws/aws-cdk-rfcs/issues/192

• cloudfront: the property OriginBase.originId has been removed

Features

• apigateway: additionalProperties in RestApi Model supports JsonSchema type (#8848) (5e087e5), closes #8069
• apigateway: configure endpoint types on SpecRestApi (#9068) (7673e48), closes #9060
• apigateway: import API keys (#9155) (e3f6ae3), closes #8367
• appsync: add x-ray parameter to AppSync (#9389) (51921ad)
• cloudfront: add support for Origin Groups (#9360) (11e146c), closes #9109
• cloudfront: Behaviors support cached methods, compression, viewer protocol, and smooth streaming (#9411) (2451fa9), closes #7086 #9107
• core: implicit app for root stacks (#9342) (1d85a9f)
• core: warn if an aspect was added via another aspect (#8639) (9d7bef7)
• eks: default masters role (#9464) (b80c271), closes #9463
• eks: deprecate "kubectlEnabled: false" (#9454) (2791017), closes #9332
• eks: endpoint access customization (#9095) (692864c), closes #5220 /github.com/aws/aws-cdk/pull/9095#issuecomment-665621701
• s3: Introduce S3 Inventory (#9102) (b0f359e)

Bug Fixes

• apigatewayv2: cyclic dependency between HttpApi and the lambda function (#9100) (7b29774), closes #9075

• athena: WorkGroup tags corruption (#9085) (b688913), closes #6936

• aws-lambda-python: use cp instead of rsync (#9355) (056bcaf), closes #9349

• cfn-include: fails to load SAM resources (#9442) (1de9dc8)

• cfn-include: no longer concatenate elements of Fn::Join without tokens (#9476) (d038b61)

• core: can't have multiple CfnRules in a Stack (#9500) (76a7bfd), closes #8251 #9485

• core: docs for CfnMapping are not clear (#9451) (c1e3c57), closes #9432

• dynamodb: allow using PhysicalName.GENERATE_IF_NEEDED as the Table name (#9377) (8ab7b10), closes #9374

• ecs: Scope-down IAM permissions for ECS drain (#9502) (9fbeec3)

• ecs: Scope-down IAM permissions on Cluster ASG (#9493) (1670289)

• ecs-patterns: Adds missing option to secure ingress of ALB in Ap… (#9434) (ba1427f)

• lambda: bundling docker image does not exist for Go runtime (#9465) (7666d9b), closes #9435

• cloudfront: remove the originId property from OriginBase (#9380) (70b9f63)

• do not use "synthesize" and "prepare" in the cdk (#9410) (e3ae645), closes /github.com/aws/aws-cdk/pull/9410#issuecomment-668552361