Operations Actions Resource types Condition keys

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

Amazon DocumentDB Elastic Clusters (service prefix: docdb-elastic) provides the following service-specific operations, resources, actions, and condition 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.
View the programmatic service authorization reference for this service.

Topics

API operations defined by Amazon DocumentDB Elastic Clusters
Actions defined by Amazon DocumentDB Elastic Clusters
Resource types defined by Amazon DocumentDB Elastic Clusters
Condition keys for Amazon DocumentDB Elastic Clusters

API operations defined by Amazon DocumentDB Elastic Clusters

The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.

Operation	IAM action	Access level
ApplyPendingMaintenanceAction	docdb-elastic:ApplyPendingMaintenanceAction	Write
CopyClusterSnapshot	docdb-elastic:CopyClusterSnapshot	Write
	docdb-elastic:CreateClusterSnapshot	Write
	docdb-elastic:TagResource	Tagging, Write
CreateCluster	docdb-elastic:CreateCluster	Write
CreateCluster	docdb-elastic:TagResource	Tagging, Write
CreateClusterSnapshot	docdb-elastic:CreateClusterSnapshot	Write
CreateClusterSnapshot	docdb-elastic:TagResource	Tagging, Write
DeleteCluster	docdb-elastic:DeleteCluster	Write
DeleteClusterSnapshot	docdb-elastic:DeleteClusterSnapshot	Write
GetCluster	docdb-elastic:GetCluster	Read
GetClusterSnapshot	docdb-elastic:GetClusterSnapshot	Read
GetPendingMaintenanceAction	docdb-elastic:GetPendingMaintenanceAction	Read
ListClusterSnapshots	docdb-elastic:ListClusterSnapshots	List
ListClusters	docdb-elastic:ListClusters	List
ListPendingMaintenanceActions	docdb-elastic:ListPendingMaintenanceActions	List
ListTagsForResource	docdb-elastic:ListTagsForResource	List
RestoreClusterFromSnapshot	docdb-elastic:CreateCluster	Write
	docdb-elastic:RestoreClusterFromSnapshot	Write
	docdb-elastic:TagResource	Tagging, Write
StartCluster	docdb-elastic:StartCluster	Write
StopCluster	docdb-elastic:StopCluster	Write
TagResource	docdb-elastic:TagResource	Tagging, Write
UntagResource	docdb-elastic:UntagResource	Tagging, Write
UpdateCluster	docdb-elastic:UpdateCluster	Write

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.

Actions	Description	Resource types (*required)	Condition keys	Access level
ApplyPendingMaintenanceAction	Grants permission to apply pending maintenance actions on Amazon DocDB-Elastic cluster	cluster*	aws:ResourceTag/${TagKey}	Write
CopyClusterSnapshot	Grants permission to copy a new Amazon DocDB-Elastic cluster snapshot	cluster-snapshot*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateCluster	Grants permission to create a new Amazon DocDB-Elastic cluster		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateClusterSnapshot	Grants permission to create a new Amazon DocDB-Elastic cluster snapshot	cluster*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateClusterSnapshot		cluster-snapshot*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
DeleteCluster	Grants permission to delete a cluster	cluster*	aws:ResourceTag/${TagKey}	Write
DeleteClusterSnapshot	Grants permission to delete a cluster snapshot	cluster-snapshot*	aws:ResourceTag/${TagKey}	Write
GetCluster	Grants permission to view details about a cluster	cluster*	aws:ResourceTag/${TagKey}	Read
GetClusterSnapshot	Grants permission to view details about a cluster snapshot	cluster-snapshot*	aws:ResourceTag/${TagKey}	Read
GetPendingMaintenanceAction	Grants permission to view details about pending maintenance actions on Amazon DocDB-Elastic cluster	cluster*	aws:ResourceTag/${TagKey}	Read
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		aws:ResourceTag/${TagKey}	List
ListTagsForResource	Grants permission to lists tag for an DocumentDB Elastic resource	cluster	aws:ResourceTag/${TagKey}	List
ListTagsForResource		cluster-snapshot	aws:ResourceTag/${TagKey}	List
RestoreClusterFromSnapshot	Grants permission to restore cluster from a Amazon DocDB-Elastic cluster snapshot	cluster*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
RestoreClusterFromSnapshot		cluster-snapshot*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
StartCluster	Grants permission to start a stopped Amazon DocDB-Elastic cluster	cluster*	aws:ResourceTag/${TagKey}	Write
StopCluster	Grants permission to stop an existing Amazon DocDB-Elastic cluster	cluster*	aws:ResourceTag/${TagKey}	Write
TagResource	Grants permission to tag an DocumentDB Elastic resource	cluster	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
TagResource	Grants permission to tag an DocumentDB Elastic resource	cluster-snapshot	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UntagResource	Grants permission to untag a DocumentDB Elastic resource	cluster	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UntagResource	Grants permission to untag a DocumentDB Elastic resource	cluster-snapshot	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UpdateCluster	Grants permission to modify a cluster	cluster*	aws:ResourceTag/${TagKey}	Write

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.

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.

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

Amazon DevOps Guru (devops-guru)

Amazon DynamoDB (dynamodb)