AssociateDRTRole
Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your AWS WAF configuration and logs and to create or update AWS WAF rules and web ACLs.
You can associate only one RoleArn
with your subscription. If you submit this update for an account that already has an associated role, the new RoleArn
will replace the existing RoleArn
.
This change requires the following:
-
You must be subscribed to the Business Support plan
or the Enterprise Support plan . -
The
AWSShieldDRTAccessPolicy
managed policy must be attached to the role that you specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For information, see Adding and removing IAM identity permissions. -
The role must trust the service principal
drt.shield.amazonaws.com
. For information, see IAM JSON policy elements: Principal.
The SRT will have access only to your AWS WAF and Shield resources. By submitting this request, you provide permissions to the SRT to inspect your AWS WAF and Shield configuration and logs, and to create and update AWS WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
Request Syntax
{
"RoleArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- RoleArn
-
The Amazon Resource Name (ARN) of the role the SRT will use to access your AWS account.
Prior to making the
AssociateDRTRole
request, you must attach the AWSShieldDRTAccessPolicy. managed policy to this role. For more information see Attaching and Detaching IAM Policies. Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedForDependencyException
-
In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the
iam:PassRole
permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.HTTP Status Code: 400
- InternalErrorException
-
Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
HTTP Status Code: 500
- InvalidOperationException
-
Exception that indicates that the operation would not cause any change to occur.
HTTP Status Code: 400
- InvalidParameterException
-
Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
HTTP Status Code: 400
- OptimisticLockException
-
Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
HTTP Status Code: 400
- ResourceNotFoundException
-
Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: