VpcEndpoint

• Implements: IVpcEndpoint

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

Initializers

import ros_cdk_privatelink
ros_cdk_privatelink.VpcEndpoint(
  scope: Construct,
  id: str,
  vpc_id: typing.Union[str, IResolvable],
  endpoint_description: typing.Union[str, IResolvable] = None,
  endpoint_name: typing.Union[str, IResolvable] = None,
  endpoint_type: typing.Union[str, IResolvable] = None,
  protected_enabled: typing.Union[bool, IResolvable] = None,
  security_group_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  service_id: typing.Union[str, IResolvable] = None,
  service_name: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ZoneProperty]]] = None,
  zone_private_ip_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

vpc_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The VPC to which the endpoint belongs.

endpoint_description^Optional

• Type: typing.Union[str, 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://.

endpoint_name^Optional

• Type: typing.Union[str, 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.

endpoint_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property endpointType: Endpoint type.

protected_enabled^Optional

• Type: typing.Union[bool, 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

security_group_id^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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.

service_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

One of ServiceId and ServiceName is required.

service_name^Optional

• Type: typing.Union[str, 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: typing.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: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneProperty]]]

Property zone:.

zone_private_ip_address_count^Optional

• Type: typing.Union[typing.Union[int, float], 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_privatelink
ros_cdk_privatelink.VpcEndpoint.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_bandwidth^Required

attr_bandwidth: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Bandwidth: The bandwidth of the endpoint.

attr_endpoint_domain^Required

attr_endpoint_domain: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EndpointDomain: The domain name of the endpoint.

attr_endpoint_id^Required

attr_endpoint_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EndpointId: The ID of the endpoint.

attr_endpoint_name^Required

attr_endpoint_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EndpointName: The name of the endpoint.

attr_service_id^Required

attr_service_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_service_name^Required

attr_service_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VpcId: The vpc ID of endpoint.

attr_zone_domains^Required

attr_zone_domains: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ZoneDomains: The zone domains.

props^Required

props: VpcEndpointProps

• Type: VpcEndpointProps