Actions, resources, and condition keys for AWS Database Migration Service - Service Authorization Reference

# Actions, resources, and condition keys for AWS Database Migration Service

AWS Database Migration Service (service prefix: `dms` ) 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.

Topics

- Actions defined by AWS Database Migration Service
- Resource types defined by AWS Database Migration Service
- Condition keys for AWS Database Migration Service

## Actions defined by AWS Database Migration Service

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
--- | --- | --- | --- | --- | ---
AddTagsToResource | Grants permission to add metadata tags to DMS resources, including replication instances, endpoints, security groups, and migration tasks | Tagging | Certificate |  |
Endpoint |  |
EventSubscription |  |
ReplicationInstance |  |
ReplicationSubnetGroup |  |
ReplicationTask |  |
| aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
ApplyPendingMaintenanceAction | Grants permission to apply a pending maintenance action to a resource (for example, to a replication instance) | Write | ReplicationInstance* |  |
CancelReplicationTaskAssessmentRun | Grants permission to cancel a single premigration assessment run | Write | ReplicationTaskAssessmentRun* |  |
CreateEndpoint | Grants permission to create an endpoint using the provided settings | Write |  | aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
CreateEventSubscription | Grants permission to create an AWS DMS event notification subscription | Write |  | aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
CreateReplicationInstance | Grants permission to create a replication instance using the specified parameters | Write |  | aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
CreateReplicationSubnetGroup | Grants permission to create a replication subnet group given a list of the subnet IDs in a VPC | Write |  | aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
CreateReplicationTask | Grants permission to create a replication task using the specified parameters | Write | Endpoint* |  |
ReplicationInstance* |  |
| aws:RequestTag/${TagKey} aws:TagKeys dms:req-tag/${TagKey} |
DeleteCertificate | Grants permission to delete the specified certificate | Write | Certificate* |  |
DeleteConnection | Grants permission to delete the specified connection between a replication instance and an endpoint | Write | Endpoint* |  |
ReplicationInstance* |  |
DeleteEndpoint | Grants permission to delete the specified endpoint | Write | Endpoint* |  |
DeleteEventSubscription | Grants permission to delete an AWS DMS event subscription | Write | EventSubscription* |  |
DeleteReplicationInstance | Grants permission to delete the specified replication instance | Write | ReplicationInstance* |  |
DeleteReplicationSubnetGroup | Grants permission to deletes a subnet group | Write | ReplicationSubnetGroup* |  |
DeleteReplicationTask | Grants permission to delete the specified replication task | Write | ReplicationTask* |  |
DeleteReplicationTaskAssessmentRun | Grants permission to delete the record of a single premigration assessment run | Write | ReplicationTaskAssessmentRun* |  |
DescribeAccountAttributes | Grants permission to list all of the AWS DMS attributes for a customer account | Read |  |  |
DescribeApplicableIndividualAssessments | Grants permission to list individual assessments that you can specify for a new premigration assessment run | Read | ReplicationInstance |  |
ReplicationTask |  |
DescribeCertificates | Grants permission to provide a description of the certificate | Read |  |  |
DescribeConnections | Grants permission to describe the status of the connections that have been made between the replication instance and an endpoint | Read |  |  |
DescribeEndpointTypes | Grants permission to return information about the type of endpoints available | Read |  |  |
DescribeEndpoints | Grants permission to return information about the endpoints for your account in the current region | Read |  |  |
DescribeEventCategories | Grants permission to list categories for all event source types, or, if specified, for a specified source type | Read |  |  |
DescribeEventSubscriptions | Grants permission to list all the event subscriptions for a customer account | Read |  |  |
DescribeEvents | Grants permission to list events for a given source identifier and source type | Read |  |  |
DescribeOrderableReplicationInstances | Grants permission to return information about the replication instance types that can be created in the specified region | Read |  |  |
DescribeRefreshSchemasStatus | Grants permission to returns the status of the RefreshSchemas operation | Read | Endpoint* |  |
DescribeReplicationInstanceTaskLogs | Grants permission to return information about the task logs for the specified task | Read | ReplicationInstance* |  |
| aws:ResourceTag/${TagKey} aws:TagKeys |
DescribeReplicationInstances | Grants permission to return information about replication instances for your account in the current region | Read |  |  |
DescribeReplicationSubnetGroups | Grants permission to return information about the replication subnet groups | Read |  |  |
DescribeReplicationTaskAssessmentResults | Grants permission to return the latest task assessment results from Amazon S3 | Read | ReplicationTask |  |
DescribeReplicationTaskAssessmentRuns | Grants permission to return a paginated list of premigration assessment runs based on filter settings | Read | ReplicationInstance |  |
ReplicationTask |  |
ReplicationTaskAssessmentRun |  |
DescribeReplicationTaskIndividualAssessments | Grants permission to return a paginated list of individual assessments based on filter settings | Read | ReplicationTask |  |
ReplicationTaskAssessmentRun |  |
DescribeReplicationTasks | Grants permission to return information about replication tasks for your account in the current region | Read |  |  |
DescribeSchemas | Grants permission to return information about the schema for the specified endpoint | Read | Endpoint* |  |
DescribeTableStatistics | Grants permission to return table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted | Read | ReplicationTask* |  |
ImportCertificate | Grants permission to upload the specified certificate | Write |  | aws:RequestTag/${TagKey} aws:TagKeys |
ListTagsForResource | Grants permission to list all tags for an AWS DMS resource | List | Certificate |  |
Endpoint |  |
EventSubscription |  |
ReplicationInstance |  |
ReplicationSubnetGroup |  |
ReplicationTask |  |
ModifyEndpoint | Grants permission to modify the specified endpoint | Write | Endpoint* |  |
Certificate |  |
ModifyEventSubscription | Grants permission to modify an existing AWS DMS event notification subscription | Write |  |  |
ModifyReplicationInstance | Grants permission to modify the replication instance to apply new settings | Write | ReplicationInstance* |  |
ModifyReplicationSubnetGroup | Grants permission to modify the settings for the specified replication subnet group | Write |  |  |
ModifyReplicationTask | Grants permission to modify the specified replication task | Write | ReplicationTask* |  |
MoveReplicationTask | Grants permission to move the specified replication task to a different replication instance | Write | ReplicationInstance* |  |
ReplicationTask* |  |
RebootReplicationInstance | Grants permission to reboot a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again | Write | ReplicationInstance* |  |
RefreshSchemas | Grants permission to populate the schema for the specified endpoint | Write | Endpoint* |  |
ReplicationInstance* |  |
ReloadTables | Grants permission to reload the target database table with the source data | Write | ReplicationTask* |  |
RemoveTagsFromResource | Grants permission to remove metadata tags from a DMS resource | Tagging | Certificate |  |
Endpoint |  |
EventSubscription |  |
ReplicationInstance |  |
ReplicationSubnetGroup |  |
ReplicationTask |  |
| aws:TagKeys |
StartReplicationTask | Grants permission to start the replication task | Write | ReplicationTask* |  |
StartReplicationTaskAssessment | Grants permission to start the replication task assessment for unsupported data types in the source database | Write | ReplicationTask* |  |
StartReplicationTaskAssessmentRun | Grants permission to start a new premigration assessment run for one or more individual assessments of a migration task | Write | ReplicationTask* |  |
StopReplicationTask | Grants permission to stop the replication task | Write | ReplicationTask* |  |
TestConnection | Grants permission to test the connection between the replication instance and the endpoint | Read | Endpoint* |  |
ReplicationInstance* |  |

## Resource types defined by AWS Database Migration Service

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
--- | --- | ---
Certificate | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:cert:*` | aws:ResourceTag/${TagKey} dms:cert-tag/${TagKey}
Endpoint | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:endpoint:*` | aws:ResourceTag/${TagKey} dms:endpoint-tag/${TagKey}
EventSubscription | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:es:*` | aws:ResourceTag/${TagKey} dms:es-tag/${TagKey}
ReplicationInstance | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:rep:*` | aws:ResourceTag/${TagKey} dms:rep-tag/${TagKey}
ReplicationSubnetGroup | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:subgrp:*` | aws:ResourceTag/${TagKey} dms:subgrp-tag/${TagKey}
ReplicationTask | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:task:*` | aws:ResourceTag/${TagKey} dms:task-tag/${TagKey}
ReplicationTaskAssessmentRun | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:assessment-run:*` |
ReplicationTaskIndividualAssessment | `arn:$ { Partition}:dms:$ { Region}:$ { Account}:individual-assessment:*` |

## Condition keys for AWS Database Migration Service

AWS Database Migration Service 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 resource | String
aws:TagKeys | Filters access based on the presence of tag keys in the request | String
dms:cert-tag/${TagKey} | Filters access based on the presence of tag keys in the request for Certificate | String
dms:endpoint-tag/${TagKey} | Filters access based on the presence of tag keys in the request for Endpoint | String
dms:es-tag/${TagKey} | Filters access based on the presence of tag keys in the request for EventSubscription | String
dms:rep-tag/${TagKey} | Filters access based on the presence of tag keys in the request for ReplicationInstance | String
dms:req-tag/${TagKey} | Filters access based on the presence of tag key-value pairs in the request | String
dms:subgrp-tag/${TagKey} | Filters access based on the presence of tag keys in the request for ReplicationSubnetGroup | String
dms:task-tag/${TagKey} | Filters access based on the presence of tag keys in the request for ReplicationTask | String

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.