Skip to content

VpcEndpointService

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

Initializers 

import com.aliyun.ros.cdk.privatelink.VpcEndpointService;
VpcEndpointService.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .autoAcceptEnabled(java.lang.Boolean)
//  .autoAcceptEnabled(IResolvable)
//  .connectBandwidth(java.lang.Number)
//  .connectBandwidth(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .payer(java.lang.String)
//  .payer(IResolvable)
//  .resource(IResolvable)
//  .resource(java.util.List<IResolvable)
//  .resource(ResourceProperty>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceDescription(java.lang.String)
//  .serviceDescription(IResolvable)
//  .serviceResourceType(java.lang.String)
//  .serviceResourceType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .user(IResolvable)
//  .user(java.util.List<java.lang.String)
//  .user(IResolvable>)
//  .zoneAffinityEnabled(java.lang.Boolean)
//  .zoneAffinityEnabled(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.
autoAcceptEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoAcceptEnabled: Specifies whether to automatically accept endpoint connection requests.
connectBandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property connectBandwidth: The default maximum bandwidth of the endpoint connection.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Specifies whether to delete the endpoint service even if it has endpoint connections.
payer java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payer: The payer of the endpoint service.
resource com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourceProperty> Property resource:.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
serviceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceDescription: The description for the endpoint service.
serviceResourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceResourceType: Service resource type.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
user com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property user: Account IDs to the whitelist of an endpoint service.
zoneAffinityEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property zoneAffinityEnabled: Specifies whether to resolve domain names to IP addresses in the nearest zone.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

autoAcceptEnabledOptional

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

Property autoAcceptEnabled: Specifies whether to automatically accept endpoint connection requests.

Valid values: true: automatically accepts endpoint connection requests. false: does not automatically accept endpoint connection requests.

connectBandwidthOptional

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

Property connectBandwidth: The default maximum bandwidth of the endpoint connection.

Valid values: 100 to 1024. Unit: Mbit/s.

deletionForceOptional

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

Property deletionForce: Specifies whether to delete the endpoint service even if it has endpoint connections.

  • True
  • False (default)

payerOptional

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

Property payer: The payer of the endpoint service.

Valid values: Endpoint: the service consumer. EndpointService: the service provider.

resourceOptional

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

Property resource:.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

serviceDescriptionOptional

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

Property serviceDescription: The description for the endpoint service.

serviceResourceTypeOptional

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

Property serviceResourceType: Service resource type.

tagsOptional

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.

userOptional

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

Property user: Account IDs to the whitelist of an endpoint service.

zoneAffinityEnabledOptional

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

Property zoneAffinityEnabled: Specifies whether to resolve domain names to IP addresses in the nearest zone.

true: yes. false (default): no

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • 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.
attrMaxBandwidth com.aliyun.ros.cdk.core.IResolvable Attribute MaxBandwidth: The maximum bandwidth of the endpoint connection.
attrMinBandwidth com.aliyun.ros.cdk.core.IResolvable Attribute MinBandwidth: The minimum bandwidth of the endpoint connection.
attrServiceDescription com.aliyun.ros.cdk.core.IResolvable Attribute ServiceDescription: The description of the endpoint service.
attrServiceDomain com.aliyun.ros.cdk.core.IResolvable Attribute ServiceDomain: The domain name of the endpoint service.
attrServiceId com.aliyun.ros.cdk.core.IResolvable Attribute ServiceId: The ID of the endpoint service.
attrServiceName com.aliyun.ros.cdk.core.IResolvable Attribute ServiceName: The name of the endpoint service.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrMaxBandwidthRequired 

public IResolvable getAttrMaxBandwidth();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MaxBandwidth: The maximum bandwidth of the endpoint connection.

attrMinBandwidthRequired 

public IResolvable getAttrMinBandwidth();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MinBandwidth: The minimum bandwidth of the endpoint connection.

attrServiceDescriptionRequired 

public IResolvable getAttrServiceDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceDescription: The description of the endpoint service.

attrServiceDomainRequired 

public IResolvable getAttrServiceDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceDomain: The domain name of the endpoint service.

attrServiceIdRequired 

public IResolvable getAttrServiceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceId: The ID of the endpoint service.

attrServiceNameRequired 

public IResolvable getAttrServiceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceName: The name of the endpoint service.