You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GlobalAccelerator::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#create_accelerator(params = {}) ⇒ Types::CreateAcceleratorResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_accelerator({
  name: "GenericString", # required
  ip_address_type: "IPV4", # accepts IPV4
  enabled: false,
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4"
resp.accelerator.enabled #=> Boolean
resp.accelerator.ip_sets #=> Array
resp.accelerator.ip_sets[0].ip_family #=> String
resp.accelerator.ip_sets[0].ip_addresses #=> Array
resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, 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.

  • :ip_address_type (String) —

    The value for the address type must be 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.

  • :idempotency_token (required, String) —

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

Returns:

See Also:



326
327
328
329
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 326

def create_accelerator(params = {}, options = {})
  req = build_request(:create_accelerator, params)
  req.send_request(options)
end

#create_endpoint_group(params = {}) ⇒ Types::CreateEndpointGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_endpoint_group({
  listener_arn: "GenericString", # required
  endpoint_group_region: "GenericString", # required
  endpoint_configurations: [
    {
      endpoint_id: "GenericString",
      weight: 1,
      client_ip_preservation_enabled: false,
    },
  ],
  traffic_dial_percentage: 1.0,
  health_check_port: 1,
  health_check_protocol: "TCP", # accepts TCP, HTTP, HTTPS
  health_check_path: "GenericString",
  health_check_interval_seconds: 1,
  threshold_count: 1,
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.endpoint_group.endpoint_group_arn #=> String
resp.endpoint_group.endpoint_group_region #=> String
resp.endpoint_group.endpoint_descriptions #=> Array
resp.endpoint_group.endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_group.endpoint_descriptions[0].weight #=> Integer
resp.endpoint_group.endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.endpoint_group.endpoint_descriptions[0].health_reason #=> String
resp.endpoint_group.endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
resp.endpoint_group.traffic_dial_percentage #=> Float
resp.endpoint_group.health_check_port #=> Integer
resp.endpoint_group.health_check_protocol #=> String, one of "TCP", "HTTP", "HTTPS"
resp.endpoint_group.health_check_path #=> String
resp.endpoint_group.health_check_interval_seconds #=> Integer
resp.endpoint_group.threshold_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :endpoint_group_region (required, 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.

  • :endpoint_configurations (Array<Types::EndpointConfiguration>) —

    The list of endpoint objects.

  • :traffic_dial_percentage (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.

  • :health_check_port (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.

  • :health_check_protocol (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.

  • :health_check_path (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 (/).

  • :health_check_interval_seconds (Integer) —

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

  • :threshold_count (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.

  • :idempotency_token (required, String) —

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

Returns:

See Also:



431
432
433
434
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 431

def create_endpoint_group(params = {}, options = {})
  req = build_request(:create_endpoint_group, params)
  req.send_request(options)
end

#create_listener(params = {}) ⇒ Types::CreateListenerResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_listener({
  accelerator_arn: "GenericString", # required
  port_ranges: [ # required
    {
      from_port: 1,
      to_port: 1,
    },
  ],
  protocol: "TCP", # required, accepts TCP, UDP
  client_affinity: "NONE", # accepts NONE, SOURCE_IP
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.listener.listener_arn #=> String
resp.listener.port_ranges #=> Array
resp.listener.port_ranges[0].from_port #=> Integer
resp.listener.port_ranges[0].to_port #=> Integer
resp.listener.protocol #=> String, one of "TCP", "UDP"
resp.listener.client_affinity #=> String, one of "NONE", "SOURCE_IP"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of your accelerator.

  • :port_ranges (required, Array<Types::PortRange>) —

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

  • :protocol (required, String) —

    The protocol for connections from clients to your accelerator.

  • :client_affinity (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.

  • :idempotency_token (required, String) —

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

Returns:

See Also:



512
513
514
515
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 512

def create_listener(params = {}, options = {})
  req = build_request(:create_listener, params)
  req.send_request(options)
end

#delete_accelerator(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_accelerator({
  accelerator_arn: "GenericString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of an accelerator.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



536
537
538
539
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 536

def delete_accelerator(params = {}, options = {})
  req = build_request(:delete_accelerator, params)
  req.send_request(options)
end

#delete_endpoint_group(params = {}) ⇒ Struct

Delete an endpoint group from a listener.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint_group({
  endpoint_group_arn: "GenericString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_group_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



558
559
560
561
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 558

def delete_endpoint_group(params = {}, options = {})
  req = build_request(:delete_endpoint_group, params)
  req.send_request(options)
end

#delete_listener(params = {}) ⇒ Struct

Delete a listener from an accelerator.

Examples:

Request syntax with placeholder values


resp = client.delete_listener({
  listener_arn: "GenericString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



580
581
582
583
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 580

def delete_listener(params = {}, options = {})
  req = build_request(:delete_listener, params)
  req.send_request(options)
end

#describe_accelerator(params = {}) ⇒ Types::DescribeAcceleratorResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_accelerator({
  accelerator_arn: "GenericString", # required
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4"
resp.accelerator.enabled #=> Boolean
resp.accelerator.ip_sets #=> Array
resp.accelerator.ip_sets[0].ip_family #=> String
resp.accelerator.ip_sets[0].ip_addresses #=> Array
resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

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

Returns:

See Also:



619
620
621
622
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 619

def describe_accelerator(params = {}, options = {})
  req = build_request(:describe_accelerator, params)
  req.send_request(options)
end

#describe_accelerator_attributes(params = {}) ⇒ Types::DescribeAcceleratorAttributesResponse

Describe the attributes of an accelerator.

Examples:

Request syntax with placeholder values


resp = client.describe_accelerator_attributes({
  accelerator_arn: "GenericString", # required
})

Response structure


resp.accelerator_attributes.flow_logs_enabled #=> Boolean
resp.accelerator_attributes.flow_logs_s3_bucket #=> String
resp.accelerator_attributes.flow_logs_s3_prefix #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

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

Returns:

See Also:



650
651
652
653
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 650

def describe_accelerator_attributes(params = {}, options = {})
  req = build_request(:describe_accelerator_attributes, params)
  req.send_request(options)
end

#describe_endpoint_group(params = {}) ⇒ Types::DescribeEndpointGroupResponse

Describe an endpoint group.

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint_group({
  endpoint_group_arn: "GenericString", # required
})

Response structure


resp.endpoint_group.endpoint_group_arn #=> String
resp.endpoint_group.endpoint_group_region #=> String
resp.endpoint_group.endpoint_descriptions #=> Array
resp.endpoint_group.endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_group.endpoint_descriptions[0].weight #=> Integer
resp.endpoint_group.endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.endpoint_group.endpoint_descriptions[0].health_reason #=> String
resp.endpoint_group.endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
resp.endpoint_group.traffic_dial_percentage #=> Float
resp.endpoint_group.health_check_port #=> Integer
resp.endpoint_group.health_check_protocol #=> String, one of "TCP", "HTTP", "HTTPS"
resp.endpoint_group.health_check_path #=> String
resp.endpoint_group.health_check_interval_seconds #=> Integer
resp.endpoint_group.threshold_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_group_arn (required, String) —

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

Returns:

See Also:



691
692
693
694
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 691

def describe_endpoint_group(params = {}, options = {})
  req = build_request(:describe_endpoint_group, params)
  req.send_request(options)
end

#describe_listener(params = {}) ⇒ Types::DescribeListenerResponse

Describe a listener.

Examples:

Request syntax with placeholder values


resp = client.describe_listener({
  listener_arn: "GenericString", # required
})

Response structure


resp.listener.listener_arn #=> String
resp.listener.port_ranges #=> Array
resp.listener.port_ranges[0].from_port #=> Integer
resp.listener.port_ranges[0].to_port #=> Integer
resp.listener.protocol #=> String, one of "TCP", "UDP"
resp.listener.client_affinity #=> String, one of "NONE", "SOURCE_IP"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

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

Returns:

See Also:



724
725
726
727
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 724

def describe_listener(params = {}, options = {})
  req = build_request(:describe_listener, params)
  req.send_request(options)
end

#list_accelerators(params = {}) ⇒ Types::ListAcceleratorsResponse

List the accelerators for an AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_accelerators({
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.accelerators #=> Array
resp.accelerators[0].accelerator_arn #=> String
resp.accelerators[0].name #=> String
resp.accelerators[0].ip_address_type #=> String, one of "IPV4"
resp.accelerators[0].enabled #=> Boolean
resp.accelerators[0].ip_sets #=> Array
resp.accelerators[0].ip_sets[0].ip_family #=> String
resp.accelerators[0].ip_sets[0].ip_addresses #=> Array
resp.accelerators[0].ip_sets[0].ip_addresses[0] #=> String
resp.accelerators[0].status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerators[0].created_time #=> Time
resp.accelerators[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



771
772
773
774
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 771

def list_accelerators(params = {}, options = {})
  req = build_request(:list_accelerators, params)
  req.send_request(options)
end

#list_endpoint_groups(params = {}) ⇒ Types::ListEndpointGroupsResponse

List the endpoint groups that are associated with a listener.

Examples:

Request syntax with placeholder values


resp = client.list_endpoint_groups({
  listener_arn: "GenericString", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.endpoint_groups #=> Array
resp.endpoint_groups[0].endpoint_group_arn #=> String
resp.endpoint_groups[0].endpoint_group_region #=> String
resp.endpoint_groups[0].endpoint_descriptions #=> Array
resp.endpoint_groups[0].endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_groups[0].endpoint_descriptions[0].weight #=> Integer
resp.endpoint_groups[0].endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.endpoint_groups[0].endpoint_descriptions[0].health_reason #=> String
resp.endpoint_groups[0].endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
resp.endpoint_groups[0].traffic_dial_percentage #=> Float
resp.endpoint_groups[0].health_check_port #=> Integer
resp.endpoint_groups[0].health_check_protocol #=> String, one of "TCP", "HTTP", "HTTPS"
resp.endpoint_groups[0].health_check_path #=> String
resp.endpoint_groups[0].health_check_interval_seconds #=> Integer
resp.endpoint_groups[0].threshold_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



825
826
827
828
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 825

def list_endpoint_groups(params = {}, options = {})
  req = build_request(:list_endpoint_groups, params)
  req.send_request(options)
end

#list_listeners(params = {}) ⇒ Types::ListListenersResponse

List the listeners for an accelerator.

Examples:

Request syntax with placeholder values


resp = client.list_listeners({
  accelerator_arn: "GenericString", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.listeners #=> Array
resp.listeners[0].listener_arn #=> String
resp.listeners[0].port_ranges #=> Array
resp.listeners[0].port_ranges[0].from_port #=> Integer
resp.listeners[0].port_ranges[0].to_port #=> Integer
resp.listeners[0].protocol #=> String, one of "TCP", "UDP"
resp.listeners[0].client_affinity #=> String, one of "NONE", "SOURCE_IP"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



872
873
874
875
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 872

def list_listeners(params = {}, options = {})
  req = build_request(:list_listeners, params)
  req.send_request(options)
end

#update_accelerator(params = {}) ⇒ Types::UpdateAcceleratorResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_accelerator({
  accelerator_arn: "GenericString", # required
  name: "GenericString",
  ip_address_type: "IPV4", # accepts IPV4
  enabled: false,
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4"
resp.accelerator.enabled #=> Boolean
resp.accelerator.ip_sets #=> Array
resp.accelerator.ip_sets[0].ip_family #=> String
resp.accelerator.ip_sets[0].ip_addresses #=> Array
resp.accelerator.ip_sets[0].ip_addresses[0] #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, 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.

  • :ip_address_type (String) —

    The value for the address type must be 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.

Returns:

See Also:



932
933
934
935
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 932

def update_accelerator(params = {}, options = {})
  req = build_request(:update_accelerator, params)
  req.send_request(options)
end

#update_accelerator_attributes(params = {}) ⇒ Types::UpdateAcceleratorAttributesResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_accelerator_attributes({
  accelerator_arn: "GenericString", # required
  flow_logs_enabled: false,
  flow_logs_s3_bucket: "GenericString",
  flow_logs_s3_prefix: "GenericString",
})

Response structure


resp.accelerator_attributes.flow_logs_enabled #=> Boolean
resp.accelerator_attributes.flow_logs_s3_bucket #=> String
resp.accelerator_attributes.flow_logs_s3_prefix #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

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

  • :flow_logs_enabled (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.

  • :flow_logs_s3_bucket (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.

  • :flow_logs_s3_prefix (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.

Returns:

See Also:



992
993
994
995
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 992

def update_accelerator_attributes(params = {}, options = {})
  req = build_request(:update_accelerator_attributes, params)
  req.send_request(options)
end

#update_endpoint_group(params = {}) ⇒ Types::UpdateEndpointGroupResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_endpoint_group({
  endpoint_group_arn: "GenericString", # required
  endpoint_configurations: [
    {
      endpoint_id: "GenericString",
      weight: 1,
      client_ip_preservation_enabled: false,
    },
  ],
  traffic_dial_percentage: 1.0,
  health_check_port: 1,
  health_check_protocol: "TCP", # accepts TCP, HTTP, HTTPS
  health_check_path: "GenericString",
  health_check_interval_seconds: 1,
  threshold_count: 1,
})

Response structure


resp.endpoint_group.endpoint_group_arn #=> String
resp.endpoint_group.endpoint_group_region #=> String
resp.endpoint_group.endpoint_descriptions #=> Array
resp.endpoint_group.endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_group.endpoint_descriptions[0].weight #=> Integer
resp.endpoint_group.endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.endpoint_group.endpoint_descriptions[0].health_reason #=> String
resp.endpoint_group.endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
resp.endpoint_group.traffic_dial_percentage #=> Float
resp.endpoint_group.health_check_port #=> Integer
resp.endpoint_group.health_check_protocol #=> String, one of "TCP", "HTTP", "HTTPS"
resp.endpoint_group.health_check_path #=> String
resp.endpoint_group.health_check_interval_seconds #=> Integer
resp.endpoint_group.threshold_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_group_arn (required, String) —

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

  • :endpoint_configurations (Array<Types::EndpointConfiguration>) —

    The list of endpoint objects.

  • :traffic_dial_percentage (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.

  • :health_check_port (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.

  • :health_check_protocol (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.

  • :health_check_path (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 (/).

  • :health_check_interval_seconds (Integer) —

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

  • :threshold_count (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:

See Also:



1086
1087
1088
1089
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1086

def update_endpoint_group(params = {}, options = {})
  req = build_request(:update_endpoint_group, params)
  req.send_request(options)
end

#update_listener(params = {}) ⇒ Types::UpdateListenerResponse

Update a listener.

Examples:

Request syntax with placeholder values


resp = client.update_listener({
  listener_arn: "GenericString", # required
  port_ranges: [
    {
      from_port: 1,
      to_port: 1,
    },
  ],
  protocol: "TCP", # accepts TCP, UDP
  client_affinity: "NONE", # accepts NONE, SOURCE_IP
})

Response structure


resp.listener.listener_arn #=> String
resp.listener.port_ranges #=> Array
resp.listener.port_ranges[0].from_port #=> Integer
resp.listener.port_ranges[0].to_port #=> Integer
resp.listener.protocol #=> String, one of "TCP", "UDP"
resp.listener.client_affinity #=> String, one of "NONE", "SOURCE_IP"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

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

  • :port_ranges (Array<Types::PortRange>) —

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

  • :protocol (String) —

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

  • :client_affinity (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.

Returns:

See Also:



1160
1161
1162
1163
 
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1160

def update_listener(params = {}, options = {})
  req = build_request(:update_listener, params)
  req.send_request(options)
end