Class: AWS.GlobalAccelerator

Inherits:
AWS.Service show all
Identifier:
globalaccelerator
API Version:
2018-08-08
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 Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.

AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.

Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.

Global Accelerator includes components that work together to help you improve performance and availability for your applications:

Static IP address

AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.

Accelerator

An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.

Network zone

A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.

Endpoint

An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.

Sending a Request Using GlobalAccelerator

var globalaccelerator = new AWS.GlobalAccelerator();
globalaccelerator.createAccelerator(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 GlobalAccelerator object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var globalaccelerator = new AWS.GlobalAccelerator({apiVersion: '2018-08-08'});

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

AWS.config.apiVersions = {
  globalaccelerator: '2018-08-08',
  // other service API versions
};

var globalaccelerator = new AWS.GlobalAccelerator();

Version:

  • 2018-08-08

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.GlobalAccelerator(options = {}) ⇒ Object

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

Examples:

Constructing a GlobalAccelerator object

var globalaccelerator = new AWS.GlobalAccelerator({apiVersion: '2018-08-08'});

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.GlobalAccelerator.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.GlobalAccelerator.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.GlobalAccelerator.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.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

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

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

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

Service Reference:

Examples:

Calling the createAccelerator operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Enabled: true || false,
  IpAddressType: IPV4
};
globalaccelerator.createAccelerator(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)

      The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    • IpAddressType — (String)

      The value for the address type must be IPv4.

      Possible values include:
      • "IPV4"
    • Enabled — (Boolean)

      Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

      If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

    • IdempotencyToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

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:

      • Accelerator — (map)

        The accelerator that is created by specifying a listener and the supported IP address types.

        • AcceleratorArn — (String)

          The Amazon Resource Name (ARN) of the accelerator.

        • Name — (String)

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType — (String)

          The value for the address type must be IPv4.

          Possible values include:
          • "IPV4"
        • Enabled — (Boolean)

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets — (Array<map>)

          The static IP addresses that Global Accelerator associates with the accelerator.

          • IpFamily — (String)

            The types of IP addresses included in this IP set.

          • IpAddresses — (Array<String>)

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

        • DnsName — (String)

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

        • Status — (String)

          Describes the deployment status of the accelerator.

          Possible values include:
          • "DEPLOYED"
          • "IN_PROGRESS"
        • CreatedTime — (Date)

          The date and time that the accelerator was created.

        • LastModifiedTime — (Date)

          The date and time that the accelerator was last modified.

Returns:

  • (AWS.Request)

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

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

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

Service Reference:

Examples:

Calling the createEndpointGroup operation

var params = {
  EndpointGroupRegion: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE', /* required */
  ListenerArn: 'STRING_VALUE', /* required */
  EndpointConfigurations: [
    {
      ClientIPPreservationEnabled: true || false,
      EndpointId: 'STRING_VALUE',
      Weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  HealthCheckIntervalSeconds: 'NUMBER_VALUE',
  HealthCheckPath: 'STRING_VALUE',
  HealthCheckPort: 'NUMBER_VALUE',
  HealthCheckProtocol: TCP | HTTP | HTTPS,
  ThresholdCount: 'NUMBER_VALUE',
  TrafficDialPercentage: 'NUMBER_VALUE'
};
globalaccelerator.createEndpointGroup(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: {})
    • ListenerArn — (String)

      The Amazon Resource Name (ARN) of the listener.

    • EndpointGroupRegion — (String)

      The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

    • EndpointConfigurations — (Array<map>)

      The list of endpoint objects.

      • EndpointId — (String)

        An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.

      • Weight — (Integer)

        The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

      • ClientIPPreservationEnabled — (Boolean)

        Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

        If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

        For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

    • TrafficDialPercentage — (Float)

      The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

      Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

      The default value is 100.

    • HealthCheckPort — (Integer)

      The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

    • HealthCheckProtocol — (String)

      The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

      Possible values include:
      • "TCP"
      • "HTTP"
      • "HTTPS"
    • HealthCheckPath — (String)

      If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

    • HealthCheckIntervalSeconds — (Integer)

      The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

    • ThresholdCount — (Integer)

      The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

    • IdempotencyToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

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:

      • EndpointGroup — (map)

        The information about the endpoint group that was created.

        • EndpointGroupArn — (String)

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion — (String)

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions — (Array<map>)

          The list of endpoint objects.

          • EndpointId — (String)

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

          • Weight — (Integer)

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

          • HealthState — (String)

            The health status of the endpoint.

            Possible values include:
            • "INITIAL"
            • "HEALTHY"
            • "UNHEALTHY"
          • HealthReason — (String)

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy, the reason code can be one of the following values:

            • Timeout: The health check requests to the endpoint are timing out before returning a status.

            • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial, the reason code can be one of the following values:

            • ProvisioningInProgress: The endpoint is in the process of being provisioned.

            • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

          • ClientIPPreservationEnabled — (Boolean)

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

        • TrafficDialPercentage — (Float)

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort — (Integer)

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol — (String)

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

          Possible values include:
          • "TCP"
          • "HTTP"
          • "HTTPS"
        • HealthCheckPath — (String)

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds — (Integer)

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount — (Integer)

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Returns:

  • (AWS.Request)

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

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

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example.

Service Reference:

Examples:

Calling the createListener operation

var params = {
  AcceleratorArn: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE', /* required */
  PortRanges: [ /* required */
    {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  Protocol: TCP | UDP, /* required */
  ClientAffinity: NONE | SOURCE_IP
};
globalaccelerator.createListener(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of your accelerator.

    • PortRanges — (Array<map>)

      The list of port ranges to support for connections from clients to your accelerator.

      • FromPort — (Integer)

        The first port in the range of ports, inclusive.

      • ToPort — (Integer)

        The last port in the range of ports, inclusive.

    • Protocol — (String)

      The protocol for connections from clients to your accelerator.

      Possible values include:
      • "TCP"
      • "UDP"
    • ClientAffinity — (String)

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

      AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.

      Possible values include:
      • "NONE"
      • "SOURCE_IP"
    • IdempotencyToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

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:

      • Listener — (map)

        The listener that you've created.

        • ListenerArn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges — (Array<map>)

          The list of port ranges for the connections from clients to the accelerator.

          • FromPort — (Integer)

            The first port in the range of ports, inclusive.

          • ToPort — (Integer)

            The last port in the range of ports, inclusive.

        • Protocol — (String)

          The protocol for the connections from clients to the accelerator.

          Possible values include:
          • "TCP"
          • "UDP"
        • ClientAffinity — (String)

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE.

          Possible values include:
          • "NONE"
          • "SOURCE_IP"

Returns:

  • (AWS.Request)

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

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

Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).

Service Reference:

Examples:

Calling the deleteAccelerator operation

var params = {
  AcceleratorArn: 'STRING_VALUE' /* required */
};
globalaccelerator.deleteAccelerator(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of an accelerator.

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.

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

Delete an endpoint group from a listener.

Service Reference:

Examples:

Calling the deleteEndpointGroup operation

var params = {
  EndpointGroupArn: 'STRING_VALUE' /* required */
};
globalaccelerator.deleteEndpointGroup(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: {})
    • EndpointGroupArn — (String)

      The Amazon Resource Name (ARN) of the endpoint group to delete.

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.

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

Delete a listener from an accelerator.

Service Reference:

Examples:

Calling the deleteListener operation

var params = {
  ListenerArn: 'STRING_VALUE' /* required */
};
globalaccelerator.deleteListener(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: {})
    • ListenerArn — (String)

      The Amazon Resource Name (ARN) of the listener.

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.

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

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

Service Reference:

Examples:

Calling the describeAccelerator operation

var params = {
  AcceleratorArn: 'STRING_VALUE' /* required */
};
globalaccelerator.describeAccelerator(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of the accelerator to describe.

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:

      • Accelerator — (map)

        The description of the accelerator.

        • AcceleratorArn — (String)

          The Amazon Resource Name (ARN) of the accelerator.

        • Name — (String)

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType — (String)

          The value for the address type must be IPv4.

          Possible values include:
          • "IPV4"
        • Enabled — (Boolean)

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets — (Array<map>)

          The static IP addresses that Global Accelerator associates with the accelerator.

          • IpFamily — (String)

            The types of IP addresses included in this IP set.

          • IpAddresses — (Array<String>)

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

        • DnsName — (String)

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

        • Status — (String)

          Describes the deployment status of the accelerator.

          Possible values include:
          • "DEPLOYED"
          • "IN_PROGRESS"
        • CreatedTime — (Date)

          The date and time that the accelerator was created.

        • LastModifiedTime — (Date)

          The date and time that the accelerator was last modified.

Returns:

  • (AWS.Request)

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

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

Describe the attributes of an accelerator.

Service Reference:

Examples:

Calling the describeAcceleratorAttributes operation

var params = {
  AcceleratorArn: 'STRING_VALUE' /* required */
};
globalaccelerator.describeAcceleratorAttributes(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

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:

      • AcceleratorAttributes — (map)

        The attributes of the accelerator.

        • FlowLogsEnabled — (Boolean)

          Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

          For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

        • FlowLogsS3Bucket — (String)

          The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

        • FlowLogsS3Prefix — (String)

          The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.

Returns:

  • (AWS.Request)

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

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

Describe an endpoint group.

Service Reference:

Examples:

Calling the describeEndpointGroup operation

var params = {
  EndpointGroupArn: 'STRING_VALUE' /* required */
};
globalaccelerator.describeEndpointGroup(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: {})
    • EndpointGroupArn — (String)

      The Amazon Resource Name (ARN) of the endpoint group to describe.

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:

      • EndpointGroup — (map)

        The description of an endpoint group.

        • EndpointGroupArn — (String)

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion — (String)

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions — (Array<map>)

          The list of endpoint objects.

          • EndpointId — (String)

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

          • Weight — (Integer)

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

          • HealthState — (String)

            The health status of the endpoint.

            Possible values include:
            • "INITIAL"
            • "HEALTHY"
            • "UNHEALTHY"
          • HealthReason — (String)

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy, the reason code can be one of the following values:

            • Timeout: The health check requests to the endpoint are timing out before returning a status.

            • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial, the reason code can be one of the following values:

            • ProvisioningInProgress: The endpoint is in the process of being provisioned.

            • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

          • ClientIPPreservationEnabled — (Boolean)

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

        • TrafficDialPercentage — (Float)

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort — (Integer)

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol — (String)

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

          Possible values include:
          • "TCP"
          • "HTTP"
          • "HTTPS"
        • HealthCheckPath — (String)

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds — (Integer)

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount — (Integer)

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Returns:

  • (AWS.Request)

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

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

Describe a listener.

Service Reference:

Examples:

Calling the describeListener operation

var params = {
  ListenerArn: 'STRING_VALUE' /* required */
};
globalaccelerator.describeListener(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: {})
    • ListenerArn — (String)

      The Amazon Resource Name (ARN) of the listener to describe.

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:

      • Listener — (map)

        The description of a listener.

        • ListenerArn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges — (Array<map>)

          The list of port ranges for the connections from clients to the accelerator.

          • FromPort — (Integer)

            The first port in the range of ports, inclusive.

          • ToPort — (Integer)

            The last port in the range of ports, inclusive.

        • Protocol — (String)

          The protocol for the connections from clients to the accelerator.

          Possible values include:
          • "TCP"
          • "UDP"
        • ClientAffinity — (String)

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE.

          Possible values include:
          • "NONE"
          • "SOURCE_IP"

Returns:

  • (AWS.Request)

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

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

List the accelerators for an AWS account.

Service Reference:

Examples:

Calling the listAccelerators operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
globalaccelerator.listAccelerators(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: {})
    • MaxResults — (Integer)

      The number of Global Accelerator objects that you want to return with this call. The default value is 10.

    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

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:

      • Accelerators — (Array<map>)

        The list of accelerators for a customer account.

        • AcceleratorArn — (String)

          The Amazon Resource Name (ARN) of the accelerator.

        • Name — (String)

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType — (String)

          The value for the address type must be IPv4.

          Possible values include:
          • "IPV4"
        • Enabled — (Boolean)

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets — (Array<map>)

          The static IP addresses that Global Accelerator associates with the accelerator.

          • IpFamily — (String)

            The types of IP addresses included in this IP set.

          • IpAddresses — (Array<String>)

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

        • DnsName — (String)

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

        • Status — (String)

          Describes the deployment status of the accelerator.

          Possible values include:
          • "DEPLOYED"
          • "IN_PROGRESS"
        • CreatedTime — (Date)

          The date and time that the accelerator was created.

        • LastModifiedTime — (Date)

          The date and time that the accelerator was last modified.

      • NextToken — (String)

        The token for the next set of results. You receive this token from a previous call.

Returns:

  • (AWS.Request)

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

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

List the endpoint groups that are associated with a listener.

Service Reference:

Examples:

Calling the listEndpointGroups operation

var params = {
  ListenerArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
globalaccelerator.listEndpointGroups(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: {})
    • ListenerArn — (String)

      The Amazon Resource Name (ARN) of the listener.

    • MaxResults — (Integer)

      The number of endpoint group objects that you want to return with this call. The default value is 10.

    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

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:

      • EndpointGroups — (Array<map>)

        The list of the endpoint groups associated with a listener.

        • EndpointGroupArn — (String)

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion — (String)

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions — (Array<map>)

          The list of endpoint objects.

          • EndpointId — (String)

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

          • Weight — (Integer)

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

          • HealthState — (String)

            The health status of the endpoint.

            Possible values include:
            • "INITIAL"
            • "HEALTHY"
            • "UNHEALTHY"
          • HealthReason — (String)

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy, the reason code can be one of the following values:

            • Timeout: The health check requests to the endpoint are timing out before returning a status.

            • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial, the reason code can be one of the following values:

            • ProvisioningInProgress: The endpoint is in the process of being provisioned.

            • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

          • ClientIPPreservationEnabled — (Boolean)

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

        • TrafficDialPercentage — (Float)

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort — (Integer)

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol — (String)

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

          Possible values include:
          • "TCP"
          • "HTTP"
          • "HTTPS"
        • HealthCheckPath — (String)

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds — (Integer)

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount — (Integer)

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

      • NextToken — (String)

        The token for the next set of results. You receive this token from a previous call.

Returns:

  • (AWS.Request)

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

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

List the listeners for an accelerator.

Service Reference:

Examples:

Calling the listListeners operation

var params = {
  AcceleratorArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
globalaccelerator.listListeners(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

    • MaxResults — (Integer)

      The number of listener objects that you want to return with this call. The default value is 10.

    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

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:

      • Listeners — (Array<map>)

        The list of listeners for an accelerator.

        • ListenerArn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges — (Array<map>)

          The list of port ranges for the connections from clients to the accelerator.

          • FromPort — (Integer)

            The first port in the range of ports, inclusive.

          • ToPort — (Integer)

            The last port in the range of ports, inclusive.

        • Protocol — (String)

          The protocol for the connections from clients to the accelerator.

          Possible values include:
          • "TCP"
          • "UDP"
        • ClientAffinity — (String)

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE.

          Possible values include:
          • "NONE"
          • "SOURCE_IP"
      • NextToken — (String)

        The token for the next set of results. You receive this token from a previous call.

Returns:

  • (AWS.Request)

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

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

Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

Service Reference:

Examples:

Calling the updateAccelerator operation

var params = {
  AcceleratorArn: 'STRING_VALUE', /* required */
  Enabled: true || false,
  IpAddressType: IPV4,
  Name: 'STRING_VALUE'
};
globalaccelerator.updateAccelerator(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of the accelerator to update.

    • Name — (String)

      The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

    • IpAddressType — (String)

      The value for the address type must be IPv4.

      Possible values include:
      • "IPV4"
    • Enabled — (Boolean)

      Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

      If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can 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. The data object has the following properties:

      • Accelerator — (map)

        Information about the updated accelerator.

        • AcceleratorArn — (String)

          The Amazon Resource Name (ARN) of the accelerator.

        • Name — (String)

          The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

        • IpAddressType — (String)

          The value for the address type must be IPv4.

          Possible values include:
          • "IPV4"
        • Enabled — (Boolean)

          Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

          If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

        • IpSets — (Array<map>)

          The static IP addresses that Global Accelerator associates with the accelerator.

          • IpFamily — (String)

            The types of IP addresses included in this IP set.

          • IpAddresses — (Array<String>)

            The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

        • DnsName — (String)

          The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

          The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

          For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

        • Status — (String)

          Describes the deployment status of the accelerator.

          Possible values include:
          • "DEPLOYED"
          • "IN_PROGRESS"
        • CreatedTime — (Date)

          The date and time that the accelerator was created.

        • LastModifiedTime — (Date)

          The date and time that the accelerator was last modified.

Returns:

  • (AWS.Request)

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

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

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.

Service Reference:

Examples:

Calling the updateAcceleratorAttributes operation

var params = {
  AcceleratorArn: 'STRING_VALUE', /* required */
  FlowLogsEnabled: true || false,
  FlowLogsS3Bucket: 'STRING_VALUE',
  FlowLogsS3Prefix: 'STRING_VALUE'
};
globalaccelerator.updateAcceleratorAttributes(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: {})
    • AcceleratorArn — (String)

      The Amazon Resource Name (ARN) of the accelerator that you want to update.

    • FlowLogsEnabled — (Boolean)

      Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

      For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

    • FlowLogsS3Bucket — (String)

      The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

    • FlowLogsS3Prefix — (String)

      Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.

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:

      • AcceleratorAttributes — (map)

        Updated attributes for the accelerator.

        • FlowLogsEnabled — (Boolean)

          Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

          For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

        • FlowLogsS3Bucket — (String)

          The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

        • FlowLogsS3Prefix — (String)

          The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.

Returns:

  • (AWS.Request)

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

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

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.

Service Reference:

Examples:

Calling the updateEndpointGroup operation

var params = {
  EndpointGroupArn: 'STRING_VALUE', /* required */
  EndpointConfigurations: [
    {
      ClientIPPreservationEnabled: true || false,
      EndpointId: 'STRING_VALUE',
      Weight: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  HealthCheckIntervalSeconds: 'NUMBER_VALUE',
  HealthCheckPath: 'STRING_VALUE',
  HealthCheckPort: 'NUMBER_VALUE',
  HealthCheckProtocol: TCP | HTTP | HTTPS,
  ThresholdCount: 'NUMBER_VALUE',
  TrafficDialPercentage: 'NUMBER_VALUE'
};
globalaccelerator.updateEndpointGroup(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: {})
    • EndpointGroupArn — (String)

      The Amazon Resource Name (ARN) of the endpoint group.

    • EndpointConfigurations — (Array<map>)

      The list of endpoint objects.

      • EndpointId — (String)

        An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.

      • Weight — (Integer)

        The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

      • ClientIPPreservationEnabled — (Boolean)

        Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

        If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

        For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

    • TrafficDialPercentage — (Float)

      The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

      Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

      The default value is 100.

    • HealthCheckPort — (Integer)

      The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.

    • HealthCheckProtocol — (String)

      The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

      Possible values include:
      • "TCP"
      • "HTTP"
      • "HTTPS"
    • HealthCheckPath — (String)

      If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

    • HealthCheckIntervalSeconds — (Integer)

      The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

    • ThresholdCount — (Integer)

      The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

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:

      • EndpointGroup — (map)

        The information about the endpoint group that was updated.

        • EndpointGroupArn — (String)

          The Amazon Resource Name (ARN) of the endpoint group.

        • EndpointGroupRegion — (String)

          The AWS Region that this endpoint group belongs.

        • EndpointDescriptions — (Array<map>)

          The list of endpoint objects.

          • EndpointId — (String)

            An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

          • Weight — (Integer)

            The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

          • HealthState — (String)

            The health status of the endpoint.

            Possible values include:
            • "INITIAL"
            • "HEALTHY"
            • "UNHEALTHY"
          • HealthReason — (String)

            The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

            If the endpoint state is unhealthy, the reason code can be one of the following values:

            • Timeout: The health check requests to the endpoint are timing out before returning a status.

            • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

            If the endpoint state is initial, the reason code can be one of the following values:

            • ProvisioningInProgress: The endpoint is in the process of being provisioned.

            • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

          • ClientIPPreservationEnabled — (Boolean)

            Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

            If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

            For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

        • TrafficDialPercentage — (Float)

          The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

          Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

          The default value is 100.

        • HealthCheckPort — (Integer)

          The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

          The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

        • HealthCheckProtocol — (String)

          The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

          Possible values include:
          • "TCP"
          • "HTTP"
          • "HTTPS"
        • HealthCheckPath — (String)

          If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

        • HealthCheckIntervalSeconds — (Integer)

          The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

        • ThresholdCount — (Integer)

          The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

Returns:

  • (AWS.Request)

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

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

Update a listener.

Service Reference:

Examples:

Calling the updateListener operation

var params = {
  ListenerArn: 'STRING_VALUE', /* required */
  ClientAffinity: NONE | SOURCE_IP,
  PortRanges: [
    {
      FromPort: 'NUMBER_VALUE',
      ToPort: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  Protocol: TCP | UDP
};
globalaccelerator.updateListener(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: {})
    • ListenerArn — (String)

      The Amazon Resource Name (ARN) of the listener to update.

    • PortRanges — (Array<map>)

      The updated list of port ranges for the connections from clients to the accelerator.

      • FromPort — (Integer)

        The first port in the range of ports, inclusive.

      • ToPort — (Integer)

        The last port in the range of ports, inclusive.

    • Protocol — (String)

      The updated protocol for the connections from clients to the accelerator.

      Possible values include:
      • "TCP"
      • "UDP"
    • ClientAffinity — (String)

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

      AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.

      Possible values include:
      • "NONE"
      • "SOURCE_IP"

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:

      • Listener — (map)

        Information for the updated listener.

        • ListenerArn — (String)

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges — (Array<map>)

          The list of port ranges for the connections from clients to the accelerator.

          • FromPort — (Integer)

            The first port in the range of ports, inclusive.

          • ToPort — (Integer)

            The last port in the range of ports, inclusive.

        • Protocol — (String)

          The protocol for the connections from clients to the accelerator.

          Possible values include:
          • "TCP"
          • "UDP"
        • ClientAffinity — (String)

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

          AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE.

          Possible values include:
          • "NONE"
          • "SOURCE_IP"

Returns:

  • (AWS.Request)

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