Skip to content

BasicEndpointProps

Properties for defining a BasicEndpoint.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ga-basicendpoint

Initializer

import { BasicEndpointProps } from '@alicloud/ros-cdk-ga'
const basicEndpointProps: BasicEndpointProps = { ... }

Properties

Name Type Description
acceleratorId string | @alicloud/ros-cdk-core.IResolvable Property acceleratorId: The ID of the basic GA instance.
endpointAddress string | @alicloud/ros-cdk-core.IResolvable Property endpointAddress: The address of the endpoint.
endpointGroupId string | @alicloud/ros-cdk-core.IResolvable Property endpointGroupId: The ID of the endpoint group.
endpointSubAddress string | @alicloud/ros-cdk-core.IResolvable Property endpointSubAddress: The secondary address of the endpoint.
endpointSubAddressType string | @alicloud/ros-cdk-core.IResolvable Property endpointSubAddressType: The type of the secondary address of the endpoint.
endpointType string | @alicloud/ros-cdk-core.IResolvable Property endpointType: The type of the endpoint.
endpointZoneId string | @alicloud/ros-cdk-core.IResolvable Property endpointZoneId: The zone ID of the endpoint.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the endpoint that is associated with the basic GA instance.

acceleratorIdRequired

public readonly acceleratorId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property acceleratorId: The ID of the basic GA instance.


endpointAddressRequired

public readonly endpointAddress: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpointAddress: The address of the endpoint.


endpointGroupIdRequired

public readonly endpointGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpointGroupId: The ID of the endpoint group.


endpointSubAddressOptional

public readonly endpointSubAddress: string | IResolvable;
  • Type: string | @alicloud/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

public readonly endpointSubAddressType: string | IResolvable;
  • Type: string | @alicloud/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

public readonly endpointType: string | IResolvable;
  • Type: string | @alicloud/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

public readonly endpointZoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property endpointZoneId: The zone ID of the endpoint.

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


nameOptional

public readonly name: string | IResolvable;
  • Type: string | @alicloud/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.