aws-elixir v0.6.0 AWS.Shield View Source
AWS Shield Advanced
This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.
Link to this section Summary
Functions
Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list.
Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
Activates AWS Shield Advanced for an account.
Deletes an AWS Shield Advanced Protection
.
Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
Describes the details of a DDoS attack.
Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
Lists the details of a Protection
object.
Provides details about the AWS Shield Advanced subscription for an account.
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
Removes the DDoS Response Team's (DRT) access to your AWS account.
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
Returns the SubscriptionState
, either Active
or Inactive
.
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
Lists all Protection
objects for the account.
Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
Link to this section Functions
Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the DRT and make an AssociateDRTLogBucket
request,
you must be subscribed to the Business Support
plan or the
Enterprise Support
plan.
Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS 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 you will specify in the request. For more
information see Attaching and Detaching IAM Policies.
The role must also trust the service principal drt.shield.amazonaws.com
.
For more information, see IAM JSON Policy Elements:
Principal.
The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT 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 AWS
Service.
To use the services of the DRT and make an AssociateDRTRole
request, you
must be subscribed to the Business Support
plan or the
Enterprise Support
plan.
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
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 AWS WAF and AWS Shield Developer Guide.
associate_proactive_engagement_details(client, input, options \\ [])
View SourceInitializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) 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
.
Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.
You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
Activates AWS Shield Advanced for an account.
When you initally 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.
Deletes an AWS Shield Advanced Protection
.
Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
Describes the details of a DDoS attack.
Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
Lists the details of a Protection
object.
Provides details about the AWS Shield Advanced subscription for an account.
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.
To make a DisassociateDRTLogBucket
request, you must be subscribed to the
Business Support
plan or the
Enterprise Support
plan. However,
if you are not subscribed to one of these support plans, but had been
previously and had granted the DRT access to your account, you can submit a
DisassociateDRTLogBucket
request to remove this access.
Removes the DDoS Response Team's (DRT) access to your AWS account.
To make a DisassociateDRTRole
request, you must be subscribed to the
Business Support
plan or the
Enterprise Support
plan. However,
if you are not subscribed to one of these support plans, but had been
previously and had granted the DRT access to your account, you can submit a
DisassociateDRTRole
request to remove this access.
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.
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 AWS WAF and AWS Shield Developer Guide.
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
Returns the SubscriptionState
, either Active
or Inactive
.
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
Lists all Protection
objects for the account.
Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.