BasicEndpoint

• Implements: IBasicEndpoint

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

Initializers

import com.aliyun.ros.cdk.ga.BasicEndpoint;
BasicEndpoint.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .acceleratorId(java.lang.String)
    .acceleratorId(IResolvable)
    .endpointAddress(java.lang.String)
    .endpointAddress(IResolvable)
    .endpointGroupId(java.lang.String)
    .endpointGroupId(IResolvable)
//  .endpointSubAddress(java.lang.String)
//  .endpointSubAddress(IResolvable)
//  .endpointSubAddressType(java.lang.String)
//  .endpointSubAddressType(IResolvable)
//  .endpointType(java.lang.String)
//  .endpointType(IResolvable)
//  .endpointZoneId(java.lang.String)
//  .endpointZoneId(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
    .build();

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 basic GA instance.

endpointAddress^Required

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

Property endpointAddress: The address of the endpoint.

endpointGroupId^Required

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

Property endpointGroupId: The ID of the endpoint group.

endpointSubAddress^Optional

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

Property endpointSubAddress: The secondary address of the endpoint.

This parameter is required if the endpoint type is ECS, ENI, or NLB. If 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. This parameter is required if the endpoint type is NLB. EndpointSubAddress is the primary private IP address of the NLB backend server.This parameter is required if the endpoint type is NLB. EndpointSubAddress is the primary private IP address of the NLB backend server.

endpointSubAddressType^Optional

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

Property endpointSubAddressType: The type of the secondary address of the endpoint.

Valid values: primary: a primary private IP address. secondary: a secondary private IP address. This parameter is required if the endpoint type is ECS, ENI, or NLB. If the endpoint type is NLB, only primary is supported.

endpointType^Optional

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

Property endpointType: The type of the endpoint.

Valid values: ENI: elastic network interface (ENI) SLB: Classic Load Balancer (CLB) NLB: Network Load Balancer (NLB) ECS: Elastic Compute Service (ECS)

endpointZoneId^Optional

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

Property endpointZoneId: The zone ID of the endpoint.

This parameter is required only if the endpoint type is NLB.

name^Optional

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

Property name: The name of the endpoint that is associated with the basic GA instance.

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

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.ga.BasicEndpoint;
BasicEndpoint.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

attrEndpointId^Required

public java.lang.Object getAttrEndpointId();

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

Attribute EndpointId: The ID of the endpoint.

props^Required

public BasicEndpointProps getProps();

• Type: BasicEndpointProps