Skip to content

VpcGatewayEndpoint

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpcGatewayEndpoint, which is used to create a gateway endpoint.

Initializers

import com.aliyun.ros.cdk.vpc.VpcGatewayEndpoint;
VpcGatewayEndpoint.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .serviceName(java.lang.String)
    .serviceName(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .endpointDescription(java.lang.String)
//  .endpointDescription(IResolvable)
//  .endpointName(java.lang.String)
//  .endpointName(IResolvable)
//  .policyDocument(java.lang.String)
//  .policyDocument(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .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.
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property serviceName: Terminal service name.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC ID of the gateway endpoint is to be created.
endpointDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointDescription: Description information of the gateway endpoint.
endpointName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endpointName: The name of the gateway endpoint.
policyDocument java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property policyDocument: Access policies for cloud services.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The resource group ID to which the gateway endpoint belongs.
tags java.util.List<TagsProperty> Property tags: The list of tags in the form of key\/value pairs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

serviceNameRequired

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

Property serviceName: Terminal service name.


vpcIdRequired

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

Property vpcId: The VPC ID of the gateway endpoint is to be created.

The VPC must be in the same region as the gateway endpoint.


endpointDescriptionOptional

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

Property endpointDescription: Description information of the gateway endpoint.

The length of the description information is between 1 and 255 characters.


endpointNameOptional

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

Property endpointName: The name of the gateway endpoint.

The length of the name is between 1 and 128 characters.


policyDocumentOptional

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

Property policyDocument: Access policies for cloud services.

For the syntax and structure of access policies, see Permission Policy Syntax and Structure. illustrate This field is required when the selected endpoint service supports setting access policies; This field must be empty when the selected endpoint service does not support setting access policies. Whether the terminal node service supports setting access policies can be obtained through the ListVpcEndpointServicesByEndUser interface. SupportPolicy is true to indicate support, otherwise it is not supported.


resourceGroupIdOptional

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

Property resourceGroupId: The resource group ID to which the gateway endpoint belongs.


tagsOptional

Property tags: The list of tags in the form of key\/value pairs.

You can define a maximum of 20 tags.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.vpc.VpcGatewayEndpoint;
VpcGatewayEndpoint.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrEndpointId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EndpointId: Gateway endpoint instance ID.
props VpcGatewayEndpointProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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

attrEndpointIdRequired

public java.lang.Object getAttrEndpointId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EndpointId: Gateway endpoint instance ID.


propsRequired

public VpcGatewayEndpointProps getProps();