published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
The endpoint service enables private network connections between VPCs via endpoints.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
privateLinkEndpointServiceDemo:
type: volcenginecc:privatelink:EndpointService
name: PrivateLinkEndpointServiceDemo
properties:
serviceType: Interface
ipAddressVersions:
- ipv4
serviceResourceType: CLB
resources:
- resource_id: clb-rr0o8ni4dxxxx58wxxxxx
zone_ids: []
autoAcceptEnabled: true
privateDnsEnabled: true
privateDnsType: public
privateDnsName: '*.www.example.com'
description: PrivateLinkEndpointServiceDemo description
projectName: default
tags:
- key: env
value: test
Create EndpointService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EndpointService(name: string, args?: EndpointServiceArgs, opts?: CustomResourceOptions);@overload
def EndpointService(resource_name: str,
args: Optional[EndpointServiceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def EndpointService(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_accept_enabled: Optional[bool] = None,
description: Optional[str] = None,
ip_address_versions: Optional[Sequence[str]] = None,
payer: Optional[str] = None,
permit_account_ids: Optional[Sequence[str]] = None,
private_dns_enabled: Optional[bool] = None,
private_dns_name: Optional[str] = None,
private_dns_type: Optional[str] = None,
project_name: Optional[str] = None,
resources: Optional[Sequence[EndpointServiceResourceArgs]] = None,
service_name_managed: Optional[str] = None,
service_name_suffix: Optional[str] = None,
service_owner: Optional[str] = None,
service_resource_type: Optional[str] = None,
service_type: Optional[str] = None,
tags: Optional[Sequence[EndpointServiceTagArgs]] = None,
wildcard_domain_enabled: Optional[bool] = None)func NewEndpointService(ctx *Context, name string, args *EndpointServiceArgs, opts ...ResourceOption) (*EndpointService, error)public EndpointService(string name, EndpointServiceArgs? args = null, CustomResourceOptions? opts = null)
public EndpointService(String name, EndpointServiceArgs args)
public EndpointService(String name, EndpointServiceArgs args, CustomResourceOptions options)
type: volcenginecc:privatelink:EndpointService
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 EndpointServiceArgs
- 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 EndpointServiceArgs
- 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 EndpointServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointServiceArgs
- 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 endpointServiceResource = new Volcenginecc.Privatelink.EndpointService("endpointServiceResource", new()
{
AutoAcceptEnabled = false,
Description = "string",
IpAddressVersions = new[]
{
"string",
},
Payer = "string",
PermitAccountIds = new[]
{
"string",
},
PrivateDnsEnabled = false,
PrivateDnsName = "string",
PrivateDnsType = "string",
ProjectName = "string",
Resources = new[]
{
new Volcenginecc.Privatelink.Inputs.EndpointServiceResourceArgs
{
ResourceId = "string",
ZoneIds = new[]
{
"string",
},
},
},
ServiceNameManaged = "string",
ServiceNameSuffix = "string",
ServiceOwner = "string",
ServiceResourceType = "string",
ServiceType = "string",
Tags = new[]
{
new Volcenginecc.Privatelink.Inputs.EndpointServiceTagArgs
{
Key = "string",
Value = "string",
},
},
WildcardDomainEnabled = false,
});
example, err := privatelink.NewEndpointService(ctx, "endpointServiceResource", &privatelink.EndpointServiceArgs{
AutoAcceptEnabled: pulumi.Bool(false),
Description: pulumi.String("string"),
IpAddressVersions: pulumi.StringArray{
pulumi.String("string"),
},
Payer: pulumi.String("string"),
PermitAccountIds: pulumi.StringArray{
pulumi.String("string"),
},
PrivateDnsEnabled: pulumi.Bool(false),
PrivateDnsName: pulumi.String("string"),
PrivateDnsType: pulumi.String("string"),
ProjectName: pulumi.String("string"),
Resources: privatelink.EndpointServiceResourceArray{
&privatelink.EndpointServiceResourceArgs{
ResourceId: pulumi.String("string"),
ZoneIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ServiceNameManaged: pulumi.String("string"),
ServiceNameSuffix: pulumi.String("string"),
ServiceOwner: pulumi.String("string"),
ServiceResourceType: pulumi.String("string"),
ServiceType: pulumi.String("string"),
Tags: privatelink.EndpointServiceTagArray{
&privatelink.EndpointServiceTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
WildcardDomainEnabled: pulumi.Bool(false),
})
var endpointServiceResource = new EndpointService("endpointServiceResource", EndpointServiceArgs.builder()
.autoAcceptEnabled(false)
.description("string")
.ipAddressVersions("string")
.payer("string")
.permitAccountIds("string")
.privateDnsEnabled(false)
.privateDnsName("string")
.privateDnsType("string")
.projectName("string")
.resources(EndpointServiceResourceArgs.builder()
.resourceId("string")
.zoneIds("string")
.build())
.serviceNameManaged("string")
.serviceNameSuffix("string")
.serviceOwner("string")
.serviceResourceType("string")
.serviceType("string")
.tags(EndpointServiceTagArgs.builder()
.key("string")
.value("string")
.build())
.wildcardDomainEnabled(false)
.build());
endpoint_service_resource = volcenginecc.privatelink.EndpointService("endpointServiceResource",
auto_accept_enabled=False,
description="string",
ip_address_versions=["string"],
payer="string",
permit_account_ids=["string"],
private_dns_enabled=False,
private_dns_name="string",
private_dns_type="string",
project_name="string",
resources=[{
"resource_id": "string",
"zone_ids": ["string"],
}],
service_name_managed="string",
service_name_suffix="string",
service_owner="string",
service_resource_type="string",
service_type="string",
tags=[{
"key": "string",
"value": "string",
}],
wildcard_domain_enabled=False)
const endpointServiceResource = new volcenginecc.privatelink.EndpointService("endpointServiceResource", {
autoAcceptEnabled: false,
description: "string",
ipAddressVersions: ["string"],
payer: "string",
permitAccountIds: ["string"],
privateDnsEnabled: false,
privateDnsName: "string",
privateDnsType: "string",
projectName: "string",
resources: [{
resourceId: "string",
zoneIds: ["string"],
}],
serviceNameManaged: "string",
serviceNameSuffix: "string",
serviceOwner: "string",
serviceResourceType: "string",
serviceType: "string",
tags: [{
key: "string",
value: "string",
}],
wildcardDomainEnabled: false,
});
type: volcenginecc:privatelink:EndpointService
properties:
autoAcceptEnabled: false
description: string
ipAddressVersions:
- string
payer: string
permitAccountIds:
- string
privateDnsEnabled: false
privateDnsName: string
privateDnsType: string
projectName: string
resources:
- resourceId: string
zoneIds:
- string
serviceNameManaged: string
serviceNameSuffix: string
serviceOwner: string
serviceResourceType: string
serviceType: string
tags:
- key: string
value: string
wildcardDomainEnabled: false
EndpointService 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 EndpointService resource accepts the following input properties:
- Auto
Accept boolEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- Description string
- Description of the endpoint service.
- Ip
Address List<string>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- Payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- Permit
Account List<string>Ids - Details of authorized allowlist accounts.
- Private
Dns boolEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- Private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- Private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- Project
Name string - Project name to which the endpoint service belongs.
- Resources
List<Volcengine.
Endpoint Service Resource> - Service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- Service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- Service
Owner string - Current service principal.
- Service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- Service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
-
List<Volcengine.
Endpoint Service Tag> - Wildcard
Domain boolEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- Auto
Accept boolEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- Description string
- Description of the endpoint service.
- Ip
Address []stringVersions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- Payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- Permit
Account []stringIds - Details of authorized allowlist accounts.
- Private
Dns boolEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- Private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- Private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- Project
Name string - Project name to which the endpoint service belongs.
- Resources
[]Endpoint
Service Resource Args - Service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- Service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- Service
Owner string - Current service principal.
- Service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- Service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
-
[]Endpoint
Service Tag Args - Wildcard
Domain boolEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- auto
Accept BooleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- description String
- Description of the endpoint service.
- ip
Address List<String>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer String
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account List<String>Ids - Details of authorized allowlist accounts.
- private
Dns BooleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns StringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns StringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name String - Project name to which the endpoint service belongs.
- resources
List<Endpoint
Service Resource> - service
Name StringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name StringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner String - Current service principal.
- service
Resource StringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type String - Type of the endpoint service. Interface: Interface endpoint service.
-
List<Endpoint
Service Tag> - wildcard
Domain BooleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- auto
Accept booleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- description string
- Description of the endpoint service.
- ip
Address string[]Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account string[]Ids - Details of authorized allowlist accounts.
- private
Dns booleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name string - Project name to which the endpoint service belongs.
- resources
Endpoint
Service Resource[] - service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner string - Current service principal.
- service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
-
Endpoint
Service Tag[] - wildcard
Domain booleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- auto_
accept_ boolenabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- description str
- Description of the endpoint service.
- ip_
address_ Sequence[str]versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer str
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit_
account_ Sequence[str]ids - Details of authorized allowlist accounts.
- private_
dns_ boolenabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private_
dns_ strname - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private_
dns_ strtype - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project_
name str - Project name to which the endpoint service belongs.
- resources
Sequence[Endpoint
Service Resource Args] - service_
name_ strmanaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service_
name_ strsuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service_
owner str - Current service principal.
- service_
resource_ strtype - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service_
type str - Type of the endpoint service. Interface: Interface endpoint service.
-
Sequence[Endpoint
Service Tag Args] - wildcard_
domain_ boolenabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- auto
Accept BooleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- description String
- Description of the endpoint service.
- ip
Address List<String>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer String
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account List<String>Ids - Details of authorized allowlist accounts.
- private
Dns BooleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns StringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns StringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name String - Project name to which the endpoint service belongs.
- resources List<Property Map>
- service
Name StringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name StringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner String - Current service principal.
- service
Resource StringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type String - Type of the endpoint service. Interface: Interface endpoint service.
- List<Property Map>
- wildcard
Domain BooleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
Outputs
All input properties are implicitly available as output properties. Additionally, the EndpointService resource produces the following output properties:
- Billing
Type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- Business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- Create
Time string - Creation time of the endpoint service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Dns Volcengine.Name Configuration Endpoint Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- Service
Domain string - Service domain name of the endpoint service.
- Service
Id string - Endpoint service ID.
- Service
Name string - Name of the endpoint service.
- Status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- Update
Time string - Most recent operation time of the endpoint service.
- Zone
Ids List<string> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- Billing
Type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- Business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- Create
Time string - Creation time of the endpoint service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Private
Dns EndpointName Configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- Service
Domain string - Service domain name of the endpoint service.
- Service
Id string - Endpoint service ID.
- Service
Name string - Name of the endpoint service.
- Status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- Update
Time string - Most recent operation time of the endpoint service.
- Zone
Ids []string - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- billing
Type Integer - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status String - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time String - Creation time of the endpoint service.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Dns EndpointName Configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- service
Domain String - Service domain name of the endpoint service.
- service
Id String - Endpoint service ID.
- service
Name String - Name of the endpoint service.
- status String
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- update
Time String - Most recent operation time of the endpoint service.
- zone
Ids List<String> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- billing
Type number - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time string - Creation time of the endpoint service.
- id string
- The provider-assigned unique ID for this managed resource.
- private
Dns EndpointName Configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- service
Domain string - Service domain name of the endpoint service.
- service
Id string - Endpoint service ID.
- service
Name string - Name of the endpoint service.
- status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- update
Time string - Most recent operation time of the endpoint service.
- zone
Ids string[] - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- billing_
type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business_
status str - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create_
time str - Creation time of the endpoint service.
- id str
- The provider-assigned unique ID for this managed resource.
- private_
dns_ Endpointname_ configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- service_
domain str - Service domain name of the endpoint service.
- service_
id str - Endpoint service ID.
- service_
name str - Name of the endpoint service.
- status str
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- update_
time str - Most recent operation time of the endpoint service.
- zone_
ids Sequence[str] - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- billing
Type Number - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status String - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time String - Creation time of the endpoint service.
- id String
- The provider-assigned unique ID for this managed resource.
- private
Dns Property MapName Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- service
Domain String - Service domain name of the endpoint service.
- service
Id String - Endpoint service ID.
- service
Name String - Name of the endpoint service.
- status String
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- update
Time String - Most recent operation time of the endpoint service.
- zone
Ids List<String> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
Look up Existing EndpointService Resource
Get an existing EndpointService 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?: EndpointServiceState, opts?: CustomResourceOptions): EndpointService@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_accept_enabled: Optional[bool] = None,
billing_type: Optional[int] = None,
business_status: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
ip_address_versions: Optional[Sequence[str]] = None,
payer: Optional[str] = None,
permit_account_ids: Optional[Sequence[str]] = None,
private_dns_enabled: Optional[bool] = None,
private_dns_name: Optional[str] = None,
private_dns_name_configuration: Optional[EndpointServicePrivateDnsNameConfigurationArgs] = None,
private_dns_type: Optional[str] = None,
project_name: Optional[str] = None,
resources: Optional[Sequence[EndpointServiceResourceArgs]] = None,
service_domain: Optional[str] = None,
service_id: Optional[str] = None,
service_name: Optional[str] = None,
service_name_managed: Optional[str] = None,
service_name_suffix: Optional[str] = None,
service_owner: Optional[str] = None,
service_resource_type: Optional[str] = None,
service_type: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Sequence[EndpointServiceTagArgs]] = None,
update_time: Optional[str] = None,
wildcard_domain_enabled: Optional[bool] = None,
zone_ids: Optional[Sequence[str]] = None) -> EndpointServicefunc GetEndpointService(ctx *Context, name string, id IDInput, state *EndpointServiceState, opts ...ResourceOption) (*EndpointService, error)public static EndpointService Get(string name, Input<string> id, EndpointServiceState? state, CustomResourceOptions? opts = null)public static EndpointService get(String name, Output<String> id, EndpointServiceState state, CustomResourceOptions options)resources: _: type: volcenginecc:privatelink:EndpointService 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.
- Auto
Accept boolEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- Billing
Type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- Business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- Create
Time string - Creation time of the endpoint service.
- Description string
- Description of the endpoint service.
- Ip
Address List<string>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- Payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- Permit
Account List<string>Ids - Details of authorized allowlist accounts.
- Private
Dns boolEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- Private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- Private
Dns Volcengine.Name Configuration Endpoint Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- Private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- Project
Name string - Project name to which the endpoint service belongs.
- Resources
List<Volcengine.
Endpoint Service Resource> - Service
Domain string - Service domain name of the endpoint service.
- Service
Id string - Endpoint service ID.
- Service
Name string - Name of the endpoint service.
- Service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- Service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- Service
Owner string - Current service principal.
- Service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- Service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
- Status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
-
List<Volcengine.
Endpoint Service Tag> - Update
Time string - Most recent operation time of the endpoint service.
- Wildcard
Domain boolEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- Zone
Ids List<string> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- Auto
Accept boolEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- Billing
Type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- Business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- Create
Time string - Creation time of the endpoint service.
- Description string
- Description of the endpoint service.
- Ip
Address []stringVersions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- Payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- Permit
Account []stringIds - Details of authorized allowlist accounts.
- Private
Dns boolEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- Private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- Private
Dns EndpointName Configuration Service Private Dns Name Configuration Args - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- Private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- Project
Name string - Project name to which the endpoint service belongs.
- Resources
[]Endpoint
Service Resource Args - Service
Domain string - Service domain name of the endpoint service.
- Service
Id string - Endpoint service ID.
- Service
Name string - Name of the endpoint service.
- Service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- Service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- Service
Owner string - Current service principal.
- Service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- Service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
- Status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
-
[]Endpoint
Service Tag Args - Update
Time string - Most recent operation time of the endpoint service.
- Wildcard
Domain boolEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- Zone
Ids []string - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- auto
Accept BooleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- billing
Type Integer - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status String - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time String - Creation time of the endpoint service.
- description String
- Description of the endpoint service.
- ip
Address List<String>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer String
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account List<String>Ids - Details of authorized allowlist accounts.
- private
Dns BooleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns StringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns EndpointName Configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- private
Dns StringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name String - Project name to which the endpoint service belongs.
- resources
List<Endpoint
Service Resource> - service
Domain String - Service domain name of the endpoint service.
- service
Id String - Endpoint service ID.
- service
Name String - Name of the endpoint service.
- service
Name StringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name StringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner String - Current service principal.
- service
Resource StringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type String - Type of the endpoint service. Interface: Interface endpoint service.
- status String
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
-
List<Endpoint
Service Tag> - update
Time String - Most recent operation time of the endpoint service.
- wildcard
Domain BooleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- zone
Ids List<String> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- auto
Accept booleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- billing
Type number - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status string - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time string - Creation time of the endpoint service.
- description string
- Description of the endpoint service.
- ip
Address string[]Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer string
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account string[]Ids - Details of authorized allowlist accounts.
- private
Dns booleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns stringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns EndpointName Configuration Service Private Dns Name Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- private
Dns stringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name string - Project name to which the endpoint service belongs.
- resources
Endpoint
Service Resource[] - service
Domain string - Service domain name of the endpoint service.
- service
Id string - Endpoint service ID.
- service
Name string - Name of the endpoint service.
- service
Name stringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name stringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner string - Current service principal.
- service
Resource stringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type string - Type of the endpoint service. Interface: Interface endpoint service.
- status string
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
-
Endpoint
Service Tag[] - update
Time string - Most recent operation time of the endpoint service.
- wildcard
Domain booleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- zone
Ids string[] - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- auto_
accept_ boolenabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- billing_
type int - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business_
status str - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create_
time str - Creation time of the endpoint service.
- description str
- Description of the endpoint service.
- ip_
address_ Sequence[str]versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer str
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit_
account_ Sequence[str]ids - Details of authorized allowlist accounts.
- private_
dns_ boolenabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private_
dns_ strname - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private_
dns_ Endpointname_ configuration Service Private Dns Name Configuration Args - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- private_
dns_ strtype - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project_
name str - Project name to which the endpoint service belongs.
- resources
Sequence[Endpoint
Service Resource Args] - service_
domain str - Service domain name of the endpoint service.
- service_
id str - Endpoint service ID.
- service_
name str - Name of the endpoint service.
- service_
name_ strmanaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service_
name_ strsuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service_
owner str - Current service principal.
- service_
resource_ strtype - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service_
type str - Type of the endpoint service. Interface: Interface endpoint service.
- status str
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
-
Sequence[Endpoint
Service Tag Args] - update_
time str - Most recent operation time of the endpoint service.
- wildcard_
domain_ boolenabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- zone_
ids Sequence[str] - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
- auto
Accept BooleanEnabled - Whether to automatically accept endpoint connections. true: The endpoint service automatically accepts endpoint connections. false: The endpoint service does not automatically accept endpoint connections; you must manually accept them by calling the EnableVpcEndpointConnection API.
- billing
Type Number - Billing type of the endpoint service. 0: No charge. 3: Pay-as-you-go.
- business
Status String - Whether the endpoint service is locked. Normal: normal. FinancialLocked: locked. If this parameter is empty, the endpoint service is not locked.
- create
Time String - Creation time of the endpoint service.
- description String
- Description of the endpoint service.
- ip
Address List<String>Versions - IP protocol type of the endpoint service. If the return value only contains ipv4, the endpoint service is IPv4 type and only supports IPv4 services. If the return value contains both ipv4 and ipv6, the endpoint service is dual-stack and supports both IPv4 and IPv6 services.
- payer String
- Billing account for the private network connection. Endpoint: endpoint account. EndpointService: endpoint service account.
- permit
Account List<String>Ids - Details of authorized allowlist accounts.
- private
Dns BooleanEnabled - Whether the endpoint service enables private DNS name. false: Not enabled. true: Enabled.
- private
Dns StringName - Private DNS name of the endpoint service. If the PrivateDNSEnabled parameter returns false, this parameter is empty.
- private
Dns Property MapName Configuration - Configuration information for the private DNS name of the endpoint service. Note: If PrivateDNSType is private, this parameter is not returned.
- private
Dns StringType - Domain name type of the private DNS name. public: public network. Note: If the custom private domain name feature is not enabled, this parameter is not returned.
- project
Name String - Project name to which the endpoint service belongs.
- resources List<Property Map>
- service
Domain String - Service domain name of the endpoint service.
- service
Id String - Endpoint service ID.
- service
Name String - Name of the endpoint service.
- service
Name StringManaged - Whether this is a managed endpoint service. false: not a managed endpoint service. true: managed endpoint service. If the account owning the endpoint service has not enabled managed endpoint service functionality, this parameter is not returned.
- service
Name StringSuffix - Suffix for the endpoint service name. This parameter is currently in beta testing. If you need to use different name suffixes to distinguish business scenarios, please contact your account manager.
- service
Owner String - Current service principal.
- service
Resource StringType - Type of service resource. CLB: Load Balancer CLB. ALB: Application Load Balancer ALB. RDSMySQL: Cloud Database MySQL Edition.
- service
Type String - Type of the endpoint service. Interface: Interface endpoint service.
- status String
- Status of the endpoint service. Creating: being created. Pending: configuration being modified. Available: available. Deleting: being deleted.
- List<Property Map>
- update
Time String - Most recent operation time of the endpoint service.
- wildcard
Domain BooleanEnabled - Whether to enable wildcard domain name. true: Enabled. false: Not enabled.
- zone
Ids List<String> - Availability zone where the endpoint service provides service. Note: If the ServiceResourceType parameter returns RDSMySQL, this parameter returns an empty value.
Supporting Types
EndpointServicePrivateDnsNameConfiguration, EndpointServicePrivateDnsNameConfigurationArgs
EndpointServiceResource, EndpointServiceResourceArgs
- Resource
Id string - Service resource ID to be added to the endpoint service.
- Zone
Ids List<string> - Availability zone where the load balancer provides service.
- Resource
Id string - Service resource ID to be added to the endpoint service.
- Zone
Ids []string - Availability zone where the load balancer provides service.
- resource
Id String - Service resource ID to be added to the endpoint service.
- zone
Ids List<String> - Availability zone where the load balancer provides service.
- resource
Id string - Service resource ID to be added to the endpoint service.
- zone
Ids string[] - Availability zone where the load balancer provides service.
- resource_
id str - Service resource ID to be added to the endpoint service.
- zone_
ids Sequence[str] - Availability zone where the load balancer provides service.
- resource
Id String - Service resource ID to be added to the endpoint service.
- zone
Ids List<String> - Availability zone where the load balancer provides service.
EndpointServiceTag, EndpointServiceTagArgs
Import
$ pulumi import volcenginecc:privatelink/endpointService:EndpointService example "service_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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
