CfnEndpointGroup

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.globalaccelerator.CfnEndpointGroup

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.101Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnEndpointGroup(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getEndpointConfigurations()` The list of endpoint objects.
`java.lang.String`	`getEndpointGroupRegion()` The AWS Regions where the endpoint group is located.
`java.lang.Number`	`getHealthCheckIntervalSeconds()` The time—10 seconds or 30 seconds—between health checks for each endpoint.
`java.lang.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.
`java.lang.Number`	`getHealthCheckPort()` The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
`java.lang.String`	`getHealthCheckProtocol()` The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
`java.lang.String`	`getListenerArn()` The Amazon Resource Name (ARN) of the listener.
`java.lang.Object`	`getPortOverrides()` Allows you to override the destination ports used to route traffic to an endpoint.
`java.lang.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.
`java.lang.Number`	`getTrafficDialPercentage()` The percentage of traffic to send to an AWS Regions .
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setEndpointConfigurations(IResolvable value)` The list of endpoint objects.
`void`	`setEndpointConfigurations(java.util.List<java.lang.Object> value)` The list of endpoint objects.
`void`	`setEndpointGroupRegion(java.lang.String value)` The AWS Regions where the endpoint group is located.
`void`	`setHealthCheckIntervalSeconds(java.lang.Number value)` The time—10 seconds or 30 seconds—between health checks for each endpoint.
`void`	`setHealthCheckPath(java.lang.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(java.lang.Number value)` The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
`void`	`setHealthCheckProtocol(java.lang.String value)` The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
`void`	`setListenerArn(java.lang.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(java.util.List<java.lang.Object> value)` Allows you to override the destination ports used to route traffic to an endpoint.
`void`	`setThresholdCount(java.lang.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(java.lang.Number value)` The percentage of traffic to send to an AWS Regions .

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnEndpointGroup(Construct scope,
                        java.lang.String id,
                        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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrEndpointGroupArn
```
public java.lang.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
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getEndpointGroupRegion
```
public java.lang.String getEndpointGroupRegion()
```
    The AWS Regions where the endpoint group is located.
  - setEndpointGroupRegion
```
public void setEndpointGroupRegion(java.lang.String value)
```
    The AWS Regions where the endpoint group is located.
  - getListenerArn
```
public java.lang.String getListenerArn()
```
    The Amazon Resource Name (ARN) of the listener.
  - setListenerArn
```
public void setListenerArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the listener.
  - getEndpointConfigurations
```
public java.lang.Object getEndpointConfigurations()
```
    The list of endpoint objects.
  - setEndpointConfigurations
```
public void setEndpointConfigurations(IResolvable value)
```
    The list of endpoint objects.
  - setEndpointConfigurations
```
public void setEndpointConfigurations(java.util.List<java.lang.Object> value)
```
    The list of endpoint objects.
  - getHealthCheckIntervalSeconds
```
public java.lang.Number getHealthCheckIntervalSeconds()
```
    The time—10 seconds or 30 seconds—between health checks for each endpoint.
    The default value is 30.
  - setHealthCheckIntervalSeconds
```
public void setHealthCheckIntervalSeconds(java.lang.Number value)
```
    The time—10 seconds or 30 seconds—between health checks for each endpoint.
    The default value is 30.
  - getHealthCheckPath
```
public java.lang.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
```
public void setHealthCheckPath(java.lang.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
```
public java.lang.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
```
public void setHealthCheckPort(java.lang.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
```
public java.lang.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
```
public void setHealthCheckProtocol(java.lang.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
```
public java.lang.Object getPortOverrides()
```
    Allows you to override the destination ports used to route traffic to an endpoint.
    Using a port override lets you 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
```
public void setPortOverrides(IResolvable value)
```
    Allows you to override the destination ports used to route traffic to an endpoint.
    Using a port override lets you 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
```
public void setPortOverrides(java.util.List<java.lang.Object> value)
```
    Allows you to override the destination ports used to route traffic to an endpoint.
    Using a port override lets you 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
```
public java.lang.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
```
public void setThresholdCount(java.lang.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
```
public java.lang.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
```
public void setTrafficDialPercentage(java.lang.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.

Class CfnEndpointGroup

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnEndpointGroup

CfnEndpointGroup

CfnEndpointGroup

Method Detail

inspect

renderProperties

getAttrEndpointGroupArn

getCfnProperties

getEndpointGroupRegion

setEndpointGroupRegion

getListenerArn

setListenerArn

getEndpointConfigurations

setEndpointConfigurations

setEndpointConfigurations

getHealthCheckIntervalSeconds

setHealthCheckIntervalSeconds

getHealthCheckPath

setHealthCheckPath

getHealthCheckPort

setHealthCheckPort

getHealthCheckProtocol

setHealthCheckProtocol

getPortOverrides

setPortOverrides

setPortOverrides

getThresholdCount

setThresholdCount

getTrafficDialPercentage

setTrafficDialPercentage