VpcEndpointProps
Properties for defining a VpcEndpoint.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-privatelink-vpcendpoint
Initializer
import { VpcEndpointProps } from '@alicloud/ros-cdk-privatelink'
const vpcEndpointProps: VpcEndpointProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
vpcId | string | @alicloud/ros-cdk-core.IResolvable | Property vpcId: The VPC to which the endpoint belongs. |
endpointDescription | string | @alicloud/ros-cdk-core.IResolvable | Property endpointDescription: The description of the endpoint. |
endpointName | string | @alicloud/ros-cdk-core.IResolvable | Property endpointName: The name of the endpoint. |
endpointType | string | @alicloud/ros-cdk-core.IResolvable | Property endpointType: The type of the endpoint. |
protectedEnabled | boolean | @alicloud/ros-cdk-core.IResolvable | Property protectedEnabled: Specifies whether to enable user authentication. |
securityGroupId | @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] | Property securityGroupId: The security group associated with the endpoint network interface. |
serviceId | string | @alicloud/ros-cdk-core.IResolvable | Property serviceId: The endpoint service that is associated with the endpoint. |
serviceName | string | @alicloud/ros-cdk-core.IResolvable | Property serviceName: The name of the endpoint service that is associated with the endpoint. |
tags | TagsProperty[] | Property tags: Tags to attach to instance. |
zone | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ZoneProperty[] | Property zone: The list of zones for the endpoint. |
zonePrivateIpAddressCount | number | @alicloud/ros-cdk-core.IResolvable | Property zonePrivateIpAddressCount: The number of private IP addresses that can be used by an elastic network interface (ENI) in each zone. |
vpcIdRequired
public readonly vpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property vpcId: The VPC to which the endpoint belongs.
endpointDescriptionOptional
public readonly endpointDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property endpointDescription: The description of the endpoint.
The description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
endpointNameOptional
public readonly endpointName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property endpointName: The name of the endpoint.
The name must be 2 to 128 characters long, start with a letter or a Chinese character, and can contain digits, hyphens (-), and underscores (_).
endpointTypeOptional
public readonly endpointType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property endpointType: The type of the endpoint.
Valid values: - Interface: an interface endpoint. You can add Application Load Balancer (ALB), CLB, and Network Load Balancer (NLB) instances as service resources. - Reverse: a reverse endpoint. You can add a VPC NAT Gateway as a service resource. - GatewayLoadBalancer: a Gateway Load Balancer endpoint. You can add a Gateway Load Balancer (GWLB) as a service resource.
Services that support reverse endpoints are provided exclusively by the cloud platform and its partners. You cannot create them by default. To request access, contact your account manager.
protectedEnabledOptional
public readonly protectedEnabled: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property protectedEnabled: Specifies whether to enable user authentication.
This parameter is available in Security Token Service (STS) mode. Valid values: true: yes After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode. false (default): no
securityGroupIdOptional
public readonly securityGroupId: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
Property securityGroupId: The security group associated with the endpoint network interface.
The security group can control the data communication from the VPC to the endpoint network interface.
serviceIdOptional
public readonly serviceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property serviceId: The endpoint service that is associated with the endpoint.
One of ServiceId and ServiceName is required.
serviceNameOptional
public readonly serviceName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property serviceName: The name of the endpoint service that is associated with the endpoint.
One of ServiceId and ServiceName is required.
tagsOptional
public readonly tags: TagsProperty[];
- Type: 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.
zoneOptional
public readonly zone: IResolvable | IResolvable | ZoneProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ZoneProperty[]
Property zone: The list of zones for the endpoint.
zonePrivateIpAddressCountOptional
public readonly zonePrivateIpAddressCount: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property zonePrivateIpAddressCount: The number of private IP addresses that can be used by an elastic network interface (ENI) in each zone.
Set the value to 1.