Class: AWS.Shield

Inherits:
AWS.Service 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.

Sending a Request Using Shield

var shield = new AWS.Shield();
shield.createProtection(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 collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Property Details

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

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, or an Amazon Route 53 hosted zone.

Service Reference:

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.

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.

Service Reference:

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:

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.

Service Reference:

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:

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.

            • VectorTyperequired — (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 the format 2016-12-16T13:50Z.

        • EndTime — (Date)

          The time the attack ended, in the format 2016-12-16T13:50Z.

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

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

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

Lists the details of a Protection object.

Service Reference:

Examples:

Calling the describeProtection operation

var params = {
  ProtectionId: 'STRING_VALUE' /* required */
};
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.

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:

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 the format "2016-12-16T13:50Z".

        • TimeCommitmentInSeconds — (Integer)

          The length, in seconds, of the AWS Shield Advanced subscription for the account.

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:

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: 0,
  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 time period for the attacks.

      • FromInclusive — (Date)

        The start time, in the format 2016-12-16T13:50Z.

      • ToExclusive — (Date)

        The end time, in the format 2016-12-16T15:50Z.

    • EndTime — (map)

      The end of the time period for the attacks.

      • FromInclusive — (Date)

        The start time, in the format 2016-12-16T13:50Z.

      • ToExclusive — (Date)

        The end time, in the format 2016-12-16T15:50Z.

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

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 the format 2016-12-16T13:50Z.

        • EndTime — (Date)

          The end time of the attack, in the format 2016-12-16T13:50Z.

        • AttackVectors — (Array<map>)

          The list of attacks for a specified time period.

          • VectorTyperequired — (String)

            The attack type, for example, SNMP reflection or SYN 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.

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:

Examples:

Calling the listProtections operation

var params = {
  MaxResults: 0,
  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.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.