Using service-linked roles for Amazon AppIntegrations

Amazon AppIntegrations 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 Amazon AppIntegrations. Service-linked roles are predefined by Amazon AppIntegrations and include all the permissions that the service requires to call other AWS services on your behalf.

A service-linked role makes setting up Amazon AppIntegrations easier because you don’t have to manually add the necessary permissions. Amazon AppIntegrations defines the permissions of its service-linked roles, and unless defined otherwise, only Amazon AppIntegrations 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 Amazon AppIntegrations 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 Amazon AppIntegrations

Amazon AppIntegrations uses the service-linked role named AWSServiceRoleForAppIntegrations which allows AppIntegrations to access AWS services and resources on your behalf.

The AWSServiceRoleForAppIntegrations service-linked role trusts the following service to assume the role:

The role permissions policy named AppIntegrationsServiceLinkedRolePolicy allows Amazon AppIntegrations to complete the following actions on the specified resources:

     {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "cloudwatch:PutMetricData"
            ],
            "Resource": "*",
            "Condition": {
                "StringEquals": {
                    "cloudwatch:namespace": "AWS/AppIntegrations"
                }
            }
        },
        {
            "Effect": "Allow",
            "Action": [
                "appflow:DescribeConnectorEntity",
                "appflow:ListConnectorEntities"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "appflow:DescribeConnectorProfiles",
                "appflow:UseConnectorProfile"
            ],
            "Resource": "arn:aws:appflow:*:*:connector-profile/*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "appflow:DeleteFlow",
                "appflow:DescribeFlow",
                "appflow:DescribeFlowExecutionRecords",
                "appflow:StartFlow",
                "appflow:StopFlow",
                "appflow:UpdateFlow"
            ],
            "Condition": {
                "StringEquals": {
                    "aws:ResourceTag/AppIntegrationsManaged": "true"
                }
            },
            "Resource": "arn:aws:appflow:*:*:flow/FlowCreatedByAppIntegrations-*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "appflow:TagResource"
            ],
            "Condition": {
                "ForAllValues:StringEquals": {
                    "aws:TagKeys": [
                        "AppIntegrationsManaged"
                    ]
                }
            },
            "Resource": "arn:aws:appflow:*:*:flow/FlowCreatedByAppIntegrations-*"
        }
    ]
}
   

You must configure permissions to allow an IAM entity (such as a user, group, or role) 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 Amazon AppIntegrations

You don't need to manually create a service-linked role. When you create a data or event integration using either the Amazon Q in Connect, Customer Profiles, or Tasks widget in Amazon Connect in the AWS Management Console, the AWS CLI, or the AWS API, Amazon AppIntegrations creates the service-linked role for you.

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 create a data or event integration using either the Amazon Q in Connect, Customer Profiles, or Tasks widget in Amazon Connect, Amazon AppIntegrations creates the service-linked role for you again.

You can also use the IAM console to create a service-linked role with the AppIntegrations use case. In the AWS CLI or the AWS API, create a service-linked role with the app-integrations.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.

Editing a service-linked role for Amazon AppIntegrations

Amazon AppIntegrations does not allow you to edit the AWSServiceRoleForAppIntegrations 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 Amazon AppIntegrations

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. You must first delete your data and event integration associations in the AWS Console and then delete your data and event integrations using the AWS CLI.

To manually delete the service-linked role using IAM

Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForAppIntegrations service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide.

Supported regions for Amazon AppIntegrations service-linked roles

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

You can use the AWSServiceRoleForAppIntegrations role in the following regions.