Distributed Message Service for Kafka

The Organizations service provides Service Control Policies (SCPs) to set access control policies.

SCPs do not actually grant any permissions to a principal. They only set the permissions boundary for the principal. When SCPs are attached to a member account or an organizational unit (OU), they do not directly grant permissions to that member account or OU. Instead, the SCPs just determine what permissions are available for that member account or the member accounts under that OU.

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

For details about how to use these elements to create a custom SCP, see Creating an SCP.

Actions

Actions are specific operations that are allowed or denied in an SCP.

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 SCP.
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 SCP statements.
- If this column includes a resource type, you must specify the URN in the Resource element of your 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 includes keys that you can specify in the Condition element of an SCP 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 following table lists the actions that you can define in SCP statements for DMS for Kafka.

**Table 1** Actions supported by DMS for Kafka
Action	Description	Access Level	Resource Type (*: required)	Condition Key
dms:instance:connector	Enable Smart Connect.	write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:list	View the instance list.	list	kafka *	g:EnterpriseProjectId
dms:instance:scale	Scale up the instance.	write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:listConnectorSinkTask	View the Smart Connect task list.	list	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:getBackgroundTask	View background task details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:deleteBackgroundTask	Delete a background task.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:create	Create an instance.	write	kafka *	g:RequestTag/<tag-key> g:TagKeys g:EnterpriseProjectId dms:ssl dms:publicIp dms:connector
dms:instance:update	Modify an instance.	write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId g:RequestTag/<tag-key> g:TagKeys
dms:instance:getDetail	View the instance details.	read	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:closeManager	Disable Kafka Manager.	write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:deleteConnectorSinkTask	Delete Smart Connect tasks.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:modifyAuthInfo	Modify an instance password.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:modifyStatus	Restart an instance.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:delete	Delete an instance.	write	kafka *	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:getConnectorSinkTask	View Smart Connect task details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:createConnectorSinkTask	Create a Smart Connect task.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:updateConnectorSinkTask	Update a Smart Connect task.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:resetAuthInfo	Reset an instance password.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:message:get	Query message details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:message:get	Query message details.	read	topic	-
dms:message:send	Send messages.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:list	Obtain the topic list.	list	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:list	Obtain the topic list.	list	topic *	-
dms:topic:modify	Modify a topic.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:modify	Modify a topic.	write	topic *	-
dms:topic:create	Create a topic.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:create	Create a topic.	write	topic	-
dms:instance:getTopicDiskUsage	Query disk usage by topic.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:delete	Delete a topic.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:delete	Delete a topic.	write	topic *	-
dms:topic:getAccessPolicy	Obtain topic permissions.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:getAccessPolicy	Obtain topic permissions.	read	topic *	-
dms:topic:autoCreate	Configure automatic topic creation.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:get	Query topic details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:get	Query topic details.	read	topic *	-
dms:topic:createPartition	Create a topic partition.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:createPartition	Create a topic partition.	write	topic *	-
dms:topic:updateReplica	Modify partition replicas of a topic.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:updateReplica	Modify partition replicas of a topic.	write	topic *	-
dms:topic:setAccessPolicy	Configure access policies for a topic.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:topic:setAccessPolicy	Configure access policies for a topic.	write	topic *	-
dms:user:list	Obtain the instance user list.	list	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:user:get	Obtain instance user details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:user:modify	Modify instance user details.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:user:delete	Delete instance users.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:user:create	Create instance users.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:get	Obtain consumer group details.	read	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:get	Obtain consumer group details.	read	consumerGroup *	-
dms:group:resetConsumeOffset	Reset the consumer group offset.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:resetConsumeOffset	Reset the consumer group offset.	write	consumerGroup *	-
dms:group:list	Obtain the consumer group list.	list	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:list	Obtain the consumer group list.	list	consumerGroup *	-
dms:group:modify	Modify a consumer group.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:modify	Modify a consumer group.	write	consumerGroup *	-
dms:group:create	Create a consumer group.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:create	Create a consumer group.	write	consumerGroup *	-
dms:group:delete	Delete a consumer group.	write	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:group:delete	Delete a consumer group.	write	consumerGroup *	-
dms:coordinator:list	Obtain the instance coordinator list.	list	kafka	g:ResourceTag/<tag-key> g:EnterpriseProjectId
dms:instance:reassignTopic	Rebalance topics.	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/{engine}/{project_id}/instances/{instance_id}/extend	dms:instance:scale	-
GET /v2/{engine}/{project_id}/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	-
PUT /v2/{project_id}/connectors/{connector_id}/sink-tasks	dms:instance:updateConnectorSinkTask	-
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}/replicas-reassignment	dms:topic:updateReplica	-
GET /v2/{project_id}/instances/{instance_id}/groups	dms:group:list	-
POST /v2/{engine}/{project_id}/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/kafka/{project_id}/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	-

Resources

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

The following table lists the resource types that you can define in SCP 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

A Condition element lets you specify conditions for when an SCP 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 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 SCP can be applied only when its request conditions are met. For supported condition operators, see Condition operators.

The following table lists the condition keys that you can define in SCPs for DMS for Kafka. You can include these condition keys to specify conditions for when your SCP 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	Filter instance permissions by SSL enablement.
dms:publicIp	boolean	Single-valued	Filter instance permissions by public access enablement.
dms:connector	boolean	Single-valued	Filter instance permissions by Smart Connect enablement.