Using service-linked roles for App Runner - AWS App Runner

Using service-linked roles for App Runner

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

A service-linked role makes setting up App Runner easier because you don't have to manually add the necessary permissions. App Runner defines the permissions of its service-linked roles, and unless defined otherwise, only App Runner 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 App Runner 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 Role column. Choose a Yes with a link to view the service-linked role documentation for that service.

For other App Runner security topics, see Security in App Runner.

Service-linked role permissions for App Runner

App Runner uses the service-linked role named AWSServiceRoleForAppRunner.

The role allows App Runner to perform the following tasks:

  • Push logs to Amazon CloudWatch Logs log groups.

  • Create Amazon CloudWatch Events rules to subscribe to Amazon Elastic Container Registry (Amazon ECR) image pushes.

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

  • apprunner.amazonaws.com

The permissions policy of the AWSServiceRoleForAppRunner service-linked role contains all of the permissions that App Runner needs to complete actions on your behalf.

{ "Version": "2012-10-17", "Statement": [ { "Action": [ "logs:CreateLogGroup", "logs:PutRetentionPolicy" ], "Effect": "Allow", "Resource": "arn:aws:logs:*:*:log-group:/aws/apprunner/*" }, { "Effect": "Allow", "Action": [ "logs:CreateLogStream", "logs:PutLogEvents", "logs:DescribeLogStreams" ], "Resource": [ "arn:aws:logs:*:*:log-group:/aws/apprunner/*:log-stream:*" ] }, { "Sid": "AllowPutRuleForManagedRules", "Effect": "Allow", "Action": [ "events: PutRule", "events: PutTargets", "events: DeleteRule", "events: RemoveTargets", "events: DisableRule", "events: EnableRule" ], "Resource": "arn:aws:events:*:*:rule/apprunner-*", "Condition": { "StringEquals": { "events:ManagedBy": "apprunner.amazonaws.com", "events:source": "aws.ecr", "events:detail-type": "ECR Image Action" } } } ] }

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 App Runner

You don't need to manually create a service-linked role. When you create an App Runner service in the AWS Management Console, the AWS CLI, or the AWS API, App Runner 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 an App Runner service, App Runner creates the service-linked role for you again.

Editing a service-linked role for App Runner

App Runner does not allow you to edit the AWSServiceRoleForAppRunner 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 App Runner

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.

In App Runner, this means deleting all App Runner services in your account. To learn about deleting App Runner services, see Deleting an App Runner service.

Note

If the App Runner service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again.

To manually delete the service-linked role using IAM

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

Supported regions for App Runner service-linked roles

App Runner supports using service-linked roles in all of the regions where the service is available. For more information, see AWS App Runner endpoints and quotas in the AWS General Reference.