CfnProtectionProps Struct
Properties for defining a CfnProtection.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_shield as shield } from 'aws-cdk-lib';
declare const block: any;
declare const count: any;
const cfnProtectionProps: shield.CfnProtectionProps = {
name: 'name',
resourceArn: 'resourceArn',
// the properties below are optional
applicationLayerAutomaticResponseConfiguration: {
action: {
block: block,
count: count,
},
status: 'status',
},
healthCheckArns: ['healthCheckArns'],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
applicationLayerAutomaticResponseConfigurationIResolvable | CfnProtection.ApplicationLayerAutomaticResponseConfigurationPropertyapplication_layer_automatic_response_configurationtyping.Union[IResolvable, ApplicationLayerAutomaticResponseConfigurationProperty]applicationLayerAutomaticResponseConfigurationIResolvableApplicationLayerAutomaticResponseConfigurationIResolvableApplicationLayerAutomaticResponseConfigurationinterface{}#notes
This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
If you use CloudFormation to manage the web ACLs that you use with Shield Advanced automatic mitigation, see the additional guidance about web ACL management in the AWS::WAFv2::WebACL resource description.
healthCheckArnsstring[]health_check_arnstyping.List[str]healthCheckArnsList<String>HealthCheckArnsstring[]HealthCheckArns*[]*string#notes
Health-based detection provides improved responsiveness and accuracy in attack detection and mitigation.
You can use this option with any resource type except for Route 53 hosted zones.
For more information, see Configuring health-based detection using health checks in the AWS Shield Advanced Developer Guide .
If you change the name of an existing protection, Shield Advanced deletes the protection and replaces it with a new one. While this is happening, the protection isn't available on the AWS resource.
notes
The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.