RAM authorization - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

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 Cloud Architect Design Tools for RAM permission policies. The RAM code (RamCode) for Cloud Architect Design Tools is bpstudio , and the supported authorization granularity is RESOURCE .

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 Cloud Architect Design Tools. 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
bpstudio:InitAppFailOver	InitAppFailOver	update	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ReConfigApplication	ReConfigApplication	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ValuateTemplate	ValuateTemplate	get	*Template `acs:bpstudio::{#accountId}:template/{#TemplateId}`	None	None
bpstudio:ListOperations	ListOperations	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ListTemplate	ListTemplate	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:QueryInstancePrice4Modify	QueryInstancePrice4Modify	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ValidateApplication	ValidateApplication	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ExecuteOperationASync	ExecuteOperationASync	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ReleaseApplication	ReleaseApplication	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetOperationParams	GetOperationParams	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetLinkageAttributesTemplate	GetLinkageAttributesTemplate	get	*Template `acs:bpstudio::{#accountId}:template/{#TemplateId}`	None	None
bpstudio:GetTemplate	GetTemplate	get	*Template `acs:bpstudio::{#accountId}:template/{#TemplateId}`	None	None
bpstudio:ListTagResources	ListTagResources	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetApplicationVariables	GetApplicationVariables	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetPotentialFailZones	GetPotentialFailZones	list	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ListServices	ListServices	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetToken	GetToken	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ListApplication	ListApplication	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetTask	GetTask	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetApplicationVariables4Fail	GetApplicationVariables4Fail	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ExecuteOperationSync	ExecuteOperationSync	update	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:AppFailOver	AppFailOver	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:AppFailBack	AppFailBack	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:CreateTask	CreateTask	create	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetFoTaskStatus	GetFoTaskStatus	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:DeployApplication	DeployApplication	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ChangeResourceGroup	ChangeResourceGroup	update	BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ModifyApplicationSpec	ModifyApplicationSpec	none	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:DeleteApplication	DeleteApplication	delete	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetExecuteOperationResult	GetExecuteOperationResult	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:GetResource4ModifyRecord	GetResource4ModifyRecord	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ValuateApplication	ValuateApplication	update	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetApplication	GetApplication	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:ExecuteTask	ExecuteTask	create	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:CreateApplication	CreateApplication	create	*Template `acs:bpstudio::{#accountId}:template/{#TemplateId}`	None	None
bpstudio:QueryInstanceSpec4Modify	QueryInstanceSpec4Modify	get	*Application `acs:bpstudio::{#accountId}:application/{#ApplicationId}`	None	None
bpstudio:GetResult4QueryInstancePrice4Modify	GetResult4QueryInstancePrice4Modify	get	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None
bpstudio:ListFoCreatedApps	ListFoCreatedApps	list	*BPStudioVirtual `acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}`	None	None

Resource

The following table lists the resources defined by Cloud Architect Design Tools. 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
BPStudioVirtual	acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId} acs:bpstudio:*:{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}
Application	acs:bpstudio::{#accountId}:application/{#ApplicationId}
Template	acs:bpstudio::{#accountId}:template/{#TemplateId}

Condition

Cloud Architect Design Tools does not define product-level condition keys. However, you can use Alibaba Cloud common condition keys for access control. For more information, see Common condition keys.

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: