Actions, resources, and condition keys for Amazon MemoryDB
Amazon MemoryDB (service prefix: memorydb) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon MemoryDB
You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in Amazon. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
Note
When you create a MemoryDB for Redis policy in IAM you must use the "*" wildcard character for the Resource block. For information about using the following MemoryDB for Redis API actions in an IAM policy, see MemoryDB Actions and IAM.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| BatchUpdateCluster | Grants permissions to apply service updates | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs s3:GetObject |
||
| Connect | Allows an IAM user or role to connect as a specified MemoryDB user to a node in a cluster | Write | |||
| CopySnapshot | Grants permissions to make a copy of an existing snapshot | Write |
memorydb:TagResource s3:DeleteObject s3:GetBucketAcl s3:PutObject |
||
| CreateAcl | Grants permissions to create a new access control list | Write |
memorydb:TagResource |
||
| CreateCluster | Grants permissions to create a cluster | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs memorydb:TagResource s3:GetObject |
||
| CreateParameterGroup | Grants permissions to create a new parameter group | Write |
memorydb:TagResource |
||
| CreateSnapshot | Grants permissions to create a backup of a cluster at the current point in time | Write |
memorydb:TagResource s3:DeleteObject s3:GetBucketAcl s3:PutObject |
||
| CreateSubnetGroup | Grants permissions to create a new subnet group | Write |
memorydb:TagResource |
||
| CreateUser | Grants permissions to create a new user | Write |
memorydb:TagResource |
||
| DeleteAcl | Grants permissions to delete an access control list | Write | |||
| DeleteCluster | Grants permissions to delete a previously provisioned cluster | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs |
||
| DeleteParameterGroup | Grants permissions to delete a parameter group | Write | |||
| DeleteSnapshot | Grants permissions to delete a snapshot | Write | |||
| DeleteSubnetGroup | Grants permissions to delete a subnet group | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs |
||
| DeleteUser | Grants permissions to delete a user | Write | |||
| DescribeAcls | Grants permissions to retrieve information about access control lists | Read | |||
| DescribeClusters | Grants permissions to retrieve information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster identifier is supplied | Read | |||
| DescribeEngineVersions | Grants permissions to list of the available engines and their versions | Read | |||
| DescribeEvents | Grants permissions to retrieve events related to clusters, subnet groups, and parameter groups | Read | |||
| DescribeParameterGroups | Grants permissions to retrieve information about parameter groups | Read | |||
| DescribeParameters | Grants permissions to retrieve a detailed parameter list for a particular parameter group | Read | |||
| DescribeReservedNodes | Grants permissions to retrieve reserved nodes | Read | |||
| DescribeReservedNodesOfferings | Grants permissions to retrieve reserved nodes offerings | Read | |||
| DescribeServiceUpdates | Grants permissions to retrieve details of the service updates | Read | |||
| DescribeSnapshots | Grants permissions to retrieve information about cluster snapshots | Read | |||
| DescribeSubnetGroups | Grants permissions to retrieve a list of subnet group | Read | |||
| DescribeUsers | Grants permissions to retrieve information about users | Read | |||
| FailoverShard | Grants permissions to test automatic failover on a specified shard in a cluster | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs |
||
| ListAllowedNodeTypeUpdates | Grants permissions to list available node type updates | Read | |||
| ListTags | Grants permissions to list cost allocation tags | Read | |||
| PurchaseReservedNodesOffering | Grants permissions to purchase a new reserved node | Write |
memorydb:TagResource |
||
| ResetParameterGroup | Grants permissions to modify the parameters of a parameter group to the engine or system default value | Write | |||
| TagResource | Grants permissions to add up to 10 cost allocation tags to the named resource | Tagging | |||
| UntagResource | Grants permissions to remove the tags identified by the TagKeys list from a resource | Tagging | |||
| UpdateAcl | Grants permissions to update an access control list | Write | |||
| UpdateCluster | Grants permissions to update the settings for a cluster | Write |
ec2:CreateNetworkInterface ec2:DeleteNetworkInterface ec2:DescribeNetworkInterfaces ec2:DescribeSubnets ec2:DescribeVpcs |
||
| UpdateParameterGroup | Grants permissions to update parameters in a parameter group | Write | |||
| UpdateSubnetGroup | Grants permissions to update a subnet group | Write | |||
| UpdateUser | Grants permissions to update a user | Write | |||
Resource types defined by Amazon MemoryDB
The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| parametergroup |
arn:${Partition}:memorydb:${Region}:${Account}:parametergroup/${ParameterGroupName}
|
|
| subnetgroup |
arn:${Partition}:memorydb:${Region}:${Account}:subnetgroup/${SubnetGroupName}
|
|
| cluster |
arn:${Partition}:memorydb:${Region}:${Account}:cluster/${ClusterName}
|
|
| snapshot |
arn:${Partition}:memorydb:${Region}:${Account}:snapshot/${SnapshotName}
|
|
| user |
arn:${Partition}:memorydb:${Region}:${Account}:user/${UserName}
|
|
| acl |
arn:${Partition}:memorydb:${Region}:${Account}:acl/${AclName}
|
|
| reservednode |
arn:${Partition}:memorydb:${Region}:${Account}:reservednode/${ReservationID}
|
Condition keys for Amazon MemoryDB
Amazon MemoryDB defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
| Condition keys | Description | Type |
|---|---|---|
| aws:RequestTag/${TagKey} | Filters actions based on the tags that are passed in the request | String |
| aws:ResourceTag/${TagKey} | Filters actions based on the tags associated with the resource | String |
| aws:TagKeys | Filters actions based on the tag keys that are passed in the request | ArrayOfString |