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

Class: Aws::GlobalAccelerator::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Global Accelerator. To construct a client, you need to configure a :region and :credentials.

globalaccelerator = Aws::GlobalAccelerator::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::GlobalAccelerator::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::GlobalAccelerator::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :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. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_accelerator(options = {}) ⇒ 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 #=> true/false
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.dns_name #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Options Hash (options):

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

#create_endpoint_group(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

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

#create_listener(options = {}) ⇒ 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"

Options Hash (options):

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

#delete_accelerator(options = {}) ⇒ 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
})

Options Hash (options):

  • :accelerator_arn (required, String)

    The Amazon Resource Name (ARN) of an accelerator.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_endpoint_group(options = {}) ⇒ Struct

Delete an endpoint group from a listener.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :endpoint_group_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_listener(options = {}) ⇒ Struct

Delete a listener from an accelerator.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :listener_arn (required, String)

    The Amazon Resource Name (ARN) of the listener.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_accelerator(options = {}) ⇒ 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 #=> true/false
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.dns_name #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Options Hash (options):

  • :accelerator_arn (required, String)

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

Returns:

See Also:

#describe_accelerator_attributes(options = {}) ⇒ 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 #=> true/false
resp.accelerator_attributes.flow_logs_s3_bucket #=> String
resp.accelerator_attributes.flow_logs_s3_prefix #=> String

Options Hash (options):

  • :accelerator_arn (required, String)

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

Returns:

See Also:

#describe_endpoint_group(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

  • :endpoint_group_arn (required, String)

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

Returns:

See Also:

#describe_listener(options = {}) ⇒ 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"

Options Hash (options):

  • :listener_arn (required, String)

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

Returns:

See Also:

#list_accelerators(options = {}) ⇒ 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 #=> true/false
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].dns_name #=> 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

Options Hash (options):

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

#list_endpoint_groups(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

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

#list_listeners(options = {}) ⇒ 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

Options Hash (options):

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

#update_accelerator(options = {}) ⇒ 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 #=> true/false
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.dns_name #=> String
resp.accelerator.status #=> String, one of "DEPLOYED", "IN_PROGRESS"
resp.accelerator.created_time #=> Time
resp.accelerator.last_modified_time #=> Time

Options Hash (options):

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

#update_accelerator_attributes(options = {}) ⇒ 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 #=> true/false
resp.accelerator_attributes.flow_logs_s3_bucket #=> String
resp.accelerator_attributes.flow_logs_s3_prefix #=> String

Options Hash (options):

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

#update_endpoint_group(options = {}) ⇒ 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 #=> true/false
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

Options Hash (options):

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

#update_listener(options = {}) ⇒ 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"

Options Hash (options):

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

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.