VpcEndpoint

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)
    .securityGroupId(IResolvable)
    .securityGroupId(java.util.List<java.lang.String)
    .securityGroupId(IResolvable>)
    .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)
//  .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();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`securityGroupId`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.List`	Property securityGroupId: The security group associated with the endpoint network interface.
`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: Endpoint type.
`protectedEnabled`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property protectedEnabled: Specifies whether to enable user authentication.
`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:.
`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.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`securityGroupId`^Required

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.

`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 in length and can contain digits, underscores (_), and hyphens (-). The name must start with a letter.

`endpointType`^Optional

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

Property endpointType: Endpoint type.

`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

`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:.

`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

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`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

`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

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`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

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrBandwidth`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Bandwidth: The bandwidth of the endpoint.
`attrEndpointDomain`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointDomain: The domain name of the endpoint.
`attrEndpointId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointId: The ID of the endpoint.
`attrEndpointName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointName: The name of the endpoint.
`attrServiceId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ServiceId: The ID of endpoint service that is associated with the endpoint.
`attrServiceName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ServiceName: The name of endpoint service that is associated with the endpoint.
`attrVpcId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute VpcId: The vpc ID of endpoint.
`attrZoneDomains`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ZoneDomains: The zone domains.

`node`^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

`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

`attrBandwidth`^Required

public IResolvable getAttrBandwidth();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: The bandwidth of the endpoint.

`attrEndpointDomain`^Required

public IResolvable getAttrEndpointDomain();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointDomain: The domain name of the endpoint.

`attrEndpointId`^Required

public IResolvable getAttrEndpointId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointId: The ID of the endpoint.

`attrEndpointName`^Required

public IResolvable getAttrEndpointName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointName: The name of the endpoint.

`attrServiceId`^Required

public IResolvable getAttrServiceId();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrServiceName`^Required

public IResolvable getAttrServiceName();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrVpcId`^Required

public IResolvable getAttrVpcId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The vpc ID of endpoint.

`attrZoneDomains`^Required

public IResolvable getAttrZoneDomains();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneDomains: The zone domains.

VpcEndpoint

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

securityGroupIdRequired

vpcIdRequired

endpointDescriptionOptional

endpointNameOptional

endpointTypeOptional

protectedEnabledOptional

serviceIdOptional

serviceNameOptional

tagsOptional

zoneOptional

zonePrivateIpAddressCountOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata