Using roles for DataSync Discovery

AWS DataSync uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to DataSync. Service-linked roles are predefined by DataSync and include all the permissions that the service requires to call other AWS services on your behalf.

A service-linked role makes setting up DataSync easier because you don’t have to manually add the necessary permissions. DataSync defines the permissions of its service-linked roles, and unless defined otherwise, only DataSync can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity.

You can delete a service-linked role only after first deleting their related resources. This protects your DataSync resources because you can't inadvertently remove permission to access the resources.

For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked roles column. Choose a Yes with a link to view the service-linked role documentation for that service.

Service-linked role permissions for DataSync

DataSync uses the service-linked role named AWSServiceRoleForDataSyncDiscovery – Allows DataSync Discovery to use AWS Secrets Manager and Amazon CloudWatch.

The AWSServiceRoleForDataSyncDiscovery service-linked role trusts the following services to assume the role:

The role permissions policy named AWSDataSyncDiscoveryServiceRolePolicy allows DataSync to complete the following actions on the specified resources:

{
    "Version": "2012-10-17",
    "Statement": [{
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetSecretValue"
            ],
            "Resource": [
                "arn:*:secretsmanager:*:*:secret:datasync!*"
            ],
            "Condition": {
                "StringEquals": {
                    "secretsmanager:ResourceTag/aws:secretsmanager:owningService": "datasync",
                    "aws:ResourceAccount": "${aws:PrincipalAccount}"
                }
            }
        },
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream"
            ],
            "Resource": [
                "arn:*:logs:*:*:log-group:/aws/datasync*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "logs:PutLogEvents"
            ],
            "Resource": [
                "arn:*:logs:*:*:log-group:/aws/datasync:log-stream:*"
            ]
        }
    ]
}

You must configure permissions to allow your users, groups, or roles to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide.

Creating a service-linked role for DataSync

You don't need to manually create a service-linked role. When you add a storage system in the AWS Management Console, the AWS CLI, or the AWS API, DataSync creates the service-linked role for you.

You can also use the IAM console to create a service-linked role with the DataSync Discovery use case. In the AWS CLI or the AWS API, use IAM to create a service-linked role with the discovery-datasync.amazonaws.com service name. For more information, see Creating a service-linked role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again.

If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you add a storage system, DataSync creates the service-linked role for you again.

If you delete this service-linked role, you can use the same IAM process to create the role again.

Editing a service-linked role for DataSync

DataSync does not allow you to edit the AWSServiceRoleForDataSyncDiscovery service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide.

Deleting a service-linked role for DataSync

If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up the resources for your service-linked role before you can manually delete it.

Supported Regions for DataSync service-linked roles

DataSync supports using service-linked roles in all of the Regions where the service is available. For more information, see AWS Regions and endpoints.

DataSync does not support using service-linked roles in every Region where the service is available. You can use the AWSServiceRoleForDataSyncDiscovery role in the following Regions.