Updated on 2024-04-10 GMT+08:00

Resource Access Manager (RAM)

The Organizations service provides Service Control Policies to set access control policies.

SCPs do not actually grant any permissions to a principal. They only set the permissions boundary for the principal. When SCPs are attached to an organizational unit (OU) or a member account, the SCPs do not directly grant permissions to that OU or member account. Instead, the SCPs only determine what permissions are available for that member account or those member accounts under that OU.

This section describes the elements used by Organizations SCPs. The elements include actions, resources, and conditions.

For details about how to use these elements to create a custom SCP, see Creating an SCP.

Actions

Actions are specific operations that are allowed or denied in an SCP.

  • The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an SCP.
  • The Resource Type column indicates whether the action supports resource-level permissions.
    • You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions and you must specify all resources ("*") in your SCP statements.
    • If this column includes a resource type, you must specify the URN in the Resource element of your statements.
    • Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.

    For details about the resource types defined by RAM, see Resources.

  • The Condition Key column contains keys that you can specify in the Condition element of an SCP statement.
    • If the Resource Type column has values for an action, the condition key takes effect only for the listed resource types.
    • If the Resource Type column is empty (-) for an action, the condition key takes effect for all resources that action supports.
    • If the Condition Key column is empty (-) for an action, the action does not support any condition keys.

    For details about the condition keys defined by RAM, see Conditions.

The following table lists the actions that you can define in SCP statements for RAM.

Table 1 Actions supported by RAM

Action

Description

Access Level

Resource Type (*: required)

Condition Key

ram:permissions:list

Grants permission to list RAM permissions.

list

permission *

-

ram:permissions:get

Grants permission to get the details of an RAM permission.

read

permission *

-

ram:resourceShares:create

Grants permission to create a resource share with provided resources and/or principals.

write

-

  • g:RequestTag/<tag-key>
  • g:TagKeys
  • ram:RequestedResourceType
  • ram:ResourceUrn
  • ram:Principal
  • ram:TargetOrgPaths
  • ram:RequestedAllowExternalPrincipals

ram:resourceShares:search

Grants permission to search for a set of resource shares from a provided list or with a specified state.

read

-

  • g:TagKeys

ram:resourceShares:update

Grants permission to update the attributes of a resource share.

write

resourceShare *

  • g:ResourceTag/<tag-key>
  • ram:AllowExternalPrincipals

-

ram:RequestedAllowExternalPrincipals

ram:resourceShares:delete

Grants permission to delete a resource share.

write

resourceShare *

  • g:ResourceTag/<tag-key>
  • ram:AllowExternalPrincipals

ram:resourceShares:associate

Grants permission to associate resources and/or principals to a resource share.

write

resourceShare *

  • g:ResourceTag/<tag-key>
  • ram:AllowExternalPrincipals

-

  • ram:RequestedResourceType
  • ram:ResourceUrn
  • ram:Principal
  • ram:TargetOrgPaths

ram:resourceShares:disassociate

Grants permission to disassociate resources and/or principals from a resource share.

write

resourceShare *

  • g:ResourceTag/<tag-key>
  • ram:AllowExternalPrincipals

-

  • ram:RequestedResourceType
  • ram:ResourceUrn
  • ram:Principal
  • ram:TargetOrgPaths

ram:resourceShares:searchResourceShareAssociations

Grants permission to search for a set of resource share associations from a provided list or with a specified state of the specified type.

read

-

-

ram:resourceShares:associatePermission

Grants permission to associate a permission with a resource share.

write

resourceShare *

g:ResourceTag/<tag-key>

-

ram:PermissionUrn

ram:resourceShares:disassociatePermission

Grants permission to disassociate a permission from a resource share.

write

resourceShare *

g:ResourceTag/<tag-key>

-

ram:PermissionUrn

ram:resourceShares:listAssociatedPermissions

Grants permission to list the permissions associated with a resource share.

list

resourceShare *

g:ResourceTag/<tag-key>

ram:resourceShares:tag

Grants permission to tag the specified resource share.

tagging

resourceShare *

g:ResourceTag/<tag-key>

-

  • g:RequestTag/<tag-key>
  • g:TagKeys

ram:resourceShares:untag

Grants permission to untag the specified resource share.

tagging

resourceShare *

g:ResourceTag/<tag-key>

-

  • g:RequestTag/<tag-key>
  • g:TagKeys

ram:resourceShares:listTags

Grants permission to list tags attached to a resource share.

list

-

-

ram:resourceShares:listResourceSharesByTag

Grants permission to list resource shares by tag.

list

-

  • g:TagKeys

ram:resourceShares:searchResourceShareCountByTag

Grants permission to search for the number of resource shares by tag.

read

-

  • g:TagKeys

ram:sharedResources:search

Grants permission to search for the resources that you added to a resource share or that are shared with you.

list

-

-

ram:sharedPrincipals:search

Grants permission to search for the principals that you have shared resources with or that have shared resources with you.

list

-

-

ram:resourceShareInvitations:accept

Grants permission to accept the specified resource sharing invitation.

write

resourceShareInvitation *

-

-

ram:ShareOwnerAccountId

ram:resourceShareInvitations:reject

Grants permission to reject the specified resource sharing invitation.

write

resourceShareInvitation *

-

-

ram:ShareOwnerAccountId

ram:resourceShareInvitations:search

Grants permission to search for resource sharing invitations by the specified invitation ID or resource share ID.

read

-

-

ram:resourceShares:enableSharingWithOrganization

Grants permission to enable sharing with Organizations.

permission_management

-

-

ram:resourceShares:disableSharingWithOrganization

Grants permission to disable sharing with Organizations.

permission_management

-

-

ram:resourceShares:searchEnableSharingWithOrganization

Grants permission to check whether sharing with Organizations is enabled.

read

-

-

ram:sharedResources:searchDistinctResource

Grants permission to search for the distinct resources that you added to a resource share or that are shared with you.

list

-

-

ram:sharedPrincipals:searchDistinctPrincipal

Grants permission to search for the distinct principals that you have shared resources with or that have shared resources with you.

list

-

-

ram:resourceShares:listQuota

Grants permission to list the quotas of resource sharing.

list

-

-

ram:resourceTypes:list

Grants permission to list the resource types of cloud services.

list

-

-

ram:permission:listVersions

Grants permission to list all versions of the specified RAM permission.

list

-

-

Each API of RAM usually supports one or more actions. #org_20_0042/en-us_topic_0000001865665109_en-us_topic_0000001679340620_api_relation_table lists the supported actions and dependencies.

Resources

A resource type indicates the resources that an SCP applies to. If you specify a resource type for any action in Table 2, the resource URN must be specified in the SCP statements using that action, and the SCP applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the SCP applies to all resources. You can also set condition keys in an SCP to define resource types.

The following table lists the resource types that you can define in SCP statements for RAM.

Table 2 Resource types supported by RAM

Resource Type

URN

permission

ram::system:permission:<permission-id>

resourceShare

ram::<account-id>:resourceShare:<resource-share-id>

resourceShareInvitation

ram::<account-id>:resourceShareInvitation:<resource-share-invitation-id>

Conditions

A Condition element lets you specify conditions for when an SCP is in effect. It contains condition keys and operators.

  • The condition key that you specify can be a global condition key or a service-specific condition key.
    • Global condition keys (with the g: prefix) apply to all actions. Cloud services do not need to provide user identity information. Instead, the system automatically obtains such information and authenticates users. For details, see Global Condition Keys.
    • Service-specific condition keys (with the abbreviation of a service name as the prefix, for example, ram:) apply only to operations of the RAM service. For details, see Table 3.
    • The number of values associated with a condition key in the request context of an API call makes the condition key single-valued or multivalued. Single-valued condition keys have at most one value in the request context of an API call. Multivalued condition keys can have multiple values in the request context of an API call. For example, a request can originate from at most one VPC endpoint, so g:SourceVpce is a single-valued condition key. You can tag resources and include multiple tag key-value pairs in a request, so g:TagKeys is a multivalued condition key.
  • A condition operator, condition key, and a condition value together constitute a complete condition statement. An SCP can be applied only when its request conditions are met. For supported condition operators, see Condition operators.

The following table lists the condition keys that you can define in SCPs for RAM. You can include these condition keys to specify conditions for when your SCP is in effect.

Table 3 Service-specific condition keys supported by RAM

Service-specific Condition Key

Type

Single-valued/Multivalued

Description

ram:RequestedResourceType

string

Multivalued

Filters access by the specified resource type.

ram:ResourceUrn

string

Multivalued

Filters access by resources with the specified URN.

ram:Principal

string

Multivalued

Filters access by the format of the specified principal.

ram:TargetOrgPaths

string

Multivalued

Filters access by the organization path of the specified principal.

ram:PermissionUrn

string

Single-valued

Filters access by the specified permission URN.

ram:ShareOwnerAccountId

string

Single-valued

Filters access by resource shares owned by a specific account. For example, you can use this condition key to specify which resource sharing invitations can be accepted or rejected based on the resource owner's account ID.

ram:AllowExternalPrincipals

boolean

Single-valued

Filters access by resource shares that allow or deny sharing with external principals. For example, specify the value true if you only allow the action for resource shares that can be associated with external principals. External principals refer to accounts outside your organization.

ram:RequestedAllowExternalPrincipals

boolean

Single-valued

Filters access by the specified value for allow_external_principals. External principals refer to accounts outside your organization.