Action Resource and Condition for RAM authorization - PrivateLink - Alibaba Cloud - PrivateLink

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. Using RAM helps you avoid sharing your Alibaba Cloud account keys with other users and allows you to grant users the least privilege access. RAM uses permission policies to define authorizations. This topic describes the general structure of a RAM policy, and the policy statement elements (Action, Resource, and Condition) defined by PrivateLink for RAM permission policies. The RAM code (RamCode) for PrivateLink is privatelink , and the supported authorization granularity is Resource-level .

General structure of a policy

Permission policies support JSON format with the following general structure:

{
  "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:

Version: Specifies the policy version number. It is fixed at 1.
Statement:
- Effect: Specifies the authorization result. Valid values: Allow and Deny.
- Action: Specifies one or more operations that are allowed or denied.
- Resource: Specifies the specific objects affected by the operations. You can use Alibaba Cloud Resource Names (ARNs) to describe specific resources.
- Condition: Specifies the conditions for the authorization to take effect. This field is optional.
  - Condition operator: Specifies the conditional operators. Different types of conditions support different conditional operators.
  - Condition_key: Specifies the condition keys.
  - Condition_value: Specifies the condition values.

Action

The following table lists the actions defined by PrivateLink. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding ARN in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys that are applicable across all RAM-integrated services. For more information, see Common condition keys.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	API	Access level	Resource type	Condition key	Dependent action
privatelink:DetachResourceFromVpcEndpointService	DetachResourceFromVpcEndpointService	update	*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:ListVpcEndpointServiceUsers	ListVpcEndpointServiceUsers	get	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:ListVpcEndpointServices	ListVpcEndpointServices	get	VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/`	None	None
privatelink:RemoveUserFromVpcEndpointService	RemoveUserFromVpcEndpointService	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:GetVpcEndpointServiceAttribute	GetVpcEndpointServiceAttribute	get	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:UpdateVpcEndpointAttribute	UpdateVpcEndpointAttribute	update	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:RemoveZoneFromVpcEndpoint	RemoveZoneFromVpcEndpoint	update	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:TagResources	TagResources	update	VpcEndpoint `acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId}` VpcEndpointService `acs:privatelink::{#accountId}:vpcendpointservice/{#vpcendpointserviceId}`	None	None
privatelink:AttachSecurityGroupToVpcEndpoint	AttachSecurityGroupToVpcEndpoint	update	VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}` SecurityGroup `acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}`	None	None
privatelink:ListVpcEndpointSecurityGroups	ListVpcEndpointSecurityGroups	get	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:DeleteVpcEndpointService	DeleteVpcEndpointService	delete	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:ListVpcEndpointConnections	ListVpcEndpointConnections	list	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:DisableVpcEndpointZoneConnection	DisableVpcEndpointZoneConnection	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}`	None	None
privatelink:ListVpcEndpointServiceResources	ListVpcEndpointServiceResources	get	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:CreateVpcEndpoint	CreateVpcEndpoint	create	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:DeleteVpcEndpoint	DeleteVpcEndpoint	delete	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:CheckProductOpen	CheckProductOpen	none	All Resources ``	None	None
privatelink:AddUserToVpcEndpointService	AddUserToVpcEndpointService	create	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:UpdateVpcEndpointConnectionAttribute	UpdateVpcEndpointConnectionAttribute	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:EnableVpcEndpointConnection	EnableVpcEndpointConnection	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:UpdateVpcEndpointServiceAttribute	UpdateVpcEndpointServiceAttribute	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:ChangeResourceGroup	ChangeResourceGroup	update	VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}` VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:DisableVpcEndpointConnection	DisableVpcEndpointConnection	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:ListVpcEndpointZones	ListVpcEndpointZones	get	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:CreateVpcEndpointService	CreateVpcEndpointService	create	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:UpdateVpcEndpointZoneConnectionResourceAttribute	UpdateVpcEndpointZoneConnectionResourceAttribute	update	VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}` LoadBalancer `acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}`	None	None
privatelink:DetachSecurityGroupFromVpcEndpoint	DetachSecurityGroupFromVpcEndpoint	update	VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}` SecurityGroup `acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}`	None	None
privatelink:EnableVpcEndpointZoneConnection	EnableVpcEndpointZoneConnection	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}`	None	None
privatelink:OpenPrivateLinkService	OpenPrivateLinkService	none	All Resources ``	None	None
privatelink:UntagResources	UntagResources	update	VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}` VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:ListVpcEndpointServicesByEndUser	ListVpcEndpointServicesByEndUser	get	VpcEndpointService `acs:privatelink:{#regionId}:{#AccountId}:vpcendpointservice/`	privatelink:VpcEndpointServiceId	None
privatelink:GetVpcEndpointAttribute	GetVpcEndpointAttribute	get	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:ListTagResources	ListTagResources	get	VpcEndpoint `acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId}` VpcEndpointService `acs:privatelink::{#accountId}:vpcendpointservice/{#vpcendpointserviceId}`	None	None
privatelink:ListVpcEndpoints	ListVpcEndpoints	get	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:UpdateVpcEndpointServiceResourceAttribute	UpdateVpcEndpointServiceResourceAttribute	update	VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}` LoadBalancer `acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}`	None	None
privatelink:VerifyVpcEndpointServicePrivateDns	VerifyVpcEndpointServicePrivateDns	update	*VpcEndpointService `acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}`	None	None
privatelink:AddZoneToVpcEndpoint	AddZoneToVpcEndpoint	create	*VpcEndpoint `acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}`	None	None
privatelink:AttachResourceToVpcEndpointService	AttachResourceToVpcEndpointService	update	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

Resource

The following table lists the resources defined by PrivateLink. Specify them in the Resource element of RAM policy statements to grant permissions for specific operations. They are uniquely identified by ARNs. Format: acs:{#ramcode}:{#regionId}:{#accountId}:{#resourceType}:

acs: The initialism of Alibaba Cloud service, which indicates the public cloud of Alibaba Cloud.
{#ramcode}: The code used in RAM to indicate an Alibaba Cloud service.
{#regionId}: The region ID. If the resource covers all regions, set it to an asterisk (*).
{#accountId}: The ID of the Alibaba Cloud account. If the resource covers all Alibaba Cloud accounts, set it to an asterisk (*).
{#resourceType}: The service-defined resource identifier. It supports a hierarchical structure, which is similar to a file path. If the statement covers global resources, set it to an asterisk (*).

Resource type	ARN
VpcEndpointService	acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId} acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/* acs:privatelink:*:{#accountId}:vpcendpointservice/{#vpcendpointserviceId} acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}
LoadBalancer	acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
NatGateway	acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}
VpcEndpoint	acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId} acs:privatelink::{#accountId}:vpcendpoint/{#vpcendpointId} 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}

Condition

The following table lists the product-level condition keys defined by PrivateLink. You can also use Alibaba Cloud's Common condition keys. Specify these keys in the Condition element of RAM policy statements to define granular authorization rules. In the condition key, specify the condition values in the Condition_value element of the policy.

Each condition key has a specific data type, such as string, number, Boolean, or IP address. The data type determines which conditional operators can be used to compare the request values against policy values. You must specify the conditional operators compatible with the data type of the condition key. Mismatched operators will invalidate the policy. See Condition operator for valid combinations.

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

How to create custom RAM policies?

You can create custom policies and grant them to RAM users, RAM user groups, or RAM roles. For instructions, see: