Using service-linked roles for Amazon Service Catalog
Amazon Service Catalog uses Amazon 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 Service Catalog. Service-linked roles are predefined by Amazon Service Catalog and include all the permissions that the service requires to call other Amazon services on your behalf.
A service-linked role makes setting up Amazon Service Catalog easier because you don’t have to manually add the necessary permissions. Amazon Service Catalog defines the permissions of its service-linked roles, and unless defined otherwise, only Amazon Service Catalog 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 Service Catalog resources because you can't inadvertently remove permission to access the resources.
For information about other services that support service-linked roles, see Amazon 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 AWSServiceRoleForServiceCatalogSync
Amazon Service Catalog can use the service-linked role named AWSServiceRoleForServiceCatalogSync
–
This service-linked role is required for Amazon Service Catalog to use CodeConnections and to create, update, and describe Amazon Service Catalog
Provisioning Artifacts for a product.
The AWSServiceRoleForServiceCatalogSync
service-linked role trusts the following services to assume the
role:
-
sync.servicecatalog.amazonaws.com
The role permissions policy named AWSServiceCatalogSyncServiceRolePolicy allows Amazon Service Catalog to complete the following actions on the specified resources:
-
Action:
Connection
onCodeConnections
-
Action:
Create, Update, and Describe
onProvisioningArtifact
for a Amazon Service Catalog product
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 the AWSServiceRoleForServiceCatalogSync
service-linked role
You do not need to manually create the
service-linked role. Amazon Service Catalog
creates the service-linked role for you automatically when you
establish CodeConnections in the Amazon Web Services Management Console, the Amazon CLI, or the Amazon API. AWSServiceRoleForServiceCatalogSync
Important
This service-linked role can appear in your account if you completed an action in
another service that uses the features supported by this role. Also, if you were using the
Amazon Service Catalog service before November 18, 2022, when it began supporting service-linked roles,
then Amazon Service Catalog created the AWSServiceRoleForServiceCatalogSync
role in your account. To learn more, see A new
role appeared in my IAM account.
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 establish CodeConnections, Amazon Service Catalog creates the service-linked role for you again.
You can also use the IAM console to create a service-linked role with the
synced Amazon Service Catalog Products use case. In the Amazon CLI or the Amazon API, create
a service-linked role with the sync.servicecatalog.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.
Service-linked role permissions for AWSServiceRoleForServiceCatalogOrgsDataSync
Amazon Service Catalog can use the service-linked role named AWSServiceRoleForServiceCatalogOrgsDataSync
–
This service-linked role is required for Amazon Service Catalog organizations to stay in sync with Amazon Organizations.
The AWSServiceRoleForServiceCatalogOrgsDataSync
service-linked role trusts the following services to assume the
role:
-
orgsdatasync.servicecatalog.amazonaws.com
The AWSServiceRoleForServiceCatalogOrgsDataSync
service-linked role requires that you use the following
trust policy in addition to the AWSServiceCatalogOrgsDataSyncServiceRolePolicy
managed policy:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "orgsdatasync.servicecatalog.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }
The role permissions policy named AWSServiceCatalogOrgsDataSyncServiceRolePolicy allows Amazon Service Catalog to complete the following actions on the specified resources:
-
Action:
DescribeAccount
,DescribeOrganization
, andListAWSServiceAccessForOrganization
onOrganizations accounts
-
Action:
ListAccounts
,ListChildren
, andListParent
onOrganizations accounts
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 the AWSServiceRoleForServiceCatalogOrgsDataSync
service-linked role
You do not need to manually create the
service-linked role. Amazon Service Catalog
considers your action of enabling Sharing with Amazon Organizations
or Sharing a Portfolio
as permission for Amazon Service Catalog to create a SLR in the background on your behalf. AWSServiceRoleForServiceCatalogOrgsDataSync
Amazon Service Catalog creates the service-linked role for you automatically when you
request EnableAWSOrganizationsAccess
or CreatePortfolioShare
in the Amazon Web Services Management Console, the Amazon CLI, or the Amazon API.
Important
This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role. To learn more, see A new role appeared in my IAM account.
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 request EnableAWSOrganizationsAccess
or CreatePortfolioShare
,
Amazon Service Catalog creates the service-linked role for you again.
Editing a service-linked role for Amazon Service Catalog
Amazon Service Catalog does not allow you to edit the AWSServiceRoleForServiceCatalogSync
or AWSServiceRoleForServiceCatalogOrgsDataSync
service-linked roles. 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 Service Catalog
You can use the IAM console, the Amazon CLI, or the Amazon API to manually delete the AWSServiceRoleForServiceCatalogSync
or
AWSServiceRoleForServiceCatalogOrgsDataSync
SLR. To do this, you must first manually remove all resources that are using the
service-linked role (for example, any Amazon Service Catalog products that are synced to an external repository),
and then the service-linked role can be
manually deleted.
Supported regions for Amazon Service Catalog service-linked roles
Amazon Service Catalog supports using service-linked roles in all of the regions where the service is available. For more information, see Amazon regions and endpoints.
Region name | Region identity | Support in Amazon Service Catalog |
---|---|---|
US East (N. Virginia) | us-east-1 | Yes |
us-west-2 | Yes | |
US West (N. California) | us-west-1 | Yes |
US West (Oregon) | us-west-2 | Yes |
Africa (Cape Town) | af-south-1 | Yes |
Asia Pacific (Hong Kong) | ap-east-1 | Yes |
Asia Pacific (Jakarta) | ap-southeast-3 | Yes |
Asia Pacific (Mumbai) | ap-south-1 | Yes |
Asia Pacific (Osaka) | ap-northeast-3 | Yes |
Asia Pacific (Seoul) | ap-northeast-2 | Yes |
Asia Pacific (Singapore) | ap-southeast-1 | Yes |
Asia Pacific (Sydney) | ap-southeast-2 | Yes |
Asia Pacific (Tokyo) | ap-northeast-1 | Yes |
Canada (Central) | ca-central-1 | Yes |
Europe (Frankfurt) | eu-central-1 | Yes |
Europe (Ireland) | eu-west-1 | Yes |
Europe (London) | eu-west-2 | Yes |
Europe (Milan) | eu-south-1 | Yes |
Europe (Paris) | eu-west-3 | Yes |
Europe (Stockholm) | eu-north-1 | Yes |
Middle East (Bahrain) | me-south-1 | Yes |
South America (São Paulo) | sa-east-1 | Yes |
China (Beijing) | cn-north-1 | No |
China (Ningxia) | cn-northwest-1 | No |
Amazon GovCloud (US-East) | us-gov-east-1 | No |
Amazon GovCloud (US-West) | us-gov-west-1 | No |