Distributed Message Service for Kafka (Kafka)

IAM provides system-defined identity policies to define typical cloud service permissions. You can also create custom identity policies using the actions supported by cloud services for more refined access control.

In addition to IAM, the Organizations service also provides Service Control Policies (SCPs) to set access control policies.

SCPs do not actually grant any permissions to an entity. They only set the permissions boundary for the entity. When SCPs are attached to an organizational unit (OU) or a member account, the SCPs do not directly grant permissions to that OU or member account. Instead, the SCPs only determine what permissions are available for that member account or those member accounts under that OU. The granted permissions can be applied only if they are allowed by the SCPs.

To learn more about how IAM is different from Organizations for access control, see How IAM Is Different from Organizations for Access Control?.

This section describes the elements used by IAM custom identity policies and Organizations SCPs. The elements include actions, resources, and conditions.

For details about how to use these elements to edit an IAM custom identity policy, see Creating a Custom Identity Policy.
For details about how to use these elements to edit a custom SCP, see Creating an SCP.

Actions

Actions are specific operations that are allowed or denied in an identity policy.

The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an identity policy.
The Resource Type column indicates whether the action supports resource-level permissions.
- You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions and you must specify all resources ("*") in your identity policy statements.
- If this column includes a resource type, you must specify the URN in the Resource element of your identity policy statements.
- Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.
For details about the resource types defined by DMS for Kafka, see Resources.
The Condition Key column contains keys that you can specify in the Condition element of an identity policy statement.
- If the Resource Type column has values for an action, the condition key takes effect only for the listed resource types.
- If the Resource Type column is empty (-) for an action, the condition key takes effect for all resources that action supports.
- If the Condition Key column is empty (-) for an action, the action does not support any condition keys.
For details about the condition keys defined by DMS for Kafka, see Conditions.
The Alias column lists the policy actions that are configured in identity policies. With these actions, you can use APIs for policy-based authorization. For details, see Policies and Identity Policies.

The following table lists the actions that you can define in identity policy statements for DMS for Kafka.

**Table 1** Actions supported by DMS for Kafka
Action	Description	Access Level	Resource Type (*: required)	Condition Key	Alias
dms:instance:connector	Grants permission to enable instance connector feature.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:list	Grants permission to query instance list.	List	kafka *	g:EnterpriseProjectId	-
dms:instance:scale	Grants permission to scale up instance.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:listConnectorSinkTask	Grants permission to query connector sink task list.	List	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:getBackgroundTask	Grants permission to query instance background tasks.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:deleteBackgroundTask	Grants permission to delete instance background tasks.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:create	Grants permission to create instance.	Write	kafka *	g:RequestTag/<tag-key> g:TagKeys g:EnterpriseProjectId dms:ssl dms:publicIp dms:connector	-
dms:instance:update	Grants permission to modify instance.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId g:RequestTag/<tag-key> g:TagKeys	dms:instance:modify
dms:instance:getDetail	Grants permission to query instance detail information.	Read	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:instance:closeManager	Grants permission to close kafka manager.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:deleteConnectorSinkTask	Grants permission to delete connector sink task.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:modifyAuthInfo	Grants permission to change access password of instance.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:modifyStatus	Grants permission to restart instance.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:delete	Grants permission to delete instance.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:getConnectorSinkTask	Grants permission to query connector sink task.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:createConnectorSinkTask	Grants permission to create connector sink task.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:updateConnectorSinkTask	Grants permission to update connector sink task.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:createConnectorSinkTask
dms:instance:resetAuthInfo	Grants permission to reset access password of instance.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:message:get	Grants permission to query message detail.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:message:get	Grants permission to query message detail.	Read	topic	-	dms:instance:get
dms:message:send	Grants permission to send message.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:list	Grants permission to query topic list.	List	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:topic:list	Grants permission to query topic list.	List	topic *	-	dms:instance:get
dms:topic:modify	Grants permission to modify topics.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:modify	Grants permission to modify topics.	Write	topic *	-	dms:instance:modify
dms:topic:create	Grants permission to create topics.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:create	Grants permission to create topics.	Write	topic	-	dms:instance:modify
dms:instance:getTopicDiskUsage	Grants permission to get topic diskusage.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:topic:delete	Grants permission to delete topics.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:delete	Grants permission to delete topics.	Write	topic *	-	dms:instance:modify
dms:topic:getAccessPolicy	Grants permission to get topic access policy.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:topic:getAccessPolicy	Grants permission to get topic access policy.	Read	topic *	-	dms:instance:get
dms:topic:autoCreate	Grants permission to enable or disable topic autoCreate.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:get	Grants permission to query topic detail.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:topic:get	Grants permission to query topic detail.	Read	topic *	-	dms:instance:get
dms:topic:createPartition	Grants permission to create topic partition.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:topic:createPartition	Grants permission to create topic partition.	Write	topic *	-	-
dms:topic:updateReplica	Grants permission to update topic partition replica.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:topic:updateReplica	Grants permission to update topic partition replica.	Write	topic *	-	-
dms:topic:setAccessPolicy	Grants permission to set access policy for topic.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:topic:setAccessPolicy	Grants permission to set access policy for topic.	Write	topic *	-	dms:instance:modify
dms:user:list	Grants permission to list users of instance.	List	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:user:modify	Grants permission to modify instance users.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:user:delete	Grants permission to delete instance user.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:user:create	Grants permission to create instance users.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:group:get	Grants permission to get consumer group's detailed information.	Read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:group:get		Read	consumerGroup *	-	dms:instance:get
dms:group:resetConsumeOffset	Grants permission to reset the consume offset of consumer group.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:group:resetConsumeOffset		Write	consumerGroup *	-	dms:instance:modify
dms:group:list	Grants permission to list consumer groups.	List	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:get
dms:group:list	Grants permission to list consumer groups.	List	consumerGroup *	-	dms:instance:get
dms:group:modify	Grants permission to modify consumer group.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:group:modify	Grants permission to modify consumer group.	Write	consumerGroup *	-	dms:instance:modify
dms:group:create	Grants permission to create consumer group.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:group:create	Grants permission to create consumer group.	Write	consumerGroup *	-	dms:instance:modify
dms:group:delete	Grants permission to delete consumer group.	Write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	dms:instance:modify
dms:group:delete	Grants permission to delete consumer group.	Write	consumerGroup *	-	dms:instance:modify
dms:coordinator:list	Grants permission to get coordinators of instance.	List	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-
dms:instance:reassignTopic	Grants permission to reassign topic.	Write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-

Each API of DMS for Kafka usually supports one or more actions. Table 2 lists the supported actions and dependencies.

**Table 2** Actions and dependencies supported by DMS for Kafka APIs
API	Action	Dependencies
GET /v2/{project_id}/instances/{instance_id}/messages	dms:message:get	-
PUT /v2/{project_id}/instances/{instance_id}/kafka-manager-password	dms:instance:modifyAuthInfo	-
PUT /v2/{project_id}/instances/{instance_id}/restart-kafka-manager	dms:instance:modifyStatus	-
DELETE /v2/{project_id}/kafka/instances/{instance_id}/management	dms:instance:closeManager	-
POST /v2/{project_id}/instances/action	dms:instance:delete	-
GET /v2/{project_id}/instances	dms:instance:list	-
POST /v2/{project_id}/kafka/instances/{instance_id}/extend	dms:instance:scale	-
GET /v2/{project_id}/kafka/instances/{instance_id}/extend	dms:instance:getDetail	-
POST /v2/{project_id}/instances/{instance_id}/connector	dms:instance:connector	vpc:vpcs:get vpc:vpcs:list vpc:ports:get vpc:ports:create vpc:ports:update vpc:ports:delete vpc:securityGroups:get vpc:subnets:get eip:publicIps:get eip:publicIps:list eip:publicIps:update
GET /v2/{project_id}/instances/{instance_id}	dms:instance:getDetail	vpc:vpcs:get vpc:ports:get vpc:securityGroups:get vpc:subnets:get eip:publicIps:get
PUT /v2/{project_id}/instances/{instance_id}	dms:instance:update	vpc:vpcs:get vpc:subnets:get eip:publicIps:get eip:publicIps:update vpc:ports:get vpc:securityGroups:get vpc:securityGroups:update
DELETE /v2/{project_id}/instances/{instance_id}	dms:instance:delete	-
POST /v2/{project_id}/instances/{instance_id}/connector/tasks	dms:instance:createConnectorSinkTask	-
GET /v2/{project_id}/instances/{instance_id}/connector/tasks	dms:instance:listConnectorSinkTask	-
PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause	dms:instance:updateConnectorSinkTask	-
PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume	dms:instance:updateConnectorSinkTask	-
GET /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}	dms:instance:getConnectorSinkTask	-
DELETE /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}	dms:instance:deleteConnectorSinkTask	-
POST /v2/{project_id}/instances/{instance_id}/password	dms:instance:resetAuthInfo	-
GET /v2/{project_id}/instances/{instance_id}/tasks	dms:instance:getBackgroundTask	-
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}	dms:instance:getBackgroundTask	-
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}	dms:instance:deleteBackgroundTask	-
GET /v2/{project_id}/instances/{instance_id}/topics	dms:topic:list	-
PUT /v2/{project_id}/instances/{instance_id}/topics	dms:topic:modify	-
POST /v2/{project_id}/instances/{instance_id}/topics	dms:topic:create	-
GET /v2/{project_id}/instances/{instance_id}/topics/diskusage	dms:instance:getTopicDiskUsage	-
POST /v2/{project_id}/instances/{instance_id}/topics/delete	dms:topic:delete	-
POST /v2/{project_id}/instances/{instance_id}/crossvpc/modify	dms:instance:update	-
GET /v2/{project_id}/instances/{instance_id}/users	dms:user:list	-
PUT /v2/{project_id}/instances/{instance_id}/users	dms:user:delete	-
POST /v2/{project_id}/instances/{instance_id}/users	dms:user:create	-
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}	dms:user:modify	-
POST /v2/{project_id}/instances/{instance_id}/autotopic	dms:topic:autoCreate	-
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/beginning-message	dms:message:get	-
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/end-message	dms:message:get	-
GET /v2/{project_id}/instances/{instance_id}/management/cluster	dms:instance:getDetail	-
GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}	dms:group:get	-
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions/{partition}/message	dms:message:get	-
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages	dms:message:get	-
GET /v2/{project_id}/instances/{instance_id}/management/coordinators	dms:coordinator:list	-
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}	dms:topic:get	-
POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/partitions-reassignment	dms:topic:createPartition	-
POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment	dms:topic:updateReplica	-
GET /v2/{project_id}/instances/{instance_id}/groups	dms:group:list	-
GET /v2/{project_id}/instances/{instance_id}/groups/{group}	dms:group:get	-
DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}	dms:group:delete	-
POST /v2/{project_id}/kafka/instances	dms:instance:create	vpc:vpcs:get vpc:vpcs:list vpc:ports:get vpc:ports:create vpc:ports:update vpc:ports:delete vpc:securityGroups:get vpc:subnets:get eip:publicIps:get eip:publicIps:list eip:publicIps:update
GET /v1/{project_id}/instances/{instance_id}/topics/{topic_name}/accesspolicy	dms:topic:getAccessPolicy	-
POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy	dms:topic:setAccessPolicy	-
GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy	dms:instance:getDetail	-
GET /v2/{project_id}/kafka/{instance_id}/tags	dms:instance:getDetail	-
GET /v2/{project_id}/kafka/tags	dms:instance:getDetail	-
POST /v2/{project_id}/kafka/{instance_id}/tags/action	dms:instance:update	-
POST /v2/{project_id}/kafka/instances/{instance_id}/reassign	dms:instance:reassignTopic	-
POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete	dms:group:delete	-
POST /v2/{project_id}/kafka/instances/{instance_id}/group	dms:group:create	-
PUT /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}	dms:group:modify	-
POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connector	dms:instance:connector	-
POST /v2/{project_id}/instances/{instance_id}/messages/action	dms:message:send	-
GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/partitions	dms:topic:get	-
GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers	dms:topic:get	-
PUT /v2/{engine}/{project_id}/instances/{instance_id}/users/{user_name}	dms:user:modify	-
POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset	dms:group:resetConsumeOffset	-

Resources

A resource type indicates the resources that an identity policy applies to. If you specify a resource type for any action in Table 3, the resource URN must be specified in the identity policy statements using that action, and the identity policy applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the identity policy applies to all resources. You can also set condition keys in an identity policy to define resource types.

The following table lists the resource types that you can define in identity policy statements for DMS for Kafka.

**Table 3** Resource types supported by DMS for Kafka
Resource Type	URN
kafka	dms:<region>:<account-id>:kafka:<instance-id>
topic	dms:<region>:<account-id>:topic:<instance-id>/<topic-name>
consumerGroup	dms:<region>:<account-id>:consumerGroup:<instance-id>/<consumerGroup-name>

Conditions

Condition Key Overview

A Condition element lets you specify conditions for when an identity policy is in effect. It contains condition keys and operators.

The condition key that you specify can be a global condition key or a service-specific condition key.
- Global condition keys (with the g: prefix) apply to all actions. Cloud services do not need to provide user identity information. Instead, the system automatically obtains such information and authenticates users. For details, see Global Condition Keys.
- Service-specific condition keys (with the abbreviation of a service name plus a colon as the prefix, for example, dms) apply only to operations of the xx service. For details, see Table 4.
- The number of values associated with a condition key in the request context of an API call makes the condition key single-valued or multivalued. Single-valued condition keys have at most one value in the request context of an API call. Multivalued condition keys can have multiple values in the request context of an API call. For example, a request can originate from at most one VPC endpoint, so g:SourceVpce is a single-valued condition key. You can tag resources and include multiple tag key-value pairs in a request, so g:TagKeys is a multivalued condition key.
A condition operator, condition key, and a condition value together constitute a complete condition statement. An identity policy can be applied only when its request conditions are met. For supported condition operators, see operators.

Service-specific condition keys supported by DMS for Kafka

The following table lists the condition keys that you can define in identity policies for DMS for Kafka. You can include these condition keys to specify conditions for when your identity policy is in effect.

**Table 4** Service-specific condition keys supported by DMS for Kafka
Service-specific Condition Key	Type	Single-valued/Multivalued	Description
dms:ssl	boolean	Single-valued	Filters access based on whether the instance is enabled for SSL access.
dms:publicIp	boolean	Single-valued	Filters access based on whether the instance is enabled for public IP access.
dms:connector	boolean	Single-valued	Filters access based on whether the instance connector is enabled.