Package software.amazon.awscdk.services.globalaccelerator

Class CfnEndpointGroup.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.CfnEndpointGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointGroup>

Enclosing class:

CfnEndpointGroup

@Stability(Stable)
public static final class CfnEndpointGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpointGroup>

A fluent builder for CfnEndpointGroup.

Method Summary

Modifier and Type	Method	Description
CfnEndpointGroup	build()
static CfnEndpointGroup.Builder	create(software.constructs.Construct scope, String id)
CfnEndpointGroup.Builder	endpointConfigurations(List<? extends Object> endpointConfigurations)	The list of endpoint objects.
CfnEndpointGroup.Builder	endpointConfigurations(IResolvable endpointConfigurations)	The list of endpoint objects.
CfnEndpointGroup.Builder	endpointGroupRegion(String endpointGroupRegion)	The AWS Regions where the endpoint group is located.
CfnEndpointGroup.Builder	healthCheckIntervalSeconds(Number healthCheckIntervalSeconds)	The time—10 seconds or 30 seconds—between health checks for each endpoint.
CfnEndpointGroup.Builder	healthCheckPath(String healthCheckPath)	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.
CfnEndpointGroup.Builder	healthCheckPort(Number healthCheckPort)	The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
CfnEndpointGroup.Builder	healthCheckProtocol(String healthCheckProtocol)	The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
CfnEndpointGroup.Builder	listenerArn(String listenerArn)	The Amazon Resource Name (ARN) of the listener.
CfnEndpointGroup.Builder	portOverrides(List<? extends Object> portOverrides)	Allows you to override the destination ports used to route traffic to an endpoint.
CfnEndpointGroup.Builder	portOverrides(IResolvable portOverrides)	Allows you to override the destination ports used to route traffic to an endpoint.
CfnEndpointGroup.Builder	thresholdCount(Number thresholdCount)	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.
CfnEndpointGroup.Builder	trafficDialPercentage(Number trafficDialPercentage)	The percentage of traffic to send to an AWS Regions .

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEndpointGroup.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnEndpointGroup.Builder.

endpointGroupRegion

@Stability(Stable)
public CfnEndpointGroup.Builder endpointGroupRegion(String endpointGroupRegion)

The AWS Regions where the endpoint group is located.

Parameters:

endpointGroupRegion - The AWS Regions where the endpoint group is located. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointgroupregion

listenerArn

@Stability(Stable)
public CfnEndpointGroup.Builder listenerArn(String listenerArn)

The Amazon Resource Name (ARN) of the listener.

Parameters:

listenerArn - The Amazon Resource Name (ARN) of the listener. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-listenerarn

endpointConfigurations

@Stability(Stable)
public CfnEndpointGroup.Builder endpointConfigurations(IResolvable endpointConfigurations)

The list of endpoint objects.

Parameters:

endpointConfigurations - The list of endpoint objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointconfigurations

endpointConfigurations

@Stability(Stable)
public CfnEndpointGroup.Builder endpointConfigurations(List<? extends Object> endpointConfigurations)

The list of endpoint objects.

Parameters:

endpointConfigurations - The list of endpoint objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-endpointconfigurations

healthCheckIntervalSeconds

@Stability(Stable)
public CfnEndpointGroup.Builder healthCheckIntervalSeconds(Number healthCheckIntervalSeconds)

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

The default value is 30.

Default: - 30

Parameters:

healthCheckIntervalSeconds - The time—10 seconds or 30 seconds—between health checks for each endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckintervalseconds

healthCheckPath

@Stability(Stable)
public CfnEndpointGroup.Builder healthCheckPath(String healthCheckPath)

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 (/).

Default: - "/"

Parameters:

healthCheckPath - 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckpath

healthCheckPort

@Stability(Stable)
public CfnEndpointGroup.Builder healthCheckPort(Number healthCheckPort)

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.

Default: - -1

Parameters:

healthCheckPort - The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckport

healthCheckProtocol

@Stability(Stable)
public CfnEndpointGroup.Builder healthCheckProtocol(String healthCheckProtocol)

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

The default value is TCP.

Default: - "TCP"

Parameters:

healthCheckProtocol - The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-healthcheckprotocol

portOverrides

@Stability(Stable)
public CfnEndpointGroup.Builder portOverrides(IResolvable portOverrides)

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.

Parameters:

portOverrides - Allows you to override the destination ports used to route traffic to an endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-portoverrides

portOverrides

@Stability(Stable)
public CfnEndpointGroup.Builder portOverrides(List<? extends Object> portOverrides)

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.

Parameters:

portOverrides - Allows you to override the destination ports used to route traffic to an endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-portoverrides

thresholdCount

@Stability(Stable)
public CfnEndpointGroup.Builder thresholdCount(Number thresholdCount)

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.

Default: - 3

Parameters:

thresholdCount - 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-thresholdcount

trafficDialPercentage

@Stability(Stable)
public CfnEndpointGroup.Builder trafficDialPercentage(Number trafficDialPercentage)

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.

Default: - 100

Parameters:

trafficDialPercentage - The percentage of traffic to send to an AWS Regions . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-endpointgroup.html#cfn-globalaccelerator-endpointgroup-trafficdialpercentage

build

@Stability(Stable)
public CfnEndpointGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpointGroup>

Returns:

a newly built instance of CfnEndpointGroup.