Actions, resources, and condition keys for Amazon DocumentDB Elastic Clusters

Amazon DocumentDB Elastic Clusters (service prefix: docdb-elastic) 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 DocumentDB Elastic Clusters
Resource types defined by Amazon DocumentDB Elastic Clusters
Condition keys for Amazon DocumentDB Elastic Clusters

Actions defined by Amazon DocumentDB Elastic Clusters

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 AWS. 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.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
ApplyPendingMaintenanceAction	Grants permission to apply pending maintenance actions on Amazon DocDB-Elastic cluster	Write	cluster*
ApplyPendingMaintenanceAction		Write		aws:ResourceTag/${TagKey}
CopyClusterSnapshot	Grants permission to copy a new Amazon DocDB-Elastic cluster snapshot	Write	cluster-snapshot*		docdb-elastic:CreateClusterSnapshot kms:CreateGrant kms:Decrypt kms:DescribeKey kms:GenerateDataKey
CopyClusterSnapshot		Write		aws:RequestTag/${TagKey} aws:TagKeys aws:ResourceTag/${TagKey}
CreateCluster	Grants permission to create a new Amazon DocDB-Elastic cluster	Write		aws:RequestTag/${TagKey} aws:TagKeys	ec2:CreateVpcEndpoint ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint iam:CreateServiceLinkedRole kms:CreateGrant kms:Decrypt kms:DescribeKey kms:GenerateDataKey secretsmanager:DescribeSecret secretsmanager:GetResourcePolicy secretsmanager:GetSecretValue secretsmanager:ListSecretVersionIds secretsmanager:ListSecrets
CreateClusterSnapshot	Grants permission to create a new Amazon DocDB-Elastic cluster snapshot	Write	cluster*		ec2:CreateVpcEndpoint ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint iam:CreateServiceLinkedRole kms:CreateGrant kms:Decrypt kms:DescribeKey kms:GenerateDataKey secretsmanager:DescribeSecret secretsmanager:GetResourcePolicy secretsmanager:GetSecretValue secretsmanager:ListSecretVersionIds secretsmanager:ListSecrets
			cluster-snapshot*
				aws:RequestTag/${TagKey} aws:TagKeys aws:ResourceTag/${TagKey}
DeleteCluster	Grants permission to delete a cluster	Write	cluster*		ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint
DeleteCluster	Grants permission to delete a cluster	Write		aws:ResourceTag/${TagKey}
DeleteClusterSnapshot	Grants permission to delete a cluster snapshot	Write	cluster-snapshot*		ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint
DeleteClusterSnapshot	Grants permission to delete a cluster snapshot	Write		aws:ResourceTag/${TagKey}
GetCluster	Grants permission to view details about a cluster	Read	cluster*
GetCluster	Grants permission to view details about a cluster	Read		aws:ResourceTag/${TagKey}
GetClusterSnapshot	Grants permission to view details about a cluster snapshot	Read	cluster-snapshot*
GetClusterSnapshot	Grants permission to view details about a cluster snapshot	Read		aws:ResourceTag/${TagKey}
GetPendingMaintenanceAction	Grants permission to view details about pending maintenance actions on Amazon DocDB-Elastic cluster	Read	cluster*
GetPendingMaintenanceAction		Read		aws:ResourceTag/${TagKey}
ListClusterSnapshots	Grants permission to list the cluster snapshots in your account	List
ListClusters	Grants permission to list the clusters in your account	List
ListPendingMaintenanceActions	Grants permission to list details about pending maintenance actions on any Amazon DocDB-Elastic cluster	List		aws:ResourceTag/${TagKey}
ListTagsForResource	Grants permission to lists tag for an DocumentDB Elastic resource	List	cluster
			cluster-snapshot
				aws:ResourceTag/${TagKey}
RestoreClusterFromSnapshot	Grants permission to restore cluster from a Amazon DocDB-Elastic cluster snapshot	Write	cluster*		docdb-elastic:CreateCluster ec2:CreateVpcEndpoint ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint iam:CreateServiceLinkedRole kms:CreateGrant kms:Decrypt kms:DescribeKey kms:GenerateDataKey secretsmanager:DescribeSecret secretsmanager:GetResourcePolicy secretsmanager:GetSecretValue secretsmanager:ListSecretVersionIds secretsmanager:ListSecrets
			cluster-snapshot*
				aws:RequestTag/${TagKey} aws:TagKeys aws:ResourceTag/${TagKey}
StartCluster	Grants permission to start a stopped Amazon DocDB-Elastic cluster	Write	cluster*
StartCluster		Write		aws:ResourceTag/${TagKey}
StopCluster	Grants permission to stop an existing Amazon DocDB-Elastic cluster	Write	cluster*
StopCluster		Write		aws:ResourceTag/${TagKey}
TagResource	Grants permission to tag an DocumentDB Elastic resource	Tagging	cluster
			cluster-snapshot
				aws:TagKeys aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey}
UntagResource	Grants permission to untag a DocumentDB Elastic resource	Tagging	cluster
			cluster-snapshot
				aws:TagKeys
UpdateCluster	Grants permission to modify a cluster	Write	cluster*		ec2:CreateVpcEndpoint ec2:DeleteVpcEndpoints ec2:DescribeAvailabilityZones ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcAttribute ec2:DescribeVpcEndpoints ec2:DescribeVpcs ec2:ModifyVpcEndpoint kms:CreateGrant kms:Decrypt kms:DescribeKey kms:GenerateDataKey secretsmanager:DescribeSecret secretsmanager:GetResourcePolicy secretsmanager:GetSecretValue secretsmanager:ListSecretVersionIds secretsmanager:ListSecrets
UpdateCluster	Grants permission to modify a cluster	Write		aws:ResourceTag/${TagKey}

Resource types defined by Amazon DocumentDB Elastic Clusters

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
cluster	`arn:${Partition}:docdb-elastic:${Region}:${Account}:cluster/${ResourceId}`	aws:ResourceTag/${TagKey}
cluster-snapshot	`arn:${Partition}:docdb-elastic:${Region}:${Account}:cluster-snapshot/${ResourceId}`	aws:ResourceTag/${TagKey}

Condition keys for Amazon DocumentDB Elastic Clusters

Amazon DocumentDB Elastic Clusters 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 access by the set of tag key-value pairs in the request	String
aws:ResourceTag/${TagKey}	Filters access by the set of tag key-value pairs attached to the resource	String
aws:TagKeys	Filters access by the set of tag keys in the request	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AWS Directory Service Data

Amazon DynamoDB