VpcGatewayEndpoint

• Implements: IVpcGatewayEndpoint

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

Initializers

import ros_cdk_vpc
ros_cdk_vpc.VpcGatewayEndpoint(
  scope: Construct,
  id: str,
  service_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  endpoint_description: typing.Union[str, IResolvable] = None,
  endpoint_name: typing.Union[str, IResolvable] = None,
  policy_document: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

service_name^Required

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

Property serviceName: Terminal service name.

vpc_id^Required

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

endpoint_description^Optional

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

Property endpointDescription: Description information of the gateway endpoint.

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

endpoint_name^Optional

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

Property endpointName: The name of the gateway endpoint.

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

policy_document^Optional

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

resource_group_id^Optional

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

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

tags^Optional

• Type: typing.List[TagsProperty]

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

You can define a maximum of 20 tags.

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_vpc
ros_cdk_vpc.VpcGatewayEndpoint.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_endpoint_id^Required

attr_endpoint_id: typing.Union[str, IResolvable]

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

Attribute EndpointId: Gateway endpoint instance ID.

props^Required

props: VpcGatewayEndpointProps

• Type: VpcGatewayEndpointProps