software.amazon.awscdk.services.globalaccelerator

Class CfnEndpointGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.globalaccelerator.CfnEndpointGroup

All Implemented Interfaces:

IInspectable, 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.509Z")
 @Stability(value=Stable)
public class CfnEndpointGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GlobalAccelerator::EndpointGroup`.

The AWS::GlobalAccelerator::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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.globalaccelerator.*;
 CfnEndpointGroup cfnEndpointGroup = CfnEndpointGroup.Builder.create(this, "MyCfnEndpointGroup")
         .endpointGroupRegion("endpointGroupRegion")
         .listenerArn("listenerArn")
         // the properties below are optional
         .endpointConfigurations(List.of(EndpointConfigurationProperty.builder()
                 .endpointId("endpointId")
                 // the properties below are optional
                 .clientIpPreservationEnabled(false)
                 .weight(123)
                 .build()))
         .healthCheckIntervalSeconds(123)
         .healthCheckPath("healthCheckPath")
         .healthCheckPort(123)
         .healthCheckProtocol("healthCheckProtocol")
         .portOverrides(List.of(PortOverrideProperty.builder()
                 .endpointPort(123)
                 .listenerPort(123)
                 .build()))
         .thresholdCount(123)
         .trafficDialPercentage(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEndpointGroup.Builder A fluent builder for CfnEndpointGroup.
static interface	CfnEndpointGroup.EndpointConfigurationProperty A complex type for endpoints.
static interface	CfnEndpointGroup.PortOverrideProperty Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpointGroup(software.constructs.Construct scope, String id, CfnEndpointGroupProps props) Create a new `AWS::GlobalAccelerator::EndpointGroup`.
protected	CfnEndpointGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrEndpointGroupArn() The ARN of the endpoint group, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu` .
protected Map<String,Object>	getCfnProperties()
Object	getEndpointConfigurations() The list of endpoint objects.
String	getEndpointGroupRegion() The AWS Regions where the endpoint group is located.
Number	getHealthCheckIntervalSeconds() The time—10 seconds or 30 seconds—between health checks for each endpoint.
String	getHealthCheckPath() If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.
Number	getHealthCheckPort() The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
String	getHealthCheckProtocol() The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
String	getListenerArn() The Amazon Resource Name (ARN) of the listener.
Object	getPortOverrides() Allows you to override the destination ports used to route traffic to an endpoint.
Number	getThresholdCount() The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.
Number	getTrafficDialPercentage() The percentage of traffic to send to an AWS Regions .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEndpointConfigurations(IResolvable value) The list of endpoint objects.
void	setEndpointConfigurations(List<Object> value) The list of endpoint objects.
void	setEndpointGroupRegion(String value) The AWS Regions where the endpoint group is located.
void	setHealthCheckIntervalSeconds(Number value) The time—10 seconds or 30 seconds—between health checks for each endpoint.
void	setHealthCheckPath(String value) If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.
void	setHealthCheckPort(Number value) The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
void	setHealthCheckProtocol(String value) The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
void	setListenerArn(String value) The Amazon Resource Name (ARN) of the listener.
void	setPortOverrides(IResolvable value) Allows you to override the destination ports used to route traffic to an endpoint.
void	setPortOverrides(List<Object> value) Allows you to override the destination ports used to route traffic to an endpoint.
void	setThresholdCount(Number value) The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.
void	setTrafficDialPercentage(Number value) The percentage of traffic to send to an AWS Regions .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpointGroup

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

CfnEndpointGroup

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

CfnEndpointGroup

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

Create a new `AWS::GlobalAccelerator::EndpointGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpointGroupArn

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

The ARN of the endpoint group, such as `arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEndpointGroupRegion

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

The AWS Regions where the endpoint group is located.

setEndpointGroupRegion

@Stability(value=Stable)
public void setEndpointGroupRegion(@NotNull
                                                            String value)

The AWS Regions where the endpoint group is located.

getListenerArn

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

The Amazon Resource Name (ARN) of the listener.

setListenerArn

@Stability(value=Stable)
public void setListenerArn(@NotNull
                                                    String value)

The Amazon Resource Name (ARN) of the listener.

getEndpointConfigurations

@Stability(value=Stable)
 @Nullable
public Object getEndpointConfigurations()

The list of endpoint objects.

setEndpointConfigurations

@Stability(value=Stable)
public void setEndpointConfigurations(@Nullable
                                                               IResolvable value)

The list of endpoint objects.

setEndpointConfigurations

@Stability(value=Stable)
public void setEndpointConfigurations(@Nullable
                                                               List<Object> value)

The list of endpoint objects.

getHealthCheckIntervalSeconds

@Stability(value=Stable)
 @Nullable
public Number getHealthCheckIntervalSeconds()

The time—10 seconds or 30 seconds—between health checks for each endpoint.

The default value is 30.

setHealthCheckIntervalSeconds

@Stability(value=Stable)
public void setHealthCheckIntervalSeconds(@Nullable
                                                                   Number value)

The time—10 seconds or 30 seconds—between health checks for each endpoint.

The default value is 30.

getHealthCheckPath

@Stability(value=Stable)
 @Nullable
public String getHealthCheckPath()

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.

The default is slash (/).

setHealthCheckPath

@Stability(value=Stable)
public void setHealthCheckPath(@Nullable
                                                        String value)

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks.

The default is slash (/).

getHealthCheckPort

@Stability(value=Stable)
 @Nullable
public Number getHealthCheckPort()

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

setHealthCheckPort

@Stability(value=Stable)
public void setHealthCheckPort(@Nullable
                                                        Number value)

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

getHealthCheckProtocol

@Stability(value=Stable)
 @Nullable
public String getHealthCheckProtocol()

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default value is TCP.

setHealthCheckProtocol

@Stability(value=Stable)
public void setHealthCheckProtocol(@Nullable
                                                            String value)

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default value is TCP.

getPortOverrides

@Stability(value=Stable)
 @Nullable
public Object getPortOverrides()

Allows you to override the destination ports used to route traffic to an endpoint.

Using a port override lets you to map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

setPortOverrides

@Stability(value=Stable)
public void setPortOverrides(@Nullable
                                                      IResolvable value)

Allows you to override the destination ports used to route traffic to an endpoint.

Using a port override lets you to map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

setPortOverrides

@Stability(value=Stable)
public void setPortOverrides(@Nullable
                                                      List<Object> value)

Allows you to override the destination ports used to route traffic to an endpoint.

Using a port override lets you to map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

getThresholdCount

@Stability(value=Stable)
 @Nullable
public Number getThresholdCount()

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

The default value is 3.

setThresholdCount

@Stability(value=Stable)
public void setThresholdCount(@Nullable
                                                       Number value)

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy.

The default value is 3.

getTrafficDialPercentage

@Stability(value=Stable)
 @Nullable
public Number getTrafficDialPercentage()

The percentage of traffic to send to an AWS Regions .

Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

setTrafficDialPercentage

@Stability(value=Stable)
public void setTrafficDialPercentage(@Nullable
                                                              Number value)

The percentage of traffic to send to an AWS Regions .

Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.