amazonka-shield-2.0: Amazon Shield SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Shield.AssociateDRTRole

Description

Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and removing IAM identity permissions. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON policy elements: Principal.

The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service.

To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Synopsis

Creating a Request

data AssociateDRTRole Source #

See: newAssociateDRTRole smart constructor.

Constructors

AssociateDRTRole' 

Fields

Instances

Instances details
ToJSON AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

ToHeaders AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

ToPath AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

ToQuery AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

AWSRequest AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Associated Types

type AWSResponse AssociateDRTRole #

Generic AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Associated Types

type Rep AssociateDRTRole :: Type -> Type #

Read AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Show AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

NFData AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Methods

rnf :: AssociateDRTRole -> () #

Eq AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Hashable AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

type AWSResponse AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

type Rep AssociateDRTRole Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

type Rep AssociateDRTRole = D1 ('MetaData "AssociateDRTRole" "Amazonka.Shield.AssociateDRTRole" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "AssociateDRTRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAssociateDRTRole Source #

Create a value of AssociateDRTRole with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:roleArn:AssociateDRTRole', associateDRTRole_roleArn - The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services 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.

Request Lenses

associateDRTRole_roleArn :: Lens' AssociateDRTRole Text Source #

The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services 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.

Destructuring the Response

data AssociateDRTRoleResponse Source #

See: newAssociateDRTRoleResponse smart constructor.

Constructors

AssociateDRTRoleResponse' 

Fields

Instances

Instances details
Generic AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Associated Types

type Rep AssociateDRTRoleResponse :: Type -> Type #

Read AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Show AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

NFData AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

Eq AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

type Rep AssociateDRTRoleResponse Source # 
Instance details

Defined in Amazonka.Shield.AssociateDRTRole

type Rep AssociateDRTRoleResponse = D1 ('MetaData "AssociateDRTRoleResponse" "Amazonka.Shield.AssociateDRTRole" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "AssociateDRTRoleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateDRTRoleResponse Source #

Create a value of AssociateDRTRoleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:AssociateDRTRoleResponse', associateDRTRoleResponse_httpStatus - The response's http status code.

Response Lenses