Skip to content

VpcEndpointProps

Properties for defining a VpcEndpoint.

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

Initializer

import com.aliyun.ros.cdk.privatelink.VpcEndpointProps;
VpcEndpointProps.builder()
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .endpointDescription(java.lang.String)
//  .endpointDescription(IResolvable)
//  .endpointName(java.lang.String)
//  .endpointName(IResolvable)
//  .endpointType(java.lang.String)
//  .endpointType(IResolvable)
//  .protectedEnabled(java.lang.Boolean)
//  .protectedEnabled(IResolvable)
//  .securityGroupId(IResolvable)
//  .securityGroupId(java.util.List<java.lang.String)
//  .securityGroupId(IResolvable>)
//  .serviceId(java.lang.String)
//  .serviceId(IResolvable)
//  .serviceName(java.lang.String)
//  .serviceName(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zone(IResolvable)
//  .zone(java.util.List<IResolvable)
//  .zone(ZoneProperty>)
//  .zonePrivateIpAddressCount(java.lang.Number)
//  .zonePrivateIpAddressCount(IResolvable)
    .build();

Properties

Name Type Description
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC to which the endpoint belongs.
endpointDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointDescription: The description of the endpoint.
endpointName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointName: The name of the endpoint.
endpointType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointType: The type of the endpoint.
protectedEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property protectedEnabled: Specifies whether to enable user authentication.
securityGroupId com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityGroupId: The security group associated with the endpoint network interface.
serviceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceId: The endpoint service that is associated with the endpoint.
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceName: The name of the endpoint service that is associated with the endpoint.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
zone com.aliyun.ros.cdk.core.IResolvable OR java.util.ListZoneProperty> Property zone: The list of zones for the endpoint.
zonePrivateIpAddressCount java.lang.Number OR com.aliyun.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 java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC to which the endpoint belongs.


endpointDescriptionOptional

public java.lang.Object getEndpointDescription();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEndpointName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEndpointType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getProtectedEnabled();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getSecurityGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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 java.lang.Object getServiceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

One of ServiceId and ServiceName is required.


serviceNameOptional

public java.lang.Object getServiceName();
  • Type: java.lang.String OR com.aliyun.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 java.util.List<TagsProperty> getTags();

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 java.lang.Object getZone();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListZoneProperty>

Property zone: The list of zones for the endpoint.


zonePrivateIpAddressCountOptional

public java.lang.Object getZonePrivateIpAddressCount();
  • Type: java.lang.Number OR com.aliyun.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.