Actions, resources, and condition keys for Amazon QLDB

Amazon QLDB (service prefix: qldb) 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.

Actions defined by Amazon QLDB

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
CancelJournalKinesisStream	Grants permission to cancel a journal kinesis stream	Write	stream*
CreateLedger	Grants permission to create a ledger	Write	ledger*
				aws:RequestTag/${TagKey} aws:TagKeys
DeleteLedger	Grants permission to delete a ledger	Write	ledger*
DescribeJournalKinesisStream	Grants permission to describe information about a journal kinesis stream	Read	stream*
DescribeJournalS3Export	Grants permission to describe information about a journal export job	Read	ledger*
DescribeLedger	Grants permission to describe a ledger	Read	ledger*
ExecuteStatement [permission only]	Grants permission to send commands to a ledger via the console	Write	ledger*
ExportJournalToS3	Grants permission to export journal contents to an Amazon S3 bucket	Write	ledger*
GetBlock	Grants permission to retrieve a block from a ledger for a given BlockAddress	Read	ledger*
GetDigest	Grants permission to retrieve a digest from a ledger for a given BlockAddress	Read	ledger*
GetRevision	Grants permission to retrieve a revision for a given document ID and a given BlockAddress	Read	ledger*
InsertSampleData [permission only]	Grants permission to insert sample application data via the console	Write	ledger*
ListJournalKinesisStreamsForLedger	Grants permission to list journal kinesis streams for a specified ledger	List	stream*
ListJournalS3Exports	Grants permission to list journal export jobs for all ledgers	List
ListJournalS3ExportsForLedger	Grants permission to list journal export jobs for a specified ledger	List	ledger*
ListLedgers	Grants permission to list existing ledgers	List
ListTagsForResource	Grants permission to list tags for a resource	Read	catalog
			ledger
			stream
			table
PartiQLCreateIndex	Grants permission to create an index on a table	Write	table*
PartiQLCreateTable	Grants permission to create a table	Write	table*
				aws:RequestTag/${TagKey} aws:TagKeys
PartiQLDelete	Grants permission to delete documents from a table	Write	table*
PartiQLDropIndex	Grants permission to drop an index from a table	Write	table*
				qldb:Purge
PartiQLDropTable	Grants permission to drop a table	Write	table*
				qldb:Purge
PartiQLHistoryFunction	Grants permission to use the history function on a table	Read	table*
PartiQLInsert	Grants permission to insert documents into a table	Write	table*
PartiQLRedact	Grants permission to redact historic revisions	Write	table*
PartiQLSelect	Grants permission to select documents from a table	Read	catalog
			table
PartiQLUndropTable	Grants permission to undrop a table	Write	table*
PartiQLUpdate	Grants permission to update existing documents in a table	Write	table*
SendCommand	Grants permission to send commands to a ledger	Write	ledger*
ShowCatalog [permission only]	Grants permission to view a ledger's catalog via the console	Write	ledger*
StreamJournalToKinesis	Grants permission to stream journal contents to a Kinesis Data Stream	Write	stream*
				aws:RequestTag/${TagKey} aws:TagKeys
TagResource	Grants permission to add one or more tags to a resource	Tagging	catalog
			ledger
			stream
			table
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove one or more tags from a resource	Tagging	catalog
			ledger
			stream
			table
				aws:RequestTag/${TagKey} aws:TagKeys
UpdateLedger	Grants permission to update properties on a ledger	Write	ledger*
UpdateLedgerPermissionsMode	Grants permission to update the permissions mode on a ledger	Write	ledger*

Resource types defined by Amazon QLDB

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
ledger	arn:${Partition}:qldb:${Region}:${Account}:ledger/${LedgerName}	aws:ResourceTag/${TagKey}
stream	arn:${Partition}:qldb:${Region}:${Account}:stream/${LedgerName}/${StreamId}	aws:ResourceTag/${TagKey}
table	arn:${Partition}:qldb:${Region}:${Account}:ledger/${LedgerName}/table/${TableId}	aws:ResourceTag/${TagKey}
catalog	arn:${Partition}:qldb:${Region}:${Account}:ledger/${LedgerName}/information_schema/user_tables	aws:ResourceTag/${TagKey}

Condition keys for Amazon QLDB

Amazon QLDB 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 a tag key and value pair that is allowed in the request	String
aws:ResourceTag/${TagKey}	Filters access by a tag key and value pair of a resource	String
aws:TagKeys	Filters access by a list of tag keys that are allowed in the request	ArrayOfString
qldb:Purge	Filters access by the value of purge that is specified in a PartiQL DROP statement	String