Using service-linked roles for Amazon WAF Classic - Amazon WAF, Amazon Firewall Manager, and Amazon Shield Advanced
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Using service-linked roles for Amazon WAF Classic

Note

This is Amazon WAF Classic documentation. You should only use this version if you created Amazon WAF resources, like rules and web ACLs, in Amazon WAF prior to November 2019, and you have not migrated them over to the latest version yet. To migrate your resources, see Migrating your Amazon WAF Classic resources to Amazon WAF.

For the latest version of Amazon WAF, see Amazon WAF.

Amazon WAF Classic 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 WAF Classic. Service-linked roles are predefined by Amazon WAF Classic 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 WAF Classic easier because you don’t have to manually add the necessary permissions. Amazon WAF Classic defines the permissions of its service-linked roles, and unless defined otherwise, only Amazon WAF Classic can assume its roles. The defined permissions include the trust policy and the permissions policy. That permissions policy can't be attached to any other IAM entity.

You can delete a service-linked role only after first deleting the role's related resources. This protects your Amazon WAF Classic 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 Role column. Choose a Yes with a link to view the service-linked role documentation for that service.

Service-linked role permissions for Amazon WAF Classic

Amazon WAF Classic uses the following service-linked roles:

  • AWSServiceRoleForWAFLogging

  • AWSServiceRoleForWAFRegionalLogging

Amazon WAF Classic uses these service-linked roles to write logs to Amazon Data Firehose. These roles are used only if you enable logging in Amazon WAF. For more information, see Logging Web ACL traffic information.

The AWSServiceRoleForWAFLogging and AWSServiceRoleForWAFRegionalLogging service-linked roles trust the following services (respectively) to assume the role:

  • waf.amazonaws.com

    waf-regional.amazonaws.com

The permissions policies of the roles allow Amazon WAF Classic to complete the following actions on the specified resources:

  • Action: firehose:PutRecord and firehose:PutRecordBatch on Amazon Data Firehose data stream resources with a name that starts with "aws-waf-logs-." For example, aws-waf-logs-us-east-2-analytics.

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 WAF Classic

You don't need to manually create a service-linked role. When you enable Amazon WAF Classic logging on the Amazon Web Services Management Console, or you make a PutLoggingConfiguration request in the Amazon WAF Classic CLI or the Amazon WAF Classic API, Amazon WAF Classic creates the service-linked role for you.

You must have the iam:CreateServiceLinkedRole permission to enable logging.

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 enable Amazon WAF Classic logging, Amazon WAF Classic creates the service-linked role for you again.

Editing a service-linked role for Amazon WAF Classic

Amazon WAF Classic doesn't allow you to edit the AWSServiceRoleForWAFLogging and AWSServiceRoleForWAFRegionalLogging service-linked roles. After you create a service-linked role, you can't 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 WAF Classic

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.

Note

If the Amazon WAF Classic 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 delete Amazon WAF Classic resources used by the AWSServiceRoleForWAFLogging and AWSServiceRoleForWAFRegionalLogging
  1. On the Amazon WAF Classic console, remove logging from every web ACL. For more information, see Logging Web ACL traffic information.

  2. Using the API or CLI, submit a DeleteLoggingConfiguration request for each web ACL that has logging enabled. For more information, see Amazon WAF Classic API Reference.

To manually delete the service-linked role using IAM

Use the IAM console, the IAM CLI, or the IAM API to delete the AWSServiceRoleForWAFLogging and AWSServiceRoleForWAFRegionalLogging service-linked roles. For more information, see Deleting a Service-Linked Role in the IAM User Guide.

Supported Regions for Amazon WAF Classic service-linked roles

Amazon WAF Classic supports using service-linked roles in the following Amazon Web Services Regions.

Region Name Region Identity Support in Amazon WAF Classic
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
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 (Paris) eu-west-3 Yes
South America (São Paulo) sa-east-1 Yes
China (Beijing) cn-north-1 No