ServerGroup

• Implements: IServerGroup

This class encapsulates and extends the ROS resource type ALIYUN::NLB::ServerGroup.

Initializers

import com.aliyun.ros.cdk.nlb.ServerGroup;
ServerGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .serverGroupName(java.lang.String)
    .serverGroupName(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .addressIpVersion(java.lang.String)
//  .addressIpVersion(IResolvable)
//  .anyPortEnabled(java.lang.Boolean)
//  .anyPortEnabled(IResolvable)
//  .connectionDrainEnabled(java.lang.Boolean)
//  .connectionDrainEnabled(IResolvable)
//  .connectionDrainTimeout(java.lang.Number)
//  .connectionDrainTimeout(IResolvable)
//  .healthCheckConfig(IResolvable)
//  .healthCheckConfig(HealthCheckConfigProperty)
//  .persistenceEnabled(java.lang.Boolean)
//  .persistenceEnabled(IResolvable)
//  .persistenceTimeout(java.lang.Number)
//  .persistenceTimeout(IResolvable)
//  .preserveClientIpEnabled(java.lang.Boolean)
//  .preserveClientIpEnabled(IResolvable)
//  .protocol(java.lang.String)
//  .protocol(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .scheduler(java.lang.String)
//  .scheduler(IResolvable)
//  .serverGroupType(java.lang.String)
//  .serverGroupType(IResolvable)
//  .servers(IResolvable)
//  .servers(java.util.List<IResolvable)
//  .servers(ServersProperty>)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

serverGroupName^Required

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

Property serverGroupName: Name of ServerGroup.

vpcId^Required

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

Property vpcId: ID of VPC.

addressIpVersion^Optional

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

Property addressIpVersion: IP version of address.

anyPortEnabled^Optional

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

Property anyPortEnabled: Specifies whether to enable all-port forwarding.

Valid values: true false (default)

connectionDrainEnabled^Optional

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

Property connectionDrainEnabled: Whether to enable graceful connection interruption.

connectionDrainTimeout^Optional

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

Property connectionDrainTimeout: Time of graceful connection interruption.

healthCheckConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR HealthCheckConfigProperty

Property healthCheckConfig: Health Check Config.

persistenceEnabled^Optional

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

Property persistenceEnabled: Whether to enable session persistence.

persistenceTimeout^Optional

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

Property persistenceTimeout: Time of session persistence.

preserveClientIpEnabled^Optional

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

Property preserveClientIpEnabled: Whether to enable the client address retention function.

protocol^Optional

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

Property protocol: Protocol of ServerGroup.

resourceGroupId^Optional

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

Property resourceGroupId: undefined.

scheduler^Optional

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

Property scheduler: undefined.

serverGroupType^Optional

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

Property serverGroupType: Type of ServerGroup.

servers^Optional

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

Property servers: undefined.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

Methods

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

isConstruct

import com.aliyun.ros.cdk.nlb.ServerGroup;
ServerGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attrServerGroupId^Required

public java.lang.Object getAttrServerGroupId();

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

Attribute ServerGroupId: ID of ServerGroup.

props^Required

public ServerGroupProps getProps();

• Type: ServerGroupProps

Structs