Skip to content

VpcEndpoint

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,
  security_group_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  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,
  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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
security_group_id 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.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC to which the endpoint belongs.
endpoint_description typing.Union[str, ros_cdk_core.IResolvable] Property endpointDescription: The description of the endpoint.
endpoint_name typing.Union[str, ros_cdk_core.IResolvable] Property endpointName: The name of the endpoint.
endpoint_type typing.Union[str, ros_cdk_core.IResolvable] Property endpointType: Endpoint type.
protected_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property protectedEnabled: Specifies whether to enable user authentication.
service_id typing.Union[str, ros_cdk_core.IResolvable] Property serviceId: The endpoint service that is associated with the endpoint.
service_name typing.Union[str, ros_cdk_core.IResolvable] Property serviceName: The name of the endpoint service that is associated with the endpoint.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
zone typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ZoneProperty]]] Property zone:.
zone_private_ip_address_count 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

security_group_idRequired

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

vpc_idRequired

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

Property vpcId: The VPC to which the endpoint belongs.

endpoint_descriptionOptional

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

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

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

Property endpointType: Endpoint type.

protected_enabledOptional

  • 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

service_idOptional

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

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

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.

zoneOptional

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

Property zone:.

zone_private_ip_address_countOptional

  • 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_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.VpcEndpoint.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_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: The bandwidth of the endpoint.
attr_endpoint_domain ros_cdk_core.IResolvable Attribute EndpointDomain: The domain name of the endpoint.
attr_endpoint_id ros_cdk_core.IResolvable Attribute EndpointId: The ID of the endpoint.
attr_endpoint_name ros_cdk_core.IResolvable Attribute EndpointName: The name of the endpoint.
attr_service_id ros_cdk_core.IResolvable Attribute ServiceId: The ID of endpoint service that is associated with the endpoint.
attr_service_name ros_cdk_core.IResolvable Attribute ServiceName: The name of endpoint service that is associated with the endpoint.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The vpc ID of endpoint.
attr_zone_domains ros_cdk_core.IResolvable Attribute ZoneDomains: The zone domains.

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_bandwidthRequired 

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The bandwidth of the endpoint.

attr_endpoint_domainRequired 

attr_endpoint_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndpointDomain: The domain name of the endpoint.

attr_endpoint_idRequired 

attr_endpoint_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndpointId: The ID of the endpoint.

attr_endpoint_nameRequired 

attr_endpoint_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EndpointName: The name of the endpoint.

attr_service_idRequired 

attr_service_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_service_nameRequired 

attr_service_name: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The vpc ID of endpoint.

attr_zone_domainsRequired 

attr_zone_domains: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneDomains: The zone domains.