Shield / Client / enable_application_layer_automatic_response

enable_application_layer_automatic_response#

Shield.Client.enable_application_layer_automatic_response(**kwargs)#

Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.

Note

This feature is available for Amazon CloudFront distributions and Application Load Balancers only.

This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you’ve associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.

Note

Don’t use this action to make changes to automatic mitigation settings when it’s already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.

To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.

Request Syntax

response = client.enable_application_layer_automatic_response(
    ResourceArn='string',
    Action={
        'Block': {}
        ,
        'Count': {}

    }
)

Parameters:

ResourceArn (string) –
[REQUIRED]

The ARN (Amazon Resource Name) of the protected resource.
Action (dict) –
[REQUIRED]

Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
- Block (dict) –
  
  Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
  
  You must specify exactly one action, either Block or Count.
- Count (dict) –
  
  Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
  
  You must specify exactly one action, either Block or Count.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Shield.Client.exceptions.LimitsExceededException
Shield.Client.exceptions.InternalErrorException
Shield.Client.exceptions.ResourceNotFoundException
Shield.Client.exceptions.InvalidParameterException
Shield.Client.exceptions.OptimisticLockException
Shield.Client.exceptions.InvalidOperationException