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 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
auto_accept_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property autoAcceptEnabled: Specifies whether to automatically accept endpoint connection requests.
connect_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property connectBandwidth: The default maximum bandwidth of the endpoint connection.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Specifies whether to delete the endpoint service even if it has endpoint connections.
payer typing.Union[str, ros_cdk_core.IResolvable] Property payer: The payer of the endpoint service.
resource typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ResourceProperty]]] Property resource:.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
service_description typing.Union[str, ros_cdk_core.IResolvable] Property serviceDescription: The description for the endpoint service.
service_resource_type typing.Union[str, ros_cdk_core.IResolvable] Property serviceResourceType: Service resource type.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
user 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 typing.Union[bool, ros_cdk_core.IResolvable] Property zoneAffinityEnabled: Specifies whether to resolve domain names to IP addresses in the nearest zone.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_accept_enabledOptional

  • 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_bandwidthOptional

  • 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_forceOptional

  • 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)

payerOptional

  • 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.

resourceOptional

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

Property resource:.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.

service_descriptionOptional

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

Property serviceDescription: The description for the endpoint service.

service_resource_typeOptional

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

  • 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_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_max_bandwidth ros_cdk_core.IResolvable Attribute MaxBandwidth: The maximum bandwidth of the endpoint connection.
attr_min_bandwidth ros_cdk_core.IResolvable Attribute MinBandwidth: The minimum bandwidth of the endpoint connection.
attr_service_description ros_cdk_core.IResolvable Attribute ServiceDescription: The description of the endpoint service.
attr_service_domain ros_cdk_core.IResolvable Attribute ServiceDomain: The domain name of the endpoint service.
attr_service_id ros_cdk_core.IResolvable Attribute ServiceId: The ID of the endpoint service.
attr_service_name ros_cdk_core.IResolvable Attribute ServiceName: The name of the endpoint service.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_max_bandwidthRequired 

attr_max_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaxBandwidth: The maximum bandwidth of the endpoint connection.

attr_min_bandwidthRequired 

attr_min_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MinBandwidth: The minimum bandwidth of the endpoint connection.

attr_service_descriptionRequired 

attr_service_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceDescription: The description of the endpoint service.

attr_service_domainRequired 

attr_service_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceDomain: The domain name of the endpoint service.

attr_service_idRequired 

attr_service_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceId: The ID of the endpoint service.

attr_service_nameRequired 

attr_service_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceName: The name of the endpoint service.