Class: AWS.Shield

Inherits:

AWS.Service

Object
AWS.Service
AWS.Shield

show all

Identifier:: shield

API Version:: 2016-06-02

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using Shield

var shield = new AWS.Shield();
shield.associateDRTLogBucket(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Shield object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var shield = new AWS.Shield({apiVersion: '2016-06-02'});

You can also set the API version globally in AWS.config.apiVersions using the shield service identifier:

AWS.config.apiVersions = {
  shield: '2016-06-02',
  // other service API versions
};

var shield = new AWS.Shield();

Version:

2016-06-02

Constructor Summary

new AWS.Shield(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

associateDRTLogBucket(params = {}, callback) ⇒ AWS.Request
Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs.
associateDRTRole(params = {}, callback) ⇒ AWS.Request
Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
createProtection(params = {}, callback) ⇒ AWS.Request
Enables AWS Shield Advanced for a specific AWS resource.
createSubscription(params = {}, callback) ⇒ AWS.Request
Activates AWS Shield Advanced for an account.
deleteProtection(params = {}, callback) ⇒ AWS.Request
Deletes an AWS Shield Advanced Protection.
deleteSubscription(params = {}, callback) ⇒ AWS.Request
Removes AWS Shield Advanced from an account.
describeAttack(params = {}, callback) ⇒ AWS.Request
Describes the details of a DDoS attack.
describeDRTAccess(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
Lists the email addresses that the DRT can use to contact you during a suspected attack.
describeProtection(params = {}, callback) ⇒ AWS.Request
Lists the details of a Protection object.
describeSubscription(params = {}, callback) ⇒ AWS.Request
Provides details about the AWS Shield Advanced subscription for an account.
disassociateDRTLogBucket(params = {}, callback) ⇒ AWS.Request
Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.
disassociateDRTRole(params = {}, callback) ⇒ AWS.Request
Removes the DDoS Response team's (DRT) access to your AWS account.
getSubscriptionState(params = {}, callback) ⇒ AWS.Request
Returns the SubscriptionState, either Active or Inactive.
listAttacks(params = {}, callback) ⇒ AWS.Request
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listProtections(params = {}, callback) ⇒ AWS.Request
Lists all Protection objects for the account.
updateEmergencyContactSettings(params = {}, callback) ⇒ AWS.Request
Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.
updateSubscription(params = {}, callback) ⇒ AWS.Request
Updates the details of an existing subscription.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Shield(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Shield object

var shield = new AWS.Shield({apiVersion: '2016-06-02'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.Shield.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.Shield.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.Shield.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean) —
whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

associateDRTLogBucket(params = {}, callback) ⇒ `AWS.Request`

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 or the Enterprise Support plan.

Service Reference:

AssociateDRTLogBucket

Examples:

Calling the associateDRTLogBucket operation

var params = {
  LogBucket: 'STRING_VALUE' /* required */
};
shield.associateDRTLogBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- LogBucket — (String)
  The Amazon S3 bucket that contains your flow logs.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

associateDRTRole(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

AssociateDRTRole

Examples:

Calling the associateDRTRole operation

var params = {
  RoleArn: 'STRING_VALUE' /* required */
};
shield.associateDRTRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- RoleArn — (String)
  The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.
  
  Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createProtection(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

CreateProtection

Examples:

Calling the createProtection operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
shield.createProtection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Name — (String)
  Friendly name for the Protection you are creating.
- ResourceArn — (String)
  The ARN (Amazon Resource Name) of the resource to be protected.
  
  The ARN should be in one of the following formats:
  - For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
  - For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
  - For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id
  - For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
  - For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
  - For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ProtectionId — (String)
    The unique identifier (ID) for the Protection object that is created.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createSubscription(params = {}, callback) ⇒ `AWS.Request`

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.

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.

Service Reference:

CreateSubscription

Examples:

Calling the createSubscription operation

var params = {
};
shield.createSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteProtection(params = {}, callback) ⇒ `AWS.Request`

Deletes an AWS Shield Advanced Protection.

Service Reference:

DeleteProtection

Examples:

Calling the deleteProtection operation

var params = {
  ProtectionId: 'STRING_VALUE' /* required */
};
shield.deleteProtection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ProtectionId — (String)
  The unique identifier (ID) for the Protection object to be deleted.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteSubscription(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

DeleteSubscription

Examples:

Calling the deleteSubscription operation

var params = {
};
shield.deleteSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeAttack(params = {}, callback) ⇒ `AWS.Request`

Describes the details of a DDoS attack.

Service Reference:

DescribeAttack

Examples:

Calling the describeAttack operation

var params = {
  AttackId: 'STRING_VALUE' /* required */
};
shield.describeAttack(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AttackId — (String)
  The unique identifier (ID) for the attack that to be described.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Attack — (map)
    The attack that is described.
    
    AttackId — (String)
    The unique identifier (ID) of the attack.
    
    ResourceArn — (String)
    The ARN (Amazon Resource Name) of the resource that was attacked.
    
    SubResources — (Array<map>)
    If applicable, additional detail about the resource being attacked, for example, IP address or URL.
    
    Type — (String)
    The SubResource type.
    Possible values include:
    
    "IP"
    
    "URL"
    
    Id — (String)
    The unique identifier (ID) of the SubResource.
    
    AttackVectors — (Array<map>)
    The list of attack types and associated counters.
    
    VectorType — required — (String)
    The attack type, for example, SNMP reflection or SYN flood.
    
    VectorCounters — (Array<map>)
    The list of counters that describe the details of the attack.
    
    Name — (String)
    The counter name.
    
    Max — (Float)
    The maximum value of the counter for a specified time period.
    
    Average — (Float)
    The average value of the counter for a specified time period.
    
    Sum — (Float)
    The total of counter values for a specified time period.
    
    N — (Integer)
    The number of counters for a specified time period.
    
    Unit — (String)
    The unit of the counters.
    
    Counters — (Array<map>)
    The counters that describe the details of the attack.
    
    Name — (String)
    The counter name.
    
    Max — (Float)
    The maximum value of the counter for a specified time period.
    
    Average — (Float)
    The average value of the counter for a specified time period.
    
    Sum — (Float)
    The total of counter values for a specified time period.
    
    N — (Integer)
    The number of counters for a specified time period.
    
    Unit — (String)
    The unit of the counters.
    
    StartTime — (Date)
    The time the attack started, in Unix time in seconds. For more information see timestamp.
    
    EndTime — (Date)
    The time the attack ended, in Unix time in seconds. For more information see timestamp.
    
    AttackCounters — (Array<map>)
    List of counters that describe the attack for the specified time period.
    
    Name — (String)
    The counter name.
    
    Max — (Float)
    The maximum value of the counter for a specified time period.
    
    Average — (Float)
    The average value of the counter for a specified time period.
    
    Sum — (Float)
    The total of counter values for a specified time period.
    
    N — (Integer)
    The number of counters for a specified time period.
    
    Unit — (String)
    The unit of the counters.
    
    AttackProperties — (Array<map>)
    The array of AttackProperty objects.
    
    AttackLayer — (String)
    The type of DDoS event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
    Possible values include:
    
    "NETWORK"
    
    "APPLICATION"
    
    AttackPropertyIdentifier — (String)
    Defines the DDoS attack property information that is provided.
    Possible values include:
    
    "DESTINATION_URL"
    
    "REFERRER"
    
    "SOURCE_ASN"
    
    "SOURCE_COUNTRY"
    
    "SOURCE_IP_ADDRESS"
    
    "SOURCE_USER_AGENT"
    
    TopContributors — (Array<map>)
    The array of Contributor objects that includes the top five contributors to an attack.
    
    Name — (String)
    The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
    
    Value — (Integer)
    The contribution of this contributor expressed in Protection units. For example 10,000.
    
    Unit — (String)
    The unit of the Value of the contributions.
    Possible values include:
    
    "BITS"
    
    "BYTES"
    
    "PACKETS"
    
    "REQUESTS"
    
    Total — (Integer)
    The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.
    
    Mitigations — (Array<map>)
    List of mitigation actions taken for the attack.
    
    MitigationName — (String)
    The name of the mitigation taken for this attack.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeDRTAccess(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

DescribeDRTAccess

Examples:

Calling the describeDRTAccess operation

var params = {
};
shield.describeDRTAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - RoleArn — (String)
    The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.
  - LogBucketList — (Array<String>)
    The list of Amazon S3 buckets accessed by the DRT.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeEmergencyContactSettings(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

DescribeEmergencyContactSettings

Examples:

Calling the describeEmergencyContactSettings operation

var params = {
};
shield.describeEmergencyContactSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - EmergencyContactList — (Array<map>)
    A list of email addresses that the DRT can use to contact you during a suspected attack.
    
    EmailAddress — required — (String)
    An email address that the DRT can use to contact you during a suspected attack.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeProtection(params = {}, callback) ⇒ `AWS.Request`

Lists the details of a Protection object.

Service Reference:

DescribeProtection

Examples:

Calling the describeProtection operation

var params = {
  ProtectionId: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE'
};
shield.describeProtection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ProtectionId — (String)
  The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.
- ResourceArn — (String)
  The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Protection — (map)
    The Protection object that is described.
    
    Id — (String)
    The unique identifier (ID) of the protection.
    
    Name — (String)
    The friendly name of the protection. For example, My CloudFront distributions.
    
    ResourceArn — (String)
    The ARN (Amazon Resource Name) of the AWS resource that is protected.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeSubscription(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

DescribeSubscription

Examples:

Calling the describeSubscription operation

var params = {
};
shield.describeSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Subscription — (map)
    The AWS Shield Advanced subscription details for an account.
    
    StartTime — (Date)
    The start time of the subscription, in Unix time in seconds. For more information see timestamp.
    
    EndTime — (Date)
    The date and time your subscription will end.
    
    TimeCommitmentInSeconds — (Integer)
    The length, in seconds, of the AWS Shield Advanced subscription for the account.
    
    AutoRenew — (String)
    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.
    
    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    Limits — (Array<map>)
    Specifies how many protections of a given type you can create.
    
    Type — (String)
    The type of protection.
    
    Max — (Integer)
    The maximum number of protections that can be created for the specified Type.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

disassociateDRTLogBucket(params = {}, callback) ⇒ `AWS.Request`

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 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.

Service Reference:

DisassociateDRTLogBucket

Examples:

Calling the disassociateDRTLogBucket operation

var params = {
  LogBucket: 'STRING_VALUE' /* required */
};
shield.disassociateDRTLogBucket(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- LogBucket — (String)
  The Amazon S3 bucket that contains your flow logs.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

disassociateDRTRole(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

DisassociateDRTRole

Examples:

Calling the disassociateDRTRole operation

var params = {
};
shield.disassociateDRTRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getSubscriptionState(params = {}, callback) ⇒ `AWS.Request`

Returns the SubscriptionState, either Active or Inactive.

Service Reference:

GetSubscriptionState

Examples:

Calling the getSubscriptionState operation

var params = {
};
shield.getSubscriptionState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - SubscriptionState — (String)
    The status of the subscription.
    Possible values include:
    
    "ACTIVE"
    
    "INACTIVE"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listAttacks(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

ListAttacks

Examples:

Calling the listAttacks operation

var params = {
  EndTime: {
    FromInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ToExclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceArns: [
    'STRING_VALUE',
    /* more items */
  ],
  StartTime: {
    FromInclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ToExclusive: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
shield.listAttacks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArns — (Array<String>)
  The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.
- StartTime — (map)
  The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
  - FromInclusive — (Date)
    The start time, in Unix time in seconds. For more information see timestamp.
  - ToExclusive — (Date)
    The end time, in Unix time in seconds. For more information see timestamp.
- EndTime — (map)
  The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
  - FromInclusive — (Date)
    The start time, in Unix time in seconds. For more information see timestamp.
  - ToExclusive — (Date)
    The end time, in Unix time in seconds. For more information see timestamp.
- NextToken — (String)
  The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
- MaxResults — (Integer)
  The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.
  
  This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - AttackSummaries — (Array<map>)
    The attack information for the specified time range.
    
    AttackId — (String)
    The unique identifier (ID) of the attack.
    
    ResourceArn — (String)
    The ARN (Amazon Resource Name) of the resource that was attacked.
    
    StartTime — (Date)
    The start time of the attack, in Unix time in seconds. For more information see timestamp.
    
    EndTime — (Date)
    The end time of the attack, in Unix time in seconds. For more information see timestamp.
    
    AttackVectors — (Array<map>)
    The list of attacks for a specified time period.
    
    VectorType — required — (String)
    The attack type. Valid values:
    
    UDP_TRAFFIC
    
    UDP_FRAGMENT
    
    GENERIC_UDP_REFLECTION
    
    DNS_REFLECTION
    
    NTP_REFLECTION
    
    CHARGEN_REFLECTION
    
    SSDP_REFLECTION
    
    PORT_MAPPER
    
    RIP_REFLECTION
    
    SNMP_REFLECTION
    
    MSSQL_REFLECTION
    
    NET_BIOS_REFLECTION
    
    SYN_FLOOD
    
    ACK_FLOOD
    
    REQUEST_FLOOD
  - NextToken — (String)
    The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.
    
    AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listProtections(params = {}, callback) ⇒ `AWS.Request`

Lists all Protection objects for the account.

Service Reference:

ListProtections

Examples:

Calling the listProtections operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
shield.listProtections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- NextToken — (String)
  The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
- MaxResults — (Integer)
  The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.
  
  This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Protections — (Array<map>)
    The array of enabled Protection objects.
    
    Id — (String)
    The unique identifier (ID) of the protection.
    
    Name — (String)
    The friendly name of the protection. For example, My CloudFront distributions.
    
    ResourceArn — (String)
    The ARN (Amazon Resource Name) of the AWS resource that is protected.
  - NextToken — (String)
    If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
    
    AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateEmergencyContactSettings(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UpdateEmergencyContactSettings

Examples:

Calling the updateEmergencyContactSettings operation

var params = {
  EmergencyContactList: [
    {
      EmailAddress: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
shield.updateEmergencyContactSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- EmergencyContactList — (Array<map>)
  A list of email addresses that the DRT can use to contact you during a suspected attack.
  - EmailAddress — required — (String)
    An email address that the DRT can use to contact you during a suspected attack.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateSubscription(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UpdateSubscription

Examples:

Calling the updateSubscription operation

var params = {
  AutoRenew: ENABLED | DISABLED
};
shield.updateSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AutoRenew — (String)
  When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
  Possible values include:
  - "ENABLED"
  - "DISABLED"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.Shield

Overview

Service Description

Sending a Request Using Shield

Locking the API Version

Constructor Summary

Property Summary

Properties inherited from AWS.Service

Method Summary

Methods inherited from AWS.Service

Constructor Details

new AWS.Shield(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

associateDRTLogBucket(params = {}, callback) ⇒ AWS.Request

associateDRTRole(params = {}, callback) ⇒ AWS.Request

createProtection(params = {}, callback) ⇒ AWS.Request

createSubscription(params = {}, callback) ⇒ AWS.Request

deleteProtection(params = {}, callback) ⇒ AWS.Request

deleteSubscription(params = {}, callback) ⇒ AWS.Request

describeAttack(params = {}, callback) ⇒ AWS.Request

describeDRTAccess(params = {}, callback) ⇒ AWS.Request

describeEmergencyContactSettings(params = {}, callback) ⇒ AWS.Request

describeProtection(params = {}, callback) ⇒ AWS.Request

describeSubscription(params = {}, callback) ⇒ AWS.Request

disassociateDRTLogBucket(params = {}, callback) ⇒ AWS.Request

disassociateDRTRole(params = {}, callback) ⇒ AWS.Request

getSubscriptionState(params = {}, callback) ⇒ AWS.Request

listAttacks(params = {}, callback) ⇒ AWS.Request

listProtections(params = {}, callback) ⇒ AWS.Request

updateEmergencyContactSettings(params = {}, callback) ⇒ AWS.Request

updateSubscription(params = {}, callback) ⇒ AWS.Request

new AWS.Shield(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

associateDRTLogBucket(params = {}, callback) ⇒ `AWS.Request`

associateDRTRole(params = {}, callback) ⇒ `AWS.Request`

createProtection(params = {}, callback) ⇒ `AWS.Request`

createSubscription(params = {}, callback) ⇒ `AWS.Request`

deleteProtection(params = {}, callback) ⇒ `AWS.Request`

deleteSubscription(params = {}, callback) ⇒ `AWS.Request`

describeAttack(params = {}, callback) ⇒ `AWS.Request`

describeDRTAccess(params = {}, callback) ⇒ `AWS.Request`

describeEmergencyContactSettings(params = {}, callback) ⇒ `AWS.Request`

describeProtection(params = {}, callback) ⇒ `AWS.Request`

describeSubscription(params = {}, callback) ⇒ `AWS.Request`

disassociateDRTLogBucket(params = {}, callback) ⇒ `AWS.Request`

disassociateDRTRole(params = {}, callback) ⇒ `AWS.Request`

getSubscriptionState(params = {}, callback) ⇒ `AWS.Request`

listAttacks(params = {}, callback) ⇒ `AWS.Request`

listProtections(params = {}, callback) ⇒ `AWS.Request`

updateEmergencyContactSettings(params = {}, callback) ⇒ `AWS.Request`

updateSubscription(params = {}, callback) ⇒ `AWS.Request`