RAM authorization - PrivateLink - Alibaba Cloud Documentation Center

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. You can use RAM to prevent RAM users from sharing the AccessKey pairs of your Alibaba Cloud account. You can also use RAM to grant minimum permissions to RAM users. RAM uses policies to define permissions.

This topic describes the elements, such as Action, Resource, and Condition, which are defined by PrivateLink. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate PrivateLink is privatelink. You can grant permissions on PrivateLink at the RESOURCE.

General structure of a policy

Policies can be stored as JSON files. The following code provides an example on the general structure of a policy:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}

The following list describes the fields in the policy:

Effect: specifies the authorization effect. Valid values: Allow, Deny.
Action: specifies one or more API operations that are allowed or denied. For more information, see the Action section of this topic.
Resource: specifies one or more resources to which the policy applies. You can use an Alibaba Cloud Resource Name (ARN) to specify a resource. For more information, see the Resource section of this topic.
Condition: specifies one or more conditions that are required for the policy to take effect. This is an optional field. For more information, see the Condition section of this topic.
- Condition_operator: specifies the conditional operators. Different types of conditions support different conditional operators. For more information, see Policy elements.
- Condition_key: specifies the condition keys.
- Condition_value: specifies the condition values.

Action

PrivateLink defines the values that you can use in the Action element of a policy statement. The following table describes the values.

Operation: the value that you can use in the Action element to specify the operation on a resource.
API operation: the API operation that you can call to perform the operation.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition key: the condition keys that are defined by the Alibaba Cloud service. The Condition key column does not list the common condition keys that are defined by Alibaba Cloud. For more information about the common condition keys, see Generic Condition Keyword.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Actions	API operation	Access level	Resource type	Condition key	Associated operation
privatelink:AddUserToVpcEndpointService	AddUserToVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:AddZoneToVpcEndpoint	AddZoneToVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:AttachResourceToVpcEndpointService	AttachResourceToVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId} LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}	None	None
privatelink:AttachSecurityGroupToVpcEndpoint	AttachSecurityGroupToVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId} SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}	None	None
privatelink:CreateVpcEndpoint	CreateVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/* SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId} VSwitch acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId} VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}	privatelink:VpcEndpointServiceId	None
privatelink:CreateVpcEndpointService	CreateVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/* LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId} LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	None	None
privatelink:DeleteVpcEndpoint	DeleteVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:DeleteVpcEndpointService	DeleteVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:DetachResourceFromVpcEndpointService	DetachResourceFromVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId} LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}	None	None
privatelink:DetachSecurityGroupFromVpcEndpoint	DetachSecurityGroupFromVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId} SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}	None	None
privatelink:DisableVpcEndpointConnection	DisableVpcEndpointConnection	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:DisableVpcEndpointZoneConnection	DisableVpcEndpointZoneConnection	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}	None	None
privatelink:EnableVpcEndpointConnection	EnableVpcEndpointConnection	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:GetVpcEndpointAttribute	GetVpcEndpointAttribute	Read	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:GetVpcEndpointServiceAttribute	GetVpcEndpointServiceAttribute	Read	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:ListTagResources	ListTagResources	Read	VpcEndpoint acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId} VpcEndpointService acs:privatelink::{#accountId}:vpcendpointservice/{#vpcendpointserviceId}	None	None
privatelink:ListVpcEndpointConnections	ListVpcEndpointConnections	Read	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*	None	None
privatelink:ListVpcEndpointSecurityGroups	ListVpcEndpointSecurityGroups	List	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:ListVpcEndpointServiceResources	ListVpcEndpointServiceResources	List	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:ListVpcEndpointServiceUsers	ListVpcEndpointServiceUsers	List	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:ListVpcEndpointServices	ListVpcEndpointServices	Read	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*	None	None
privatelink:ListVpcEndpointServicesByEndUser	ListVpcEndpointServicesByEndUser	Read	All Resources *	privatelink:VpcEndpointServiceId	None
privatelink:ListVpcEndpointZones	ListVpcEndpointZones	Read	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:ListVpcEndpoints	ListVpcEndpoints	Read	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:RemoveUserFromVpcEndpointService	RemoveUserFromVpcEndpointService	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:RemoveZoneFromVpcEndpoint	RemoveZoneFromVpcEndpoint	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:TagResources	TagResources	Write	VpcEndpoint acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId} VpcEndpointService acs:privatelink::{#accountId}:vpcendpointservice/{#vpcendpointserviceId}	None	None
privatelink:UntagResources	UntagResources	Write	All Resources *	None	None
privatelink:UpdateVpcEndpointAttribute	UpdateVpcEndpointAttribute	Write	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}	None	None
privatelink:UpdateVpcEndpointConnectionAttribute	UpdateVpcEndpointConnectionAttribute	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:UpdateVpcEndpointServiceAttribute	UpdateVpcEndpointServiceAttribute	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	None	None
privatelink:UpdateVpcEndpointServiceResourceAttribute	UpdateVpcEndpointServiceResourceAttribute	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId} LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	None	None
privatelink:UpdateVpcEndpointZoneConnectionResourceAttribute	UpdateVpcEndpointZoneConnectionResourceAttribute	Write	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId} LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}	None	None

Resource

PrivateLink defines the values that you can use in the Resource. You can attach the policy to a RAM user or a RAM role so that the RAM user or the RAM role can perform a specific operation on a specific resource. The ARN is the unique identifier of the resource on Alibaba Cloud. Take note of the following items:

{#}indicates a variable. {#} must be replaced with an actual value. For example, {#ramcode} must be replaced with the actual code of an Alibaba Cloud service in RAM.
An asterisk (*) is used as a wildcard. Examples:
- {#resourceType} is set to *, all resources are specified.
- {#regionId} is set to *, all regions are specified.
- {#accountId} is set to *, all Alibaba Cloud accounts are specified.

Resource type	ARN
VpcEndpoint	acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
VpcEndpointService	acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

Condition

PrivateLink defines the values that you can use in the Condition element of a policy statement. The following table describes the values. The following table describes the service-specific condition keys. The common condition keys that are defined by Alibaba Cloud also apply to PrivateLink. For more information about the common condition keys, see Generic Condition Keyword.

The data type determines the conditional operators that you can use to compare the value in a request with the value in a policy statement. You must use conditional operators that are supported by the data type. Otherwise, you cannot compare the value in the request with the value in the policy statement. In this case, the authorization is invalid. For more information about the conditional operators that are supported by each data type, see Policy elements.

Condition key	Description	Data type
privatelink:VpcEndpointServiceId	The endpoint service ID	STRING

What to do next

You can create a custom policy and attach the policy to a RAM user, RAM user group, or RAM role. For more information, see the following topics: