@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:48.101Z") public class CfnEndpointGroup extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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 .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEndpointGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEndpointGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEndpointGroup(Construct scope, java.lang.String id, CfnEndpointGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrEndpointGroupArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getEndpointGroupRegion()
public void setEndpointGroupRegion(java.lang.String value)
public java.lang.String getListenerArn()
public void setListenerArn(java.lang.String value)
public java.lang.Object getEndpointConfigurations()
public void setEndpointConfigurations(IResolvable value)
public void setEndpointConfigurations(java.util.List<java.lang.Object> value)
public java.lang.Number getHealthCheckIntervalSeconds()
The default value is 30.
public void setHealthCheckIntervalSeconds(java.lang.Number value)
The default value is 30.
public java.lang.String getHealthCheckPath()
The default is slash (/).
public void setHealthCheckPath(java.lang.String value)
The default is slash (/).
public java.lang.Number getHealthCheckPort()
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.
public void setHealthCheckPort(java.lang.Number value)
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.
public java.lang.String getHealthCheckProtocol()
The default value is TCP.
public void setHealthCheckProtocol(java.lang.String value)
The default value is TCP.
public java.lang.Object getPortOverrides()
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.
public void setPortOverrides(IResolvable value)
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.
public void setPortOverrides(java.util.List<java.lang.Object> value)
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.
public java.lang.Number getThresholdCount()
The default value is 3.
public void setThresholdCount(java.lang.Number value)
The default value is 3.
public java.lang.Number getTrafficDialPercentage()
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.
public void setTrafficDialPercentage(java.lang.Number value)
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.