AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <ShieldClient.h>
<fullname>Shield Advanced</fullname>
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
Definition at line 27 of file ShieldClient.h.
Definition at line 30 of file ShieldClient.h.
Definition at line 34 of file ShieldClient.h.
Definition at line 35 of file ShieldClient.h.
Aws::Shield::ShieldClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Shield::ShieldClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Shield::ShieldClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket
request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
nullptr
An Async wrapper for AssociateDRTLogBucket that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 113 of file ShieldClient.h.
A Callable wrapper for AssociateDRTLogBucket that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 104 of file ShieldClient.h.
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.
nullptr
An Async wrapper for AssociateDRTRole that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 168 of file ShieldClient.h.
A Callable wrapper for AssociateDRTRole that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 159 of file ShieldClient.h.
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
nullptr
An Async wrapper for AssociateHealthCheck that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 200 of file ShieldClient.h.
A Callable wrapper for AssociateHealthCheck that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 191 of file ShieldClient.h.
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement
and EnableProactiveEngagement
.
This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings
and then provide it to this call.
nullptr
An Async wrapper for AssociateProactiveEngagementDetails that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 236 of file ShieldClient.h.
A Callable wrapper for AssociateProactiveEngagementDetails that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 227 of file ShieldClient.h.
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection
request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources.
nullptr
An Async wrapper for CreateProtection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 275 of file ShieldClient.h.
A Callable wrapper for CreateProtection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 266 of file ShieldClient.h.
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
nullptr
An Async wrapper for CreateProtectionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 302 of file ShieldClient.h.
A Callable wrapper for CreateProtectionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 293 of file ShieldClient.h.
{}
)
const
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription
request.
nullptr
,
{}
An Async wrapper for CreateSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 333 of file ShieldClient.h.
{}
)
const
A Callable wrapper for CreateSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 324 of file ShieldClient.h.
nullptr
An Async wrapper for DeleteProtection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 358 of file ShieldClient.h.
A Callable wrapper for DeleteProtection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 349 of file ShieldClient.h.
nullptr
An Async wrapper for DeleteProtectionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 383 of file ShieldClient.h.
A Callable wrapper for DeleteProtectionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 374 of file ShieldClient.h.
nullptr
An Async wrapper for DescribeAttack that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 408 of file ShieldClient.h.
A Callable wrapper for DescribeAttack that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 399 of file ShieldClient.h.
{}
)
const
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT
, equal to 2020-10-26 22:39:32 UTC
, then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC
to 2020-10-26 00:00:00 UTC
.
The time range indicates the period covered by the attack statistics data items.
nullptr
,
{}
An Async wrapper for DescribeAttackStatistics that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 443 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DescribeAttackStatistics that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 434 of file ShieldClient.h.
{}
)
const
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
nullptr
,
{}
An Async wrapper for DescribeDRTAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 470 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DescribeDRTAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 461 of file ShieldClient.h.
{}
)
const
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
nullptr
,
{}
An Async wrapper for DescribeEmergencyContactSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 498 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DescribeEmergencyContactSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 489 of file ShieldClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeProtection that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 524 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DescribeProtection that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 515 of file ShieldClient.h.
nullptr
An Async wrapper for DescribeProtectionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 550 of file ShieldClient.h.
A Callable wrapper for DescribeProtectionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 541 of file ShieldClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DescribeSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 576 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DescribeSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 567 of file ShieldClient.h.
nullptr
An Async wrapper for DisableApplicationLayerAutomaticResponse that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 604 of file ShieldClient.h.
A Callable wrapper for DisableApplicationLayerAutomaticResponse that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 595 of file ShieldClient.h.
{}
)
const
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
nullptr
,
{}
An Async wrapper for DisableProactiveEngagement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 631 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DisableProactiveEngagement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 622 of file ShieldClient.h.
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
nullptr
An Async wrapper for DisassociateDRTLogBucket that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 658 of file ShieldClient.h.
A Callable wrapper for DisassociateDRTLogBucket that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 649 of file ShieldClient.h.
{}
)
const
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
nullptr
,
{}
An Async wrapper for DisassociateDRTRole that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 684 of file ShieldClient.h.
{}
)
const
A Callable wrapper for DisassociateDRTRole that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 675 of file ShieldClient.h.
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
nullptr
An Async wrapper for DisassociateHealthCheck that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 717 of file ShieldClient.h.
A Callable wrapper for DisassociateHealthCheck that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 708 of file ShieldClient.h.
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
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.
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.
nullptr
An Async wrapper for EnableApplicationLayerAutomaticResponse that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 765 of file ShieldClient.h.
A Callable wrapper for EnableApplicationLayerAutomaticResponse that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 756 of file ShieldClient.h.
{}
)
const
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
nullptr
,
{}
An Async wrapper for EnableProactiveEngagement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 792 of file ShieldClient.h.
{}
)
const
A Callable wrapper for EnableProactiveEngagement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 783 of file ShieldClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for GetSubscriptionState that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 818 of file ShieldClient.h.
{}
)
const
A Callable wrapper for GetSubscriptionState that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 809 of file ShieldClient.h.
{}
)
const
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
nullptr
,
{}
An Async wrapper for ListAttacks that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 844 of file ShieldClient.h.
{}
)
const
A Callable wrapper for ListAttacks that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 835 of file ShieldClient.h.
{}
)
const
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
nullptr
,
{}
An Async wrapper for ListProtectionGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 872 of file ShieldClient.h.
{}
)
const
A Callable wrapper for ListProtectionGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 863 of file ShieldClient.h.
{}
)
const
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
nullptr
,
{}
An Async wrapper for ListProtections that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 899 of file ShieldClient.h.
{}
)
const
A Callable wrapper for ListProtections that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 890 of file ShieldClient.h.
nullptr
An Async wrapper for ListResourcesInProtectionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 925 of file ShieldClient.h.
A Callable wrapper for ListResourcesInProtectionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 916 of file ShieldClient.h.
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 951 of file ShieldClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 942 of file ShieldClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 976 of file ShieldClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 967 of file ShieldClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1001 of file ShieldClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 992 of file ShieldClient.h.
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
nullptr
An Async wrapper for UpdateApplicationLayerAutomaticResponse that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1028 of file ShieldClient.h.
A Callable wrapper for UpdateApplicationLayerAutomaticResponse that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1019 of file ShieldClient.h.
{}
)
const
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
nullptr
,
{}
An Async wrapper for UpdateEmergencyContactSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1056 of file ShieldClient.h.
{}
)
const
A Callable wrapper for UpdateEmergencyContactSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1047 of file ShieldClient.h.
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
nullptr
An Async wrapper for UpdateProtectionGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1084 of file ShieldClient.h.
A Callable wrapper for UpdateProtectionGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1075 of file ShieldClient.h.
{}
)
const
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
nullptr
,
{}
An Async wrapper for UpdateSubscription that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1114 of file ShieldClient.h.
{}
)
const
A Callable wrapper for UpdateSubscription that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1105 of file ShieldClient.h.
Definition at line 1121 of file ShieldClient.h.