EndpointGroup

This class encapsulates and extends the ROS resource type ALIYUN::GA::EndpointGroup, which is used to create an endpoint group.

Initializers

import com.aliyun.ros.cdk.ga.EndpointGroup;
EndpointGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .acceleratorId(java.lang.String)
    .acceleratorId(IResolvable)
    .endpointConfigurations(IResolvable)
    .endpointConfigurations(java.util.List<IResolvable)
    .endpointConfigurations(EndpointConfigurationsProperty>)
    .endpointGroupRegion(java.lang.String)
    .endpointGroupRegion(IResolvable)
    .listenerId(java.lang.String)
    .listenerId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .endpointGroupType(java.lang.String)
//  .endpointGroupType(IResolvable)
//  .endpointRequestProtocol(java.lang.String)
//  .endpointRequestProtocol(IResolvable)
//  .healthCheckEnabled(java.lang.Boolean)
//  .healthCheckEnabled(IResolvable)
//  .healthCheckIntervalSeconds(java.lang.Number)
//  .healthCheckIntervalSeconds(IResolvable)
//  .healthCheckPath(java.lang.String)
//  .healthCheckPath(IResolvable)
//  .healthCheckPort(java.lang.Number)
//  .healthCheckPort(IResolvable)
//  .healthCheckProtocol(java.lang.String)
//  .healthCheckProtocol(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .thresholdCount(java.lang.Number)
//  .thresholdCount(IResolvable)
//  .trafficPercentage(java.lang.Number)
//  .trafficPercentage(IResolvable)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`acceleratorId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.
`endpointConfigurations`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEndpointConfigurationsProperty>`	Property endpointConfigurations:.
`endpointGroupRegion`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property endpointGroupRegion: The region ID of the endpoint group.
`listenerId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property listenerId: The ID of the listener to be associated with the endpoint group.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: The description of the endpoint group.
`endpointGroupType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property endpointGroupType: The type of the endpoint group.
`endpointRequestProtocol`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property endpointRequestProtocol: The protocol used by the backend service.
`healthCheckEnabled`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property healthCheckEnabled: Specifies whether to enable the health check feature.
`healthCheckIntervalSeconds`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property healthCheckIntervalSeconds: The interval between two consecutive health checks.
`healthCheckPath`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property healthCheckPath: The path set as the destination on the targets for health checks.
`healthCheckPort`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property healthCheckPort: The port that is used to connect with the targets for health checks.
`healthCheckProtocol`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.
`name`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property name: The name of the endpoint group.
`thresholdCount`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.
`trafficPercentage`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`acceleratorId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.

`endpointConfigurations`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEndpointConfigurationsProperty>

Property endpointConfigurations:.

`endpointGroupRegion`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property endpointGroupRegion: The region ID of the endpoint group.

`listenerId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property listenerId: The ID of the listener to be associated with the endpoint group.

`description`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the endpoint group.

`endpointGroupType`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property endpointGroupType: The type of the endpoint group.

Valid values: default: The endpoint group is a default endpoint group. This is the default value. virtual: The endpoint group is a virtual endpoint group. Note Only HTTP and HTTPS listeners support virtual endpoint groups.

`endpointRequestProtocol`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property endpointRequestProtocol: The protocol used by the backend service.

Valid values: http: This is the default value. https Note: You can set this parameter only when the listener that is associated with the endpoint group uses HTTP or HTTPS. For an HTTP listener, the backend service protocol must be HTTP.

`healthCheckEnabled`^Optional

Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckEnabled: Specifies whether to enable the health check feature.

`healthCheckIntervalSeconds`^Optional

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckIntervalSeconds: The interval between two consecutive health checks.

Unit: seconds.

`healthCheckPath`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckPath: The path set as the destination on the targets for health checks.

`healthCheckPort`^Optional

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckPort: The port that is used to connect with the targets for health checks.

`healthCheckProtocol`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.

tcp: TCP protocol http: HTTP protocol https: HTTPS protocol

`name`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of the endpoint group.

`thresholdCount`^Optional

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.

Valid values: 2 to 10. Default value: 3.

`trafficPercentage`^Optional

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.ga.EndpointGroup;
EndpointGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrEndpointGroupId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointGroupId: The ID of the endpoint group.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrEndpointGroupId`^Required

public IResolvable getAttrEndpointGroupId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointGroupId: The ID of the endpoint group.

EndpointGroup

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

acceleratorIdRequired

endpointConfigurationsRequired

endpointGroupRegionRequired

listenerIdRequired

descriptionOptional

endpointGroupTypeOptional

endpointRequestProtocolOptional

healthCheckEnabledOptional

healthCheckIntervalSecondsOptional

healthCheckPathOptional

healthCheckPortOptional

healthCheckProtocolOptional

nameOptional

thresholdCountOptional

trafficPercentageOptional