Actions, resources, and condition keys for Amazon Managed Streaming for Apache Kafka - Service Authorization Reference

Actions, resources, and condition keys for Amazon Managed Streaming for Apache Kafka

Amazon Managed Streaming for Apache Kafka (service prefix: kafka) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by Amazon Managed Streaming for Apache Kafka

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 indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") 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. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
BatchAssociateScramSecret Grants permission to associate one or more Scram Secrets with an Amazon MSK cluster Write

kms:CreateGrant

kms:RetireGrant

BatchDisassociateScramSecret Grants permission to disassociate one or more Scram Secrets from an Amazon MSK cluster Write

kms:RetireGrant

CreateCluster Grants permission to create an MSK cluster Write

aws:RequestTag/${TagKey}

aws:TagKeys

ec2:DescribeSecurityGroups

ec2:DescribeSubnets

ec2:DescribeVpcs

iam:AttachRolePolicy

iam:CreateServiceLinkedRole

iam:PutRolePolicy

kms:CreateGrant

kms:DescribeKey

CreateConfiguration Grants permission to create an MSK configuration Write
DeleteCluster Grants permission to delete an MSK cluster Write
DeleteConfiguration Grants permission to delete the specified MSK configuration Write
DescribeCluster Grants permission to describe an MSK cluster Read
DescribeClusterOperation Grants permission to describe the cluster operation that is specified by the given ARN Read
DescribeConfiguration Grants permission to describe an MSK configuration Read
DescribeConfigurationRevision Grants permission to describe an MSK configuration revision Read
GetBootstrapBrokers Grants permission to get connection details for the brokers in an MSK cluster Read
GetCompatibleKafkaVersions Grants permission to get a list of the Apache Kafka versions to which you can update an MSK cluster List
ListClusterOperations Returns a list of all the operations that have been performed on the specified MSK cluster List
ListClusters Grants permission to list all MSK clusters in this account List
ListConfigurationRevisions Grants permission to list all revisions for an MSK configuration in this account List
ListConfigurations Grants permission to list all MSK configurations in this account List
ListKafkaVersions Grants permission to list all Apache Kafka versions supported by Amazon MSK List
ListNodes Grants permission to list brokers in an MSK cluster List
ListScramSecrets Grants permission to list the Scram Secrets associated with an Amazon MSK cluster List
ListTagsForResource Grants permission to list tags of an MSK resource List

cluster

RebootBroker Grants permission to reboot broker Write
TagResource Grants permission to tag an MSK resource Tagging

cluster

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Grants permission to remove tags from an MSK resource Tagging

cluster

aws:TagKeys

UpdateBrokerCount Updates the number of brokers of the MSK cluster Write
UpdateBrokerStorage Updates the storage size of the brokers of the MSK cluster Write
UpdateClusterConfiguration Grants permission to update the configuration of the MSK cluster Write
UpdateClusterKafkaVersion Grants permission to update the MSK cluster to the specified Apache Kafka version Write
UpdateConfiguration Grants permission to create a new revision of the MSK configuration Write
UpdateMonitoring Grants permission to update the monitoring settings for the MSK cluster Write

Resource types defined by Amazon Managed Streaming for Apache Kafka

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 table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
cluster arn:${Partition}:kafka:${Region}:${Account}:cluster/${ClusterName}/${UUID}

aws:ResourceTag/${TagKey}

Condition keys for Amazon Managed Streaming for Apache Kafka

Amazon Managed Streaming for Apache Kafka 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 The 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 presence of tag key-value pairs in the request String
aws:ResourceTag/${TagKey} Filters actions based on tag key-value pairs attached to the MSK resource String
aws:TagKeys Filters actions based on the presence of tag keys in the request String