VpcEndpoint

• Implements: IVpcEndpoint

This class encapsulates and extends the ROS resource type ALIYUN::PrivateLink::VpcEndpoint, which is used to create an endpoint.

Initializers

import com.aliyun.ros.cdk.privatelink.VpcEndpoint;
VpcEndpoint.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

vpcId^Required

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

Property vpcId: The VPC to which the endpoint belongs.

endpointDescription^Optional

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

endpointName^Optional

• 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 (_).

endpointType^Optional

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

protectedEnabled^Optional

• 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

securityGroupId^Optional

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

serviceId^Optional

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

serviceName^Optional

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

tags^Optional

• Type: java.util.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.

zone^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListZoneProperty>

Property zone: The list of zones for the endpoint.

zonePrivateIpAddressCount^Optional

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

Methods

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.privatelink.VpcEndpoint;
VpcEndpoint.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrBandwidth^Required

public java.lang.Object getAttrBandwidth();

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

Attribute Bandwidth: The bandwidth of the endpoint.

attrEndpointDomain^Required

public java.lang.Object getAttrEndpointDomain();

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

Attribute EndpointDomain: The domain name of the endpoint.

attrEndpointId^Required

public java.lang.Object getAttrEndpointId();

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

Attribute EndpointId: The ID of the endpoint.

attrEndpointName^Required

public java.lang.Object getAttrEndpointName();

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

Attribute EndpointName: The name of the endpoint.

attrServiceId^Required

public java.lang.Object getAttrServiceId();

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

Attribute ServiceId: The ID of endpoint service that is associated with the endpoint.

attrServiceName^Required

public java.lang.Object getAttrServiceName();

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

Attribute ServiceName: The name of endpoint service that is associated with the endpoint.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

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

Attribute VpcId: The vpc ID of endpoint.

attrZoneDomains^Required

public java.lang.Object getAttrZoneDomains();

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

Attribute ZoneDomains: The zone domains.

props^Required

public VpcEndpointProps getProps();

• Type: VpcEndpointProps