Skip to content

BasicEndpointGroup

This class encapsulates and extends the ROS resource type ALIYUN::GA::BasicEndpointGroup.

Initializers

import com.aliyun.ros.cdk.ga.BasicEndpointGroup;
BasicEndpointGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .acceleratorId(java.lang.String)
    .acceleratorId(IResolvable)
    .endpointGroupRegion(java.lang.String)
    .endpointGroupRegion(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .endpointAddress(java.lang.String)
//  .endpointAddress(IResolvable)
//  .endpointSubAddress(java.lang.String)
//  .endpointSubAddress(IResolvable)
//  .endpointType(java.lang.String)
//  .endpointType(IResolvable)
//  .name(java.lang.String)
//  .name(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 basic GA instance.
endpointGroupRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointGroupRegion: The ID of the region to which the endpoint group belongs.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the endpoint group.
endpointAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointAddress: The endpoint address.
endpointSubAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointSubAddress: The secondary address of the endpoint.
endpointType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointType: The type of the endpoint.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the endpoint group.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

acceleratorIdRequired

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

Property acceleratorId: The ID of the basic GA instance.


endpointGroupRegionRequired

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

Property endpointGroupRegion: The ID of the region to which the endpoint group belongs.


descriptionOptional

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

Property description: The description of the endpoint group.

The description can be up to 200 characters in length and cannot start with http:// or https://.


endpointAddressOptional

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

Property endpointAddress: The endpoint address.


endpointSubAddressOptional

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

Property endpointSubAddress: The secondary address of the endpoint.

You must specify this parameter when the accelerated IP address is associated with the secondary private IP address of an Elastic Compute Service (ECS) instance or an elastic network interface (ENI). When the endpoint type is ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If the parameter is left empty, the primary private IP address of the primary ENI is used. If the endpoint type is ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If the parameter is left empty, the primary private IP address of the secondary ENI is used.


endpointTypeOptional

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

Property endpointType: The type of the endpoint.

Valid values: ENI SLB ECS


nameOptional

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

Property name: The name of the endpoint group.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.


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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • 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 endpoint group ID.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrEndpointGroupIdRequired

public IResolvable getAttrEndpointGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointGroupId: The endpoint group ID.