Skip to content

BasicEndpoint

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();
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.
endpointAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointAddress: The address of the endpoint.
endpointGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointGroupId: The ID of the endpoint group.
endpointSubAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointSubAddress: The secondary address of the endpoint.
endpointSubAddressType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointSubAddressType: The type of the secondary address of the endpoint.
endpointType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointType: The type of the endpoint.
endpointZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointZoneId: The zone ID of the endpoint.
name 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.

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.

endpointAddressRequired

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

Property endpointAddress: The address of the endpoint.

endpointGroupIdRequired

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

Property endpointGroupId: The ID of the endpoint group.

endpointSubAddressOptional

  • 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.

endpointSubAddressTypeOptional

  • 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.

endpointTypeOptional

  • 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)

endpointZoneIdOptional

  • 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.

nameOptional

  • 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

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.BasicEndpoint;
BasicEndpoint.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.
attrEndpointId com.aliyun.ros.cdk.core.IResolvable Attribute EndpointId: The ID of the endpoint.

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

attrEndpointIdRequired 

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

Attribute EndpointId: The ID of the endpoint.