software.amazon.awscdk.services.globalaccelerator

Class Accelerator

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.globalaccelerator.Accelerator

All Implemented Interfaces:

IResource, IAccelerator, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.498Z")
 @Stability(value=Stable)
public class Accelerator
extends Resource
implements IAccelerator

The Accelerator construct.

Example:

 // Create an Accelerator
 Accelerator accelerator = new Accelerator(this, "Accelerator");
 // Create a Listener
 Listener listener = accelerator.addListener("Listener", ListenerOptions.builder()
         .portRanges(List.of(PortRange.builder().fromPort(80).build(), PortRange.builder().fromPort(443).build()))
         .build());
 // Import the Load Balancers
 INetworkLoadBalancer nlb1 = NetworkLoadBalancer.fromNetworkLoadBalancerAttributes(this, "NLB1", NetworkLoadBalancerAttributes.builder()
         .loadBalancerArn("arn:aws:elasticloadbalancing:us-west-2:111111111111:loadbalancer/app/my-load-balancer1/e16bef66805b")
         .build());
 INetworkLoadBalancer nlb2 = NetworkLoadBalancer.fromNetworkLoadBalancerAttributes(this, "NLB2", NetworkLoadBalancerAttributes.builder()
         .loadBalancerArn("arn:aws:elasticloadbalancing:ap-south-1:111111111111:loadbalancer/app/my-load-balancer2/5513dc2ea8a1")
         .build());
 // Add one EndpointGroup for each Region we are targeting
 listener.addEndpointGroup("Group1", EndpointGroupOptions.builder()
         .endpoints(List.of(new NetworkLoadBalancerEndpoint(nlb1)))
         .build());
 listener.addEndpointGroup("Group2", EndpointGroupOptions.builder()
         // Imported load balancers automatically calculate their Region from the ARN.
         // If you are load balancing to other resources, you must also pass a `region`
         // parameter here.
         .endpoints(List.of(new NetworkLoadBalancerEndpoint(nlb2)))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Accelerator.Builder A fluent builder for Accelerator.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.globalaccelerator.IAccelerator

IAccelerator.Jsii$Default, IAccelerator.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Accelerator(software.constructs.Construct scope, String id)
	Accelerator(software.constructs.Construct scope, String id, AcceleratorProps props)
protected	Accelerator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Accelerator(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Listener	addListener(String id, ListenerOptions options) Add a listener to the accelerator.
static IAccelerator	fromAcceleratorAttributes(software.constructs.Construct scope, String id, AcceleratorAttributes attrs) import from attributes.
String	getAcceleratorArn() The ARN of the accelerator.
String	getDnsName() The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Accelerator

protected Accelerator(software.amazon.jsii.JsiiObjectRef objRef)

Accelerator

protected Accelerator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Accelerator

@Stability(value=Stable)
public Accelerator(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            AcceleratorProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Accelerator

@Stability(value=Stable)
public Accelerator(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromAcceleratorAttributes

@Stability(value=Stable)
 @NotNull
public static IAccelerator fromAcceleratorAttributes(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        AcceleratorAttributes attrs)

import from attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addListener

@Stability(value=Stable)
 @NotNull
public Listener addListener(@NotNull
                                                               String id,
                                                               @NotNull
                                                               ListenerOptions options)

Add a listener to the accelerator.

Parameters:

id - This parameter is required.

options - This parameter is required.

getAcceleratorArn

@Stability(value=Stable)
 @NotNull
public String getAcceleratorArn()

The ARN of the accelerator.

Specified by:

getAcceleratorArn in interface IAccelerator

getDnsName

@Stability(value=Stable)
 @NotNull
public String getDnsName()

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

Specified by:

getDnsName in interface IAccelerator