Package 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, IEndpointGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:06.709Z") @Stability(Stable) public class CfnEndpointGroup extends CfnResource implements IInspectable, IEndpointGroupRef
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
                 .attachmentArn("attachmentArn")
                 .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEndpointGroup

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

    • CfnEndpointGroup

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

    • CfnEndpointGroup

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEndpointGroupRef

      @Stability(Stable) @NotNull public EndpointGroupReference getEndpointGroupRef()
      A reference to a EndpointGroup resource.
      Specified by:
      getEndpointGroupRef in interface IEndpointGroupRef

    • getEndpointGroupRegion

      @Stability(Stable) @NotNull public String getEndpointGroupRegion()
      The AWS Regions where the endpoint group is located.

    • setEndpointGroupRegion

      @Stability(Stable) public void setEndpointGroupRegion(@NotNull String value)
      The AWS Regions where the endpoint group is located.

    • getListenerArn

      @Stability(Stable) @NotNull public String getListenerArn()
      The Amazon Resource Name (ARN) of the listener.

    • setListenerArn

      @Stability(Stable) public void setListenerArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the listener.

    • getEndpointConfigurations

      @Stability(Stable) @Nullable public Object getEndpointConfigurations()
      The list of endpoint objects.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEndpointGroup.EndpointConfigurationProperty>

    • setEndpointConfigurations

      @Stability(Stable) public void setEndpointConfigurations(@Nullable IResolvable value)
      The list of endpoint objects.

    • setEndpointConfigurations

      @Stability(Stable) public void setEndpointConfigurations(@Nullable List<Object> value)
      The list of endpoint objects.

    • getHealthCheckIntervalSeconds

      @Stability(Stable) @Nullable public Number getHealthCheckIntervalSeconds()
      The time—10 seconds or 30 seconds—between health checks for each endpoint.

    • setHealthCheckIntervalSeconds

      @Stability(Stable) public void setHealthCheckIntervalSeconds(@Nullable Number value)
      The time—10 seconds or 30 seconds—between health checks for each endpoint.

    • getHealthCheckPath

      @Stability(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.

    • setHealthCheckPath

      @Stability(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.

    • getHealthCheckPort

      @Stability(Stable) @Nullable public Number getHealthCheckPort()
      The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

    • setHealthCheckPort

      @Stability(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.

    • getHealthCheckProtocol

      @Stability(Stable) @Nullable public String getHealthCheckProtocol()
      The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

    • setHealthCheckProtocol

      @Stability(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.

    • getPortOverrides

      @Stability(Stable) @Nullable public Object getPortOverrides()
      Allows you to override the destination ports used to route traffic to an endpoint.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEndpointGroup.PortOverrideProperty>

    • setPortOverrides

      @Stability(Stable) public void setPortOverrides(@Nullable IResolvable value)
      Allows you to override the destination ports used to route traffic to an endpoint.

    • setPortOverrides

      @Stability(Stable) public void setPortOverrides(@Nullable List<Object> value)
      Allows you to override the destination ports used to route traffic to an endpoint.

    • getThresholdCount

      @Stability(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.

    • setThresholdCount

      @Stability(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.

    • getTrafficDialPercentage

      @Stability(Stable) @Nullable public Number getTrafficDialPercentage()
      The percentage of traffic to send to an AWS Regions .

    • setTrafficDialPercentage

      @Stability(Stable) public void setTrafficDialPercentage(@Nullable Number value)
      The percentage of traffic to send to an AWS Regions .