VpcEndpointService

• Implements: IVpcEndpointService

This class encapsulates and extends the ROS resource type ALIYUN::PrivateLink::VpcEndpointService.

Initializers

import ros_cdk_privatelink
ros_cdk_privatelink.VpcEndpointService(
  scope: Construct,
  id: str,
  auto_accept_enabled: typing.Union[bool, IResolvable] = None,
  connect_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  payer: typing.Union[str, IResolvable] = None,
  resource: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourceProperty]]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  service_description: typing.Union[str, IResolvable] = None,
  service_resource_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  user: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  zone_affinity_enabled: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

auto_accept_enabled^Optional

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

connect_bandwidth^Optional

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

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

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

deletion_force^Optional

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

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

• True
• False (default)

payer^Optional

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

Property payer: The payer of the endpoint service.

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

resource^Optional

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

Property resource:.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

service_description^Optional

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

Property serviceDescription: The description for the endpoint service.

service_resource_type^Optional

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

Property serviceResourceType: Service resource type.

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.

user^Optional

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

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

zone_affinity_enabled^Optional

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

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

true: yes. false (default): no

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.VpcEndpointService.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_max_bandwidth^Required

attr_max_bandwidth: typing.Union[str, IResolvable]

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

Attribute MaxBandwidth: The maximum bandwidth of the endpoint connection.

attr_min_bandwidth^Required

attr_min_bandwidth: typing.Union[str, IResolvable]

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

Attribute MinBandwidth: The minimum bandwidth of the endpoint connection.

attr_service_description^Required

attr_service_description: typing.Union[str, IResolvable]

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

Attribute ServiceDescription: The description of the endpoint service.

attr_service_domain^Required

attr_service_domain: typing.Union[str, IResolvable]

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

Attribute ServiceDomain: The domain name of the endpoint service.

attr_service_id^Required

attr_service_id: typing.Union[str, IResolvable]

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

Attribute ServiceId: The ID of the endpoint service.

attr_service_name^Required

attr_service_name: typing.Union[str, IResolvable]

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

Attribute ServiceName: The name of the endpoint service.

props^Required

props: VpcEndpointServiceProps

• Type: VpcEndpointServiceProps