1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. privatelink
  6. VpcEndpoint
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.privatelink.VpcEndpoint

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    The endpoint node is a private network service access point deployed by the service user in their own VPC, used to access the service provider’s services via the private network.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  privateLinkVpcEndpointDemo:
    type: volcenginecc:privatelink:VpcEndpoint
    name: PrivateLinkVpcEndpointDemo
    properties:
      description: this is a test
      endpointName: ccapi-test-1001
      ipAddressVersions:
        - ipv4
        - ipv6
      privateDnsEnabled: true
      projectName: default
      securityGroupIds:
        - sg-btg9xxxxxc5h0b2u913txw
      serviceId: epsvc-13fpxxxxx03n6nu5omuqde
      serviceName: com.volces.xxxx.cn-beijing.api-ipv6.ticket
      tags:
        - key: env
          value: test
      vpcId: vpc-btg9hmxxxxx5h0b2tnp1on8
      zones:
        - private_ip_address: 192.168.xxx.xx
          private_ipv_6_address: 2406:d440:103:xxxxx:xxxxx:7eef:35c4:8d79
          subnet_id: subnet-ijif1pxxxxx4o8culvzg85
          zone_id: cn-beijing-a

    Create VpcEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcEndpoint(name: string, args?: VpcEndpointArgs, opts?: CustomResourceOptions);
    @overload
def VpcEndpoint(resource_name: str,
                args: Optional[VpcEndpointArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def VpcEndpoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                endpoint_name: Optional[str] = None,
                ip_address_versions: Optional[Sequence[str]] = None,
                private_dns_enabled: Optional[bool] = None,
                project_name: Optional[str] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                service_id: Optional[str] = None,
                service_managed: Optional[bool] = None,
                service_name: Optional[str] = None,
                tags: Optional[Sequence[VpcEndpointTagArgs]] = None,
                vpc_id: Optional[str] = None,
                zones: Optional[Sequence[VpcEndpointZoneArgs]] = None)
    func NewVpcEndpoint(ctx *Context, name string, args *VpcEndpointArgs, opts ...ResourceOption) (*VpcEndpoint, error)
    public VpcEndpoint(string name, VpcEndpointArgs? args = null, CustomResourceOptions? opts = null)
    public VpcEndpoint(String name, VpcEndpointArgs args)
public VpcEndpoint(String name, VpcEndpointArgs args, CustomResourceOptions options)

    type: volcenginecc:privatelink:VpcEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vpcEndpointResource = new Volcenginecc.Privatelink.VpcEndpoint("vpcEndpointResource", new()
{
    Description = "string",
    EndpointName = "string",
    IpAddressVersions = new[]
    {
        "string",
    },
    PrivateDnsEnabled = false,
    ProjectName = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    ServiceId = "string",
    ServiceManaged = false,
    ServiceName = "string",
    Tags = new[]
    {
        new Volcenginecc.Privatelink.Inputs.VpcEndpointTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    VpcId = "string",
    Zones = new[]
    {
        new Volcenginecc.Privatelink.Inputs.VpcEndpointZoneArgs
        {
            PrivateIpAddress = "string",
            PrivateIpv6Address = "string",
            SubnetId = "string",
            ZoneId = "string",
        },
    },
});

    example, err := privatelink.NewVpcEndpoint(ctx, "vpcEndpointResource", &privatelink.VpcEndpointArgs{
	Description:  pulumi.String("string"),
	EndpointName: pulumi.String("string"),
	IpAddressVersions: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateDnsEnabled: pulumi.Bool(false),
	ProjectName:       pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceId:      pulumi.String("string"),
	ServiceManaged: pulumi.Bool(false),
	ServiceName:    pulumi.String("string"),
	Tags: privatelink.VpcEndpointTagArray{
		&privatelink.VpcEndpointTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	VpcId: pulumi.String("string"),
	Zones: privatelink.VpcEndpointZoneArray{
		&privatelink.VpcEndpointZoneArgs{
			PrivateIpAddress:   pulumi.String("string"),
			PrivateIpv6Address: pulumi.String("string"),
			SubnetId:           pulumi.String("string"),
			ZoneId:             pulumi.String("string"),
		},
	},
})

    var vpcEndpointResource = new VpcEndpoint("vpcEndpointResource", VpcEndpointArgs.builder()
    .description("string")
    .endpointName("string")
    .ipAddressVersions("string")
    .privateDnsEnabled(false)
    .projectName("string")
    .securityGroupIds("string")
    .serviceId("string")
    .serviceManaged(false)
    .serviceName("string")
    .tags(VpcEndpointTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .vpcId("string")
    .zones(VpcEndpointZoneArgs.builder()
        .privateIpAddress("string")
        .privateIpv6Address("string")
        .subnetId("string")
        .zoneId("string")
        .build())
    .build());

    vpc_endpoint_resource = volcenginecc.privatelink.VpcEndpoint("vpcEndpointResource",
    description="string",
    endpoint_name="string",
    ip_address_versions=["string"],
    private_dns_enabled=False,
    project_name="string",
    security_group_ids=["string"],
    service_id="string",
    service_managed=False,
    service_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    vpc_id="string",
    zones=[{
        "private_ip_address": "string",
        "private_ipv6_address": "string",
        "subnet_id": "string",
        "zone_id": "string",
    }])

    const vpcEndpointResource = new volcenginecc.privatelink.VpcEndpoint("vpcEndpointResource", {
    description: "string",
    endpointName: "string",
    ipAddressVersions: ["string"],
    privateDnsEnabled: false,
    projectName: "string",
    securityGroupIds: ["string"],
    serviceId: "string",
    serviceManaged: false,
    serviceName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    vpcId: "string",
    zones: [{
        privateIpAddress: "string",
        privateIpv6Address: "string",
        subnetId: "string",
        zoneId: "string",
    }],
});

    type: volcenginecc:privatelink:VpcEndpoint
properties:
    description: string
    endpointName: string
    ipAddressVersions:
        - string
    privateDnsEnabled: false
    projectName: string
    securityGroupIds:
        - string
    serviceId: string
    serviceManaged: false
    serviceName: string
    tags:
        - key: string
          value: string
    vpcId: string
    zones:
        - privateIpAddress: string
          privateIpv6Address: string
          subnetId: string
          zoneId: string

    VpcEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpcEndpoint resource accepts the following input properties:

    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    IpAddressVersions List<string>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds List<string>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Tags List<Volcengine.VpcEndpointTag>
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones List<Volcengine.VpcEndpointZone>
    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    IpAddressVersions []string
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds []string
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Tags []VpcEndpointTagArgs
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones []VpcEndpointZoneArgs
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    tags List<VpcEndpointTag>
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<VpcEndpointZone>
    description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    ipAddressVersions string[]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    privateDnsEnabled boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    projectName string
    Name of the project to which the endpoint node belongs.
    securityGroupIds string[]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName string
    Name of the endpoint service to be associated.
    tags VpcEndpointTag[]
    vpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones VpcEndpointZone[]
    description str
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpoint_name str
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    ip_address_versions Sequence[str]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    private_dns_enabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    project_name str
    Name of the project to which the endpoint node belongs.
    security_group_ids Sequence[str]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    service_id str
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    service_managed bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    service_name str
    Name of the endpoint service to be associated.
    tags Sequence[VpcEndpointTagArgs]
    vpc_id str
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones Sequence[VpcEndpointZoneArgs]
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    tags List<Property Map>
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcEndpoint resource produces the following output properties:

    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    Id string
    The provider-assigned unique ID for this managed resource.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    UpdateTime string
    Most recent operation time of the endpoint.
    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    Id string
    The provider-assigned unique ID for this managed resource.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    UpdateTime string
    Most recent operation time of the endpoint.
    bps Integer
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Integer
    Endpoint index
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    id String
    The provider-assigned unique ID for this managed resource.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    updateTime String
    Most recent operation time of the endpoint.
    bps number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime string
    Creation time of the endpoint.
    deletedTime string
    Deletion time of the endpoint.
    endpointDomain string
    Domain name of the endpoint.
    endpointId string
    ID of the endpoint node.
    endpointIndex number
    Endpoint index
    endpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    id string
    The provider-assigned unique ID for this managed resource.
    payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    updateTime string
    Most recent operation time of the endpoint.
    bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    business_status str
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connection_status str
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creation_time str
    Creation time of the endpoint.
    deleted_time str
    Deletion time of the endpoint.
    endpoint_domain str
    Domain name of the endpoint.
    endpoint_id str
    ID of the endpoint node.
    endpoint_index int
    Endpoint index
    endpoint_type str
    Type of the endpoint node. Interface: interface endpoint node.
    id str
    The provider-assigned unique ID for this managed resource.
    payer str
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    private_dns_name str
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    status str
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    update_time str
    Most recent operation time of the endpoint.
    bps Number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Number
    Endpoint index
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    id String
    The provider-assigned unique ID for this managed resource.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    updateTime String
    Most recent operation time of the endpoint.

    Look up Existing VpcEndpoint Resource

    Get an existing VpcEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VpcEndpointState, opts?: CustomResourceOptions): VpcEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bps: Optional[int] = None,
        business_status: Optional[str] = None,
        connection_status: Optional[str] = None,
        creation_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        endpoint_domain: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_index: Optional[int] = None,
        endpoint_name: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        ip_address_versions: Optional[Sequence[str]] = None,
        payer: Optional[str] = None,
        private_dns_enabled: Optional[bool] = None,
        private_dns_name: Optional[str] = None,
        project_name: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        service_id: Optional[str] = None,
        service_managed: Optional[bool] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[VpcEndpointTagArgs]] = None,
        update_time: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zones: Optional[Sequence[VpcEndpointZoneArgs]] = None) -> VpcEndpoint
    func GetVpcEndpoint(ctx *Context, name string, id IDInput, state *VpcEndpointState, opts ...ResourceOption) (*VpcEndpoint, error)
    public static VpcEndpoint Get(string name, Input<string> id, VpcEndpointState? state, CustomResourceOptions? opts = null)
    public static VpcEndpoint get(String name, Output<String> id, VpcEndpointState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:privatelink:VpcEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    IpAddressVersions List<string>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds List<string>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    Tags List<Volcengine.VpcEndpointTag>
    UpdateTime string
    Most recent operation time of the endpoint.
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones List<Volcengine.VpcEndpointZone>
    Bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    BusinessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    ConnectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    CreationTime string
    Creation time of the endpoint.
    DeletedTime string
    Deletion time of the endpoint.
    Description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    EndpointDomain string
    Domain name of the endpoint.
    EndpointId string
    ID of the endpoint node.
    EndpointIndex int
    Endpoint index
    EndpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    EndpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    IpAddressVersions []string
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    Payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    PrivateDnsEnabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    PrivateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    ProjectName string
    Name of the project to which the endpoint node belongs.
    SecurityGroupIds []string
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    ServiceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    ServiceManaged bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    ServiceName string
    Name of the endpoint service to be associated.
    Status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    Tags []VpcEndpointTagArgs
    UpdateTime string
    Most recent operation time of the endpoint.
    VpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    Zones []VpcEndpointZoneArgs
    bps Integer
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Integer
    Endpoint index
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags List<VpcEndpointTag>
    updateTime String
    Most recent operation time of the endpoint.
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<VpcEndpointZone>
    bps number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus string
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus string
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime string
    Creation time of the endpoint.
    deletedTime string
    Deletion time of the endpoint.
    description string
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain string
    Domain name of the endpoint.
    endpointId string
    ID of the endpoint node.
    endpointIndex number
    Endpoint index
    endpointName string
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType string
    Type of the endpoint node. Interface: interface endpoint node.
    ipAddressVersions string[]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer string
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName string
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName string
    Name of the project to which the endpoint node belongs.
    securityGroupIds string[]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId string
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName string
    Name of the endpoint service to be associated.
    status string
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags VpcEndpointTag[]
    updateTime string
    Most recent operation time of the endpoint.
    vpcId string
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones VpcEndpointZone[]
    bps int
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    business_status str
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connection_status str
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creation_time str
    Creation time of the endpoint.
    deleted_time str
    Deletion time of the endpoint.
    description str
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpoint_domain str
    Domain name of the endpoint.
    endpoint_id str
    ID of the endpoint node.
    endpoint_index int
    Endpoint index
    endpoint_name str
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpoint_type str
    Type of the endpoint node. Interface: interface endpoint node.
    ip_address_versions Sequence[str]
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer str
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    private_dns_enabled bool
    Enable private DNS name. false (default): disabled. true: enabled.
    private_dns_name str
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    project_name str
    Name of the project to which the endpoint node belongs.
    security_group_ids Sequence[str]
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    service_id str
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    service_managed bool
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    service_name str
    Name of the endpoint service to be associated.
    status str
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags Sequence[VpcEndpointTagArgs]
    update_time str
    Most recent operation time of the endpoint.
    vpc_id str
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones Sequence[VpcEndpointZoneArgs]
    bps Number
    Maximum bandwidth limit for the endpoint node connection, in Mbps.
    businessStatus String
    Whether the endpoint is locked. Normal: Normal. FinancialLocked: Locked. If this parameter is empty, the endpoint is not locked.
    connectionStatus String
    Status of the endpoint node connection. PendingAcceptance: waiting for connection. Connecting: connecting. Connected: connected. Disconnecting: disconnecting. Rejected: connection rejected. Failed: connection failed. PartialFailed: partial connection failure. ServiceDeleted: service deleted.
    creationTime String
    Creation time of the endpoint.
    deletedTime String
    Deletion time of the endpoint.
    description String
    Description of the endpoint node. The default value is an empty string. It must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters.
    endpointDomain String
    Domain name of the endpoint.
    endpointId String
    ID of the endpoint node.
    endpointIndex Number
    Endpoint index
    endpointName String
    Endpoint name. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Length must be between 1 and 128 characters. If not specified, defaults to the endpoint ID.
    endpointType String
    Type of the endpoint node. Interface: interface endpoint node.
    ipAddressVersions List<String>
    IP protocol type for the interface endpoint. Options are ipv4 and ipv6. The default for interface endpoints is ipv4. If only ipv4 is used, do not provide this parameter. If the interface endpoint is dual stack (ipv4 & ipv6), you must provide this parameter. Before providing it, ensure the following: your account has enabled IPv6 for private network connections; the subnet associated with the interface endpoint has enabled the IPv6 segment; the endpoint service associated with the interface endpoint is dual stack. Parameter -N: indicates the sequence number of the IP protocol type for the interface endpoint, with a range of 1–2. Use & to separate the sequence numbers of the two IP protocol types. Currently, only providing IPv6 is not supported.
    payer String
    Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
    privateDnsEnabled Boolean
    Enable private DNS name. false (default): disabled. true: enabled.
    privateDnsName String
    The private DNS name of the endpoint node. If the parameter PrivateDNSEnabled returns false, this parameter is empty.
    projectName String
    Name of the project to which the endpoint node belongs.
    securityGroupIds List<String>
    ID of the security group to be bound to the endpoint. You can call the DescribeSecurityGroups API to obtain the security group ID. Parameter -N: Indicates the sequence number of the security group ID, value range: 1–5. Separate multiple security group IDs with &.
    serviceId String
    ID of the endpoint service to be associated. You can call the DescribeVpcEndpointServices API to obtain the endpoint service ID.
    serviceManaged Boolean
    Whether the endpoint is managed. false: Unmanaged endpoint. true: Managed endpoint.
    serviceName String
    Name of the endpoint service to be associated.
    status String
    Status of the endpoint. Creating: Creating. Pending: Modifying configuration. Available: Available. Deleting: Deleting.
    tags List<Property Map>
    updateTime String
    Most recent operation time of the endpoint.
    vpcId String
    ID of the VPC to which the endpoint belongs. You can call the DescribeVpcs API to obtain the VPC ID.
    zones List<Property Map>

    Supporting Types

    VpcEndpointTag, VpcEndpointTagArgs

    Key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    Value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    Key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    Value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key String
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value String
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key string
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value string
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key str
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value str
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @
    key String
    Tag key of the endpoint user tag. Length limit: 1–128 characters. Case sensitive. Cannot start with 'or' or 'sys:' in any case combination. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @.
    value String
    Tag value of the endpoint user tag. Length limit: 0–256 characters. Case sensitive. Cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and @

    VpcEndpointZone, VpcEndpointZoneArgs

    PrivateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    PrivateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    SubnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    ZoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    PrivateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    PrivateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    SubnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    ZoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    privateIpAddress String
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address String
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    subnetId String
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneId String
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    privateIpAddress string
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address string
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    subnetId string
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneId string
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    private_ip_address str
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    private_ipv6_address str
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    subnet_id str
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zone_id str
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.
    privateIpAddress String
    The private IPv4 address of the endpoint node's network interface must belong to the subnet's IPv4 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv4 address, with a value range of 1–10. Use & to separate multiple private IPv4 addresses.
    privateIpv6Address String
    The private IPv6 address of the endpoint node's network interface must belong to the subnet's IPv6 CIDR block. You can call the DescribeSubnets API to obtain the subnet's CIDR block. Parameter -N: indicates the sequence number of the private IPv6 address, with a value range of 1–10. Use & to separate multiple private IPv6 addresses. If not specified, an IPv6 address will be randomly assigned within the subnet's IPv6 CIDR block by default.
    subnetId String
    ID of the subnet to which the NIC of the endpoint to be created belongs. You can call the DescribeSubnets API to obtain the subnet ID. Parameter -N: Indicates the sequence number of the subnet ID, value range: 1–10. Separate multiple subnet IDs with &.
    zoneId String
    ID of the availability zone to which the NIC of the endpoint to be created belongs. For more information about availability zones, see Regions and Availability Zones. Parameter -N: Indicates the sequence number of the availability zone, value range: 1–10. Separate multiple availability zone IDs with &.

    Import

    $ pulumi import volcenginecc:privatelink/vpcEndpoint:VpcEndpoint example "endpoint_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.