NAME

Paws::Shield - Perl Interface to AWS AWS Shield

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Shield');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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 (https://docs.aws.amazon.com/waf/latest/developerguide/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02

METHODS

AssociateDRTLogBucket

LogBucket => Str

Each argument is described in detail in: Paws::Shield::AssociateDRTLogBucket

Returns: a Paws::Shield::AssociateDRTLogBucketResponse instance

Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow 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 (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

AssociateDRTRole

RoleArn => Str

Each argument is described in detail in: Paws::Shield::AssociateDRTRole

Returns: a Paws::Shield::AssociateDRTRoleResponse instance

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 (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html).

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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html).

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/).

CreateProtection

Name => Str
ResourceArn => Str

Each argument is described in detail in: Paws::Shield::CreateProtection

Returns: a Paws::Shield::CreateProtectionResponse instance

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 (https://console.aws.amazon.com/waf/). For more information see Getting Started with AWS Shield Advanced (https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html) and Add AWS Shield Advanced Protection to more AWS Resources (https://docs.aws.amazon.com/waf/latest/developerguide/configure-new-protection.html).

CreateSubscription

Each argument is described in detail in: Paws::Shield::CreateSubscription

Returns: a Paws::Shield::CreateSubscriptionResponse instance

Activates AWS Shield Advanced for an account.

As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf (https://docs.aws.amazon.com/waf/latest/developerguide/authorize-DRT.html).

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.

DeleteProtection

ProtectionId => Str

Each argument is described in detail in: Paws::Shield::DeleteProtection

Returns: a Paws::Shield::DeleteProtectionResponse instance

Deletes an AWS Shield Advanced Protection.

DeleteSubscription

Each argument is described in detail in: Paws::Shield::DeleteSubscription

Returns: a Paws::Shield::DeleteSubscriptionResponse instance

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.

DescribeAttack

AttackId => Str

Each argument is described in detail in: Paws::Shield::DescribeAttack

Returns: a Paws::Shield::DescribeAttackResponse instance

Describes the details of a DDoS attack.

DescribeDRTAccess

Each argument is described in detail in: Paws::Shield::DescribeDRTAccess

Returns: a Paws::Shield::DescribeDRTAccessResponse instance

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.

DescribeEmergencyContactSettings

Each argument is described in detail in: Paws::Shield::DescribeEmergencyContactSettings

Returns: a Paws::Shield::DescribeEmergencyContactSettingsResponse instance

Lists the email addresses that the DRT can use to contact you during a suspected attack.

DescribeProtection

[ProtectionId => Str]
[ResourceArn => Str]

Each argument is described in detail in: Paws::Shield::DescribeProtection

Returns: a Paws::Shield::DescribeProtectionResponse instance

Lists the details of a Protection object.

DescribeSubscription

Each argument is described in detail in: Paws::Shield::DescribeSubscription

Returns: a Paws::Shield::DescribeSubscriptionResponse instance

Provides details about the AWS Shield Advanced subscription for an account.

DisassociateDRTLogBucket

LogBucket => Str

Each argument is described in detail in: Paws::Shield::DisassociateDRTLogBucket

Returns: a Paws::Shield::DisassociateDRTLogBucketResponse instance

Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 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.

DisassociateDRTRole

Each argument is described in detail in: Paws::Shield::DisassociateDRTRole

Returns: a Paws::Shield::DisassociateDRTRoleResponse instance

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 (https://aws.amazon.com/premiumsupport/business-support/) or the Enterprise Support plan (https://aws.amazon.com/premiumsupport/enterprise-support/). 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.

GetSubscriptionState

Each argument is described in detail in: Paws::Shield::GetSubscriptionState

Returns: a Paws::Shield::GetSubscriptionStateResponse instance

Returns the SubscriptionState, either Active or Inactive.

ListAttacks

[EndTime => Paws::Shield::TimeRange]
[MaxResults => Int]
[NextToken => Str]
[ResourceArns => ArrayRef[Str|Undef]]
[StartTime => Paws::Shield::TimeRange]

Each argument is described in detail in: Paws::Shield::ListAttacks

Returns: a Paws::Shield::ListAttacksResponse instance

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

ListProtections

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Shield::ListProtections

Returns: a Paws::Shield::ListProtectionsResponse instance

Lists all Protection objects for the account.

UpdateEmergencyContactSettings

[EmergencyContactList => ArrayRef[Paws::Shield::EmergencyContact]]

Each argument is described in detail in: Paws::Shield::UpdateEmergencyContactSettings

Returns: a Paws::Shield::UpdateEmergencyContactSettingsResponse instance

Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.

UpdateSubscription

[AutoRenew => Str]

Each argument is described in detail in: Paws::Shield::UpdateSubscription

Returns: a Paws::Shield::UpdateSubscriptionResponse instance

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAttacks(sub { },[EndTime => Paws::Shield::TimeRange, MaxResults => Int, NextToken => Str, ResourceArns => ArrayRef[Str|Undef], StartTime => Paws::Shield::TimeRange])

ListAllAttacks([EndTime => Paws::Shield::TimeRange, MaxResults => Int, NextToken => Str, ResourceArns => ArrayRef[Str|Undef], StartTime => Paws::Shield::TimeRange])

If passed a sub as first parameter, it will call the sub for each element found in :

 - AttackSummaries, passing the object as the first parameter, and the string 'AttackSummaries' as the second parameter 

If not, it will return a a Paws::Shield::ListAttacksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProtections(sub { },[MaxResults => Int, NextToken => Str])

ListAllProtections([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Protections, passing the object as the first parameter, and the string 'Protections' as the second parameter 

If not, it will return a a Paws::Shield::ListProtectionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues