RAM authorization

Updated at:

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 Hardware Security Module (HSM) for RAM permission policies. The RAM code (RamCode) for Cloud Hardware Security Module (HSM) is yundun-hsm , and the supported authorization granularity is OPERATION .

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 Hardware Security Module (HSM). 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

yundun-hsm:ListImages ListImages list

*All Resource

*

None None
yundun-hsm:ResumeInstance ResumeInstance update

*All Resource

*

None None
yundun-hsm:SwitchClusterMaster SwitchClusterMaster update

*All Resource

*

None None
yundun-hsm:LeaveCluster LeaveCluster update

*All Resource

*

None None
yundun-hsm:EnableBackup EnableBackup update

*All Resource

*

None None
yundun-hsm:InitializeCluster InitializeCluster update

*All Resource

*

None None
yundun-hsm:ConfigInstanceWhitelist ConfigInstanceWhitelist update

*All Resource

*

None None
yundun-hsm:ResetInstance ResetInstance update

*All Resource

*

None None
yundun-hsm:PauseInstance PauseInstance update

*All Resource

*

None None
yundun-hsm:JoinCluster JoinCluster update

*All Resource

*

None None
yundun-hsm:ListBackups ListBackups list

*All Resource

*

None None
yundun-hsm:QuickInitInstance QuickInitInstance update

*All Resource

*

None None
yundun-hsm:ConfigAuditLog ConfigAuditLog update

*All Resource

*

None None
yundun-hsm:ExportImage ExportImage none

*All Resource

*

None None
yundun-hsm:DescribeTrialStatus GetTrialStatus get

*All Resource

*

None None
yundun-hsm:GetAuditLogStatus GetAuditLogStatus get

*All Resource

*

None None
yundun-hsm:DescribeRegions DescribeRegions list

*All Resource

*

None None
yundun-hsm:ConfigInstanceRemark ConfigInstanceRemark update

*All Resource

*

None None
yundun-hsm:ListClusters ListClusters get

*All Resource

*

None None
yundun-hsm:GetJob GetJob get

*All Resource

*

None None
yundun-hsm:RestoreInstance RestoreInstance update

*All Resource

*

None None
yundun-hsm:ConfigBackupTask ConfigBackupTask update

*All Resource

*

None None
yundun-hsm:CopyImage CopyImage update

*All Resource

*

None None
yundun-hsm:ListInstances ListInstances get

*All Resource

*

None None
yundun-hsm:GetBackup GetBackup get

*All Resource

*

None None
yundun-hsm:ConfigClusterSubnet ConfigClusterSubnet update

*All Resource

*

None None
yundun-hsm:DownloadClusterManagedCert DownloadClusterManagedCert get

*All Resource

*

None None
yundun-hsm:GetInstance GetInstance get

*All Resource

*

None None
yundun-hsm:CreateCluster CreateCluster create

*All Resource

*

None None
yundun-hsm:MoveResourceGroup MoveResourceGroup update

*All Resource

*

None None
yundun-hsm:ConfigBackupRemark ConfigBackupRemark update

*All Resource

*

None None
yundun-hsm:InitializeAuditLog InitializeAuditLog update

*All Resource

*

None None
yundun-hsm:ConfigInstanceIpAddress ConfigInstanceIpAddress update

*All Resource

*

None None
yundun-hsm:GetImage GetImage get

*All Resource

*

None None
yundun-hsm:DeleteCluster DeleteCluster delete

*All Resource

*

None None
yundun-hsm:QuickDeployCluster QuickDeployCluster create

*All Resource

*

None None
yundun-hsm:ResetBackup ResetBackup update

*All Resource

*

None None
yundun-hsm:GetInstanceInternalStatus GetInstanceInternalStatus get

*All Resource

*

None None
yundun-hsm:SyncCluster SyncCluster update

*All Resource

*

None None
yundun-hsm:ConfigClusterName ConfigClusterName update

*All Resource

*

None None
yundun-hsm:ConfigClusterWhitelist ConfigClusterWhitelist update

*All Resource

*

None None
yundun-hsm:GetCluster GetCluster get

*All Resource

*

None None
yundun-hsm:ConfigImageRemark ConfigImageRemark

*All Resource

*

None None
yundun-hsm:ConfigClusterCertificate ConfigClusterCertificate update

*All Resource

*

None None
yundun-hsm:RotateClusterManagedCert RotateClusterManagedCert update

*All Resource

*

None None

Resource

The following table lists the resources defined by Cloud Hardware Security Module (HSM). 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

Condition

Cloud Hardware Security Module (HSM) 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: