ALIYUN::PrivateLink::VpcEndpointService is used to create an endpoint service.
Syntax
{
"Type": "ALIYUN::PrivateLink::VpcEndpointService",
"Properties": {
"User": List,
"ServiceDescription": String,
"Resource": List,
"ConnectBandwidth": Integer,
"AutoAcceptEnabled": Boolean,
"Payer": String,
"ZoneAffinityEnabled": Boolean,
"ServiceResourceType": String,
"Tags": List
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
User | List | No | Yes | The Alibaba Cloud accounts in the whitelist of the endpoint service. | You can add up to 20 Alibaba Cloud accounts to the whitelist. |
ServiceDescription | String | No | Yes | The description of the endpoint service. | The description must be 2 to 256 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter. |
Resource | List | No | Yes | The service resources that you want to add to the endpoint service. | You can add up to 20 service resources to the endpoint service. For more information, see the "Resource properties" section of this topic. |
ConnectBandwidth | Integer | No | Yes | The default maximum bandwidth. | Valid values: 100 to 1024. Unit: Mbit/s. |
AutoAcceptEnabled | Boolean | No | Yes | Specifies whether to automatically accept endpoint connection requests. | Valid values:
|
Payer | String | No | No | The payer. | Valid values:
|
ZoneAffinityEnabled | Boolean | No | Yes | Specifies whether to resolve domain names to IP addresses in the nearest zone. | Valid values:
|
ServiceResourceType | String | No | No | The type of the service resources. | Set the value to slb, which specifies Classic Load Balancer (CLB). |
Tags | List | No | Yes | The tags that you want to add to the resources. | You can add up to 20 tags. |
Resource syntax
"Resource": [
{
"ZoneId": String,
"ResourceId": String,
"ResourceType": String
}
]
Resource properties
Property | Type | Required | Editable | Description | Constraint |
ZoneId | String | Yes | No | The ID of the zone to which the service resource belongs. | None |
ResourceId | String | Yes | No | The service resource that you want to add to the endpoint service. | None |
ResourceType | String | Yes | No | The type of the service resource that you want to add to the endpoint service. | Set the value to slb. This value indicates the VPC-type Server Load Balancer (SLB) instances that support PrivateLink. Note Only SLB instances that support PrivateLink can be used as service resources for endpoint services. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Key | String | Yes | No | The tag key. | You can specify up to 20 tag keys. You cannot specify empty strings as tag keys. The tag key must be 1 to 64 characters in length and cannot start with |
Value | String | No | No | The tag value. | You can specify up to 20 tag values. The tag value can be an empty string. The tag value must be 1 to 128 characters in length and cannot start with |
Return values
Fn::GetAtt
ServiceName: the name of the endpoint service.
ServiceDomain: the domain name of the endpoint service.
ServiceId: the ID of the endpoint service.
ServiceDescription: the description of the endpoint service.
MinBandwidth: the minimum bandwidth of the endpoint connection.
MaxBandwidth: the maximum bandwidth of the endpoint connection.