Skip to content

VpcEndpointProps

Properties for defining a VpcEndpoint.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-privatelink-vpcendpoint

Initializer

import ros_cdk_privatelink
ros_cdk_privatelink.VpcEndpointProps(
  vpc_id: typing.Union[str, IResolvable],
  endpoint_description: typing.Union[str, IResolvable] = None,
  endpoint_name: typing.Union[str, IResolvable] = None,
  endpoint_type: typing.Union[str, IResolvable] = None,
  protected_enabled: typing.Union[bool, IResolvable] = None,
  security_group_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  service_id: typing.Union[str, IResolvable] = None,
  service_name: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneProperty]]] = None,
  zone_private_ip_address_count: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC to which the endpoint belongs.
endpoint_description typing.Union[str, ros_cdk_core.IResolvable] Property endpointDescription: The description of the endpoint.
endpoint_name typing.Union[str, ros_cdk_core.IResolvable] Property endpointName: The name of the endpoint.
endpoint_type typing.Union[str, ros_cdk_core.IResolvable] Property endpointType: The type of the endpoint.
protected_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property protectedEnabled: Specifies whether to enable user authentication.
security_group_id typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityGroupId: The security group associated with the endpoint network interface.
service_id typing.Union[str, ros_cdk_core.IResolvable] Property serviceId: The endpoint service that is associated with the endpoint.
service_name typing.Union[str, ros_cdk_core.IResolvable] Property serviceName: The name of the endpoint service that is associated with the endpoint.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
zone typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneProperty]]] Property zone: The list of zones for the endpoint.
zone_private_ip_address_count typing.Union[typing.Union[int, float], 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.

vpc_idRequired

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The VPC to which the endpoint belongs.


endpoint_descriptionOptional

endpoint_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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://.


endpoint_nameOptional

endpoint_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 (_).


endpoint_typeOptional

endpoint_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


protected_enabledOptional

protected_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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


security_group_idOptional

security_group_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, 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.


service_idOptional

service_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property serviceId: The endpoint service that is associated with the endpoint.

One of ServiceId and ServiceName is required.


service_nameOptional

service_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

tags: typing.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.


zoneOptional

zone: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneProperty]]]

Property zone: The list of zones for the endpoint.


zone_private_ip_address_countOptional

zone_private_ip_address_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.