Class: Aws::GlobalAccelerator::Client

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

Overview

An API client for GlobalAccelerator. To construct a client, you need to configure a ‘:region` and `:credentials`.

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

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

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

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

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

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

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :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 searched for in the following locations:

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

    @see 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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :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. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::GlobalAccelerator::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::GlobalAccelerator::EndpointParameters`

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



441
442
443
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 441

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3654
3655
3656
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3654

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3657
3658
3659
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3657

def errors_module
  Errors
end

Instance Method Details

#add_custom_routing_endpoints(params = {}) ⇒ Types::AddCustomRoutingEndpointsResponse

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.

Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.

By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the [ AllowCustomRoutingTraffic] operation.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html

Examples:

Request syntax with placeholder values


resp = client.add_custom_routing_endpoints({
  endpoint_configurations: [ # required
    {
      endpoint_id: "GenericString",
      attachment_arn: "GenericString",
    },
  ],
  endpoint_group_arn: "GenericString", # required
})

Response structure


resp.endpoint_descriptions #=> Array
resp.endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_configurations (required, Array<Types::CustomRoutingEndpointConfiguration>) —

    The list of endpoint objects to add to a custom routing accelerator.

  • :endpoint_group_arn (required, String) —

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

Returns:

See Also:



503
504
505
506
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 503

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

#add_endpoints(params = {}) ⇒ Types::AddEndpointsResponse

Add endpoints to an endpoint group. The ‘AddEndpoints` API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the [CreateEndpointGroup] API) or when you update an endpoint group (with the [UpdateEndpointGroup] API).

There are two advantages to using ‘AddEndpoints` to add endpoints in Global Accelerator:

  • It’s faster, because Global Accelerator only has to resolve the new endpoints that you’re adding, rather than resolving new and existing endpoints.

  • It’s more convenient, because you don’t need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.

For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see [ Endpoints for standard accelerators] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html [2]: docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html [3]: docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.add_endpoints({
  endpoint_configurations: [ # required
    {
      endpoint_id: "GenericString",
      weight: 1,
      client_ip_preservation_enabled: false,
      attachment_arn: "GenericString",
    },
  ],
  endpoint_group_arn: "GenericString", # required
})

Response structure


resp.endpoint_descriptions #=> Array
resp.endpoint_descriptions[0].endpoint_id #=> String
resp.endpoint_descriptions[0].weight #=> Integer
resp.endpoint_descriptions[0].health_state #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.endpoint_descriptions[0].health_reason #=> String
resp.endpoint_descriptions[0].client_ip_preservation_enabled #=> Boolean
resp.endpoint_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The list of endpoint objects.

  • :endpoint_group_arn (required, String) —

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

Returns:

See Also:



574
575
576
577
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 574

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

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.

To stop advertising the BYOIP address range, use [ WithdrawByoipCidr].

For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html [2]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

Examples:

Request syntax with placeholder values


resp = client.advertise_byoip_cidr({
  cidr: "GenericString", # required
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
resp.byoip_cidr.events #=> Array
resp.byoip_cidr.events[0].message #=> String
resp.byoip_cidr.events[0].timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



630
631
632
633
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 630

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

#allow_custom_routing_traffic(params = {}) ⇒ Struct

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Examples:

Request syntax with placeholder values


resp = client.allow_custom_routing_traffic({
  endpoint_group_arn: "GenericString", # required
  endpoint_id: "GenericString", # required
  destination_addresses: ["IpAddress"],
  destination_ports: [1],
  allow_all_traffic_to_endpoint: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_group_arn (required, String) —

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

  • :endpoint_id (required, String) —

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

  • :destination_addresses (Array<String>) —

    A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

    ‘DestinationAddresses` is required if `AllowAllTrafficToEndpoint` is `FALSE` or is not specified.

  • :destination_ports (Array<Integer>) —

    A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

  • :allow_all_traffic_to_endpoint (Boolean) —

    Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

    When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

    When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don’t specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

    The default value is FALSE.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



700
701
702
703
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 700

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3627

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::GlobalAccelerator')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-globalaccelerator'
  context[:gem_version] = '1.65.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify ‘–region us-west-2` on Amazon Web Services CLI commands.

Examples:

Request syntax with placeholder values


resp = client.create_accelerator({
  name: "GenericString", # required
  ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
  ip_addresses: ["IpAddress"],
  enabled: false,
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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
resp.accelerator.dual_stack_dns_name #=> String
resp.accelerator.events #=> Array
resp.accelerator.events[0].message #=> String
resp.accelerator.events[0].timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :ip_address_type (String) —

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

  • :ip_addresses (Array<String>) —

    Optionally, if you’ve added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator’s static IPv4 address when you create an accelerator.

    After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

    You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

    Note that you can’t update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

    For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    Create tags for an accelerator.

    For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Returns:

See Also:



822
823
824
825
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 822

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

#create_cross_account_attachment(params = {}) ⇒ Types::CreateCrossAccountAttachmentResponse

Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.

A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.

Specify each principal and resource separately. To specify two CIDR address pools, list them individually under ‘Resources`, and so on. For a command line operation, for example, you might use a statement like the following:

‘ “Resources”: [“169.254.60.0/24”,“169.254.59.0/24”]`

For more information, see [ Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html

Examples:

Request syntax with placeholder values


resp = client.({
  name: "AttachmentName", # required
  principals: ["Principal"],
  resources: [
    {
      endpoint_id: "GenericString",
      cidr: "GenericString",
      region: "GenericString",
    },
  ],
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp..attachment_arn #=> String
resp..name #=> String
resp..principals #=> Array
resp..principals[0] #=> String
resp..resources #=> Array
resp..resources[0].endpoint_id #=> String
resp..resources[0].cidr #=> String
resp..resources[0].region #=> String
resp..last_modified_time #=> Time
resp..created_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the cross-account attachment.

  • :principals (Array<String>) —

    The principals to include in the cross-account attachment. A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator.

  • :resources (Array<Types::Resource>) —

    The Amazon Resource Names (ARNs) for the resources to include in the cross-account attachment. A resource can be any supported Amazon Web Services resource type for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address pool.

  • :idempotency_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    Add tags for a cross-account attachment.

    For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Returns:

See Also:



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

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

#create_custom_routing_accelerator(params = {}) ⇒ Types::CreateCustomRoutingAcceleratorResponse

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.

Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the [ AllowCustomRoutingTraffic] operation.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify ‘–region us-west-2` on Amazon Web Services CLI commands.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html

Examples:

Request syntax with placeholder values


resp = client.create_custom_routing_accelerator({
  name: "GenericString", # required
  ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
  ip_addresses: ["IpAddress"],
  enabled: false,
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :ip_address_type (String) —

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

  • :ip_addresses (Array<String>) —

    Optionally, if you’ve added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator’s static IPv4 address when you create an accelerator.

    After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

    You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

    Note that you can’t update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

    For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

  • :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 the request.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>) —

    Create tags for an accelerator.

    For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Returns:

See Also:



1059
1060
1061
1062
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1059

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

#create_custom_routing_endpoint_group(params = {}) ⇒ Types::CreateCustomRoutingEndpointGroupResponse

Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.

Examples:

Request syntax with placeholder values


resp = client.create_custom_routing_endpoint_group({
  listener_arn: "GenericString", # required
  endpoint_group_region: "GenericString", # required
  destination_configurations: [ # required
    {
      from_port: 1, # required
      to_port: 1, # required
      protocols: ["TCP"], # required, accepts TCP, UDP
    },
  ],
  idempotency_token: "IdempotencyToken", # required
})

Response structure


resp.endpoint_group.endpoint_group_arn #=> String
resp.endpoint_group.endpoint_group_region #=> String
resp.endpoint_group.destination_descriptions #=> Array
resp.endpoint_group.destination_descriptions[0].from_port #=> Integer
resp.endpoint_group.destination_descriptions[0].to_port #=> Integer
resp.endpoint_group.destination_descriptions[0].protocols #=> Array
resp.endpoint_group.destination_descriptions[0].protocols[0] #=> String, one of "TCP", "UDP"
resp.endpoint_group.endpoint_descriptions #=> Array
resp.endpoint_group.endpoint_descriptions[0].endpoint_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.

  • :endpoint_group_region (required, String) —

    The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

  • :destination_configurations (required, Array<Types::CustomRoutingDestinationConfiguration>) —

    Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.

  • :idempotency_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



1123
1124
1125
1126
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1123

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

#create_custom_routing_listener(params = {}) ⇒ Types::CreateCustomRoutingListenerResponse

Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.

Examples:

Request syntax with placeholder values


resp = client.create_custom_routing_listener({
  accelerator_arn: "GenericString", # required
  port_ranges: [ # required
    {
      from_port: 1,
      to_port: 1,
    },
  ],
  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

Parameters:

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

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.

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

    The port range to support for connections from clients to your accelerator.

    Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators].

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html

  • :idempotency_token (required, String) —

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

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



1182
1183
1184
1185
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1182

def create_custom_routing_listener(params = {}, options = {})
  req = build_request(:create_custom_routing_listener, 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 Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.

For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see [ Endpoints for standard accelerators] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html

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,
      attachment_arn: "GenericString",
    },
  ],
  traffic_dial_percentage: 1.0,
  health_check_port: 1,
  health_check_protocol: "TCP", # accepts TCP, HTTP, HTTPS
  health_check_path: "HealthCheckPath",
  health_check_interval_seconds: 1,
  threshold_count: 1,
  idempotency_token: "IdempotencyToken", # required
  port_overrides: [
    {
      listener_port: 1,
      endpoint_port: 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
resp.endpoint_group.port_overrides #=> Array
resp.endpoint_group.port_overrides[0].listener_port #=> Integer
resp.endpoint_group.port_overrides[0].endpoint_port #=> 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 Amazon Web Services 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 Amazon Web Services 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 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 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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :port_overrides (Array<Types::PortOverride>) —

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see [ Overriding listener ports] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html

Returns:

See Also:



1322
1323
1324
1325
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1322

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.

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. Client affinity gives you control over whether to always route each client to the same specific endpoint.

    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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



1404
1405
1406
1407
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1404

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

#delete_accelerator(params = {}) ⇒ Struct

Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set ‘Enabled` to false.

When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.

The IP addresses are assigned to your accelerator for as long as it

exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see [Identity and access management] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html

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:



1449
1450
1451
1452
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1449

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

#delete_cross_account_attachment(params = {}) ⇒ Struct

Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.

For more information, see [ Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_arn (required, String) —

    The Amazon Resource Name (ARN) for the cross-account attachment to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1483
1484
1485
1486
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1483

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

#delete_custom_routing_accelerator(params = {}) ⇒ Struct

Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set ‘Enabled` to false.

When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.

The IP addresses are assigned to your accelerator for as long as it

exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see [Identity and access management] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of the custom routing accelerator to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1527
1528
1529
1530
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1527

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

#delete_custom_routing_endpoint_group(params = {}) ⇒ Struct

Delete an endpoint group from a listener for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_routing_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:



1550
1551
1552
1553
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1550

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

#delete_custom_routing_listener(params = {}) ⇒ Struct

Delete a listener for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_routing_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 to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1572
1573
1574
1575
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1572

def delete_custom_routing_listener(params = {}, options = {})
  req = build_request(:delete_custom_routing_listener, 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:



1594
1595
1596
1597
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1594

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:



1616
1617
1618
1619
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1616

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

#deny_custom_routing_traffic(params = {}) ⇒ Struct

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Examples:

Request syntax with placeholder values


resp = client.deny_custom_routing_traffic({
  endpoint_group_arn: "GenericString", # required
  endpoint_id: "GenericString", # required
  destination_addresses: ["IpAddress"],
  destination_ports: [1],
  deny_all_traffic_to_endpoint: false,
})

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_group_arn (required, String) —

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

  • :endpoint_id (required, String) —

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

  • :destination_addresses (Array<String>) —

    A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.

  • :destination_ports (Array<Integer>) —

    A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.

  • :deny_all_traffic_to_endpoint (Boolean) —

    Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

    When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

    When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don’t specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

    The default value is FALSE.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1682
1683
1684
1685
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1682

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

#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResponse

Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it by using [WithdrawByoipCidr] and you must not have any accelerators that are using static IP addresses allocated from its address range.

For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html [2]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

Examples:

Request syntax with placeholder values


resp = client.deprovision_byoip_cidr({
  cidr: "GenericString", # required
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
resp.byoip_cidr.events #=> Array
resp.byoip_cidr.events[0].message #=> String
resp.byoip_cidr.events[0].timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1736
1737
1738
1739
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1736

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

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

Describe an accelerator.

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", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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
resp.accelerator.dual_stack_dns_name #=> String
resp.accelerator.events #=> Array
resp.accelerator.events[0].message #=> String
resp.accelerator.events[0].timestamp #=> 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:



1780
1781
1782
1783
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1780

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:



1811
1812
1813
1814
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1811

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

#describe_cross_account_attachment(params = {}) ⇒ Types::DescribeCrossAccountAttachmentResponse

Gets configuration information about a cross-account attachment.

Examples:

Request syntax with placeholder values


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

Response structure


resp..attachment_arn #=> String
resp..name #=> String
resp..principals #=> Array
resp..principals[0] #=> String
resp..resources #=> Array
resp..resources[0].endpoint_id #=> String
resp..resources[0].cidr #=> String
resp..resources[0].region #=> String
resp..last_modified_time #=> Time
resp..created_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_arn (required, String) —

    The Amazon Resource Name (ARN) for the cross-account attachment to describe.

Returns:

See Also:



1849
1850
1851
1852
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1849

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

#describe_custom_routing_accelerator(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorResponse

Describe a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_routing_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", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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

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:



1889
1890
1891
1892
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1889

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

#describe_custom_routing_accelerator_attributes(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorAttributesResponse

Describe the attributes of a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_routing_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 custom routing accelerator to describe the attributes for.

Returns:

See Also:



1920
1921
1922
1923
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1920

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

#describe_custom_routing_endpoint_group(params = {}) ⇒ Types::DescribeCustomRoutingEndpointGroupResponse

Describe an endpoint group for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_routing_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.destination_descriptions #=> Array
resp.endpoint_group.destination_descriptions[0].from_port #=> Integer
resp.endpoint_group.destination_descriptions[0].to_port #=> Integer
resp.endpoint_group.destination_descriptions[0].protocols #=> Array
resp.endpoint_group.destination_descriptions[0].protocols[0] #=> String, one of "TCP", "UDP"
resp.endpoint_group.endpoint_descriptions #=> Array
resp.endpoint_group.endpoint_descriptions[0].endpoint_id #=> String

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:



1956
1957
1958
1959
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1956

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

#describe_custom_routing_listener(params = {}) ⇒ Types::DescribeCustomRoutingListenerResponse

The description of a listener for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_routing_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

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:



1987
1988
1989
1990
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 1987

def describe_custom_routing_listener(params = {}, options = {})
  req = build_request(:describe_custom_routing_listener, 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
resp.endpoint_group.port_overrides #=> Array
resp.endpoint_group.port_overrides[0].listener_port #=> Integer
resp.endpoint_group.port_overrides[0].endpoint_port #=> 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:



2031
2032
2033
2034
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2031

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:



2064
2065
2066
2067
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2064

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 Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "DUAL_STACK"
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].ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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.accelerators[0].dual_stack_dns_name #=> String
resp.accelerators[0].events #=> Array
resp.accelerators[0].events[0].message #=> String
resp.accelerators[0].events[0].timestamp #=> 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:



2119
2120
2121
2122
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2119

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

#list_byoip_cidrs(params = {}) ⇒ Types::ListByoipCidrsResponse

Lists the IP address ranges that were specified in calls to [ProvisionByoipCidr], including the current state and a history of state changes.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.byoip_cidrs #=> Array
resp.byoip_cidrs[0].cidr #=> String
resp.byoip_cidrs[0].state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
resp.byoip_cidrs[0].events #=> Array
resp.byoip_cidrs[0].events[0].message #=> String
resp.byoip_cidrs[0].events[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned ‘nextToken` value.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2168
2169
2170
2171
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2168

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

#list_cross_account_attachments(params = {}) ⇒ Types::ListCrossAccountAttachmentsResponse

List the cross-account attachments that have been created in Global Accelerator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp. #=> Array
resp.[0].attachment_arn #=> String
resp.[0].name #=> String
resp.[0].principals #=> Array
resp.[0].principals[0] #=> String
resp.[0].resources #=> Array
resp.[0].resources[0].endpoint_id #=> String
resp.[0].resources[0].cidr #=> String
resp.[0].resources[0].region #=> String
resp.[0].last_modified_time #=> Time
resp.[0].created_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The number of cross-account attachment 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:



2217
2218
2219
2220
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2217

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

#list_cross_account_resource_accounts(params = {}) ⇒ Types::ListCrossAccountResourceAccountsResponse

List the accounts that have cross-account resources.

For more information, see [ Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html

Examples:

Response structure


resp. #=> Array
resp.[0] #=> String

Parameters:

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

    ({})

Returns:

See Also:



2245
2246
2247
2248
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2245

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

#list_cross_account_resources(params = {}) ⇒ Types::ListCrossAccountResourcesResponse

List the cross-account resources available to work with.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp. #=> Array
resp.[0].endpoint_id #=> String
resp.[0].cidr #=> String
resp.[0].attachment_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accelerator_arn (String) —

    The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.

  • :resource_owner_aws_account_id (required, String) —

    The account ID of a resource owner in a cross-account attachment.

  • :max_results (Integer) —

    The number of cross-account resource 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:



2295
2296
2297
2298
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2295

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

#list_custom_routing_accelerators(params = {}) ⇒ Types::ListCustomRoutingAcceleratorsResponse

List the custom routing accelerators for an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_routing_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", "DUAL_STACK"
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].ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The number of custom routing 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:



2347
2348
2349
2350
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2347

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

#list_custom_routing_endpoint_groups(params = {}) ⇒ Types::ListCustomRoutingEndpointGroupsResponse

List the endpoint groups that are associated with a listener for a custom routing accelerator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_routing_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].destination_descriptions #=> Array
resp.endpoint_groups[0].destination_descriptions[0].from_port #=> Integer
resp.endpoint_groups[0].destination_descriptions[0].to_port #=> Integer
resp.endpoint_groups[0].destination_descriptions[0].protocols #=> Array
resp.endpoint_groups[0].destination_descriptions[0].protocols[0] #=> String, one of "TCP", "UDP"
resp.endpoint_groups[0].endpoint_descriptions #=> Array
resp.endpoint_groups[0].endpoint_descriptions[0].endpoint_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :listener_arn (required, String) —

    The Amazon Resource Name (ARN) of the listener to list endpoint groups for.

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



2400
2401
2402
2403
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2400

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

#list_custom_routing_listeners(params = {}) ⇒ Types::ListCustomRoutingListenersResponse

List the listeners for a custom routing accelerator.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_routing_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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of the accelerator to list listeners for.

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



2447
2448
2449
2450
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2447

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

#list_custom_routing_port_mappings(params = {}) ⇒ Types::ListCustomRoutingPortMappingsResponse

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don’t change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.

If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don’t change). If you add or remove EC2 instances in your subnet, the port mappings don’t change, because the mappings are created when you add the subnet to Global Accelerator.

The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.port_mappings #=> Array
resp.port_mappings[0].accelerator_port #=> Integer
resp.port_mappings[0].endpoint_group_arn #=> String
resp.port_mappings[0].endpoint_id #=> String
resp.port_mappings[0].destination_socket_address.ip_address #=> String
resp.port_mappings[0].destination_socket_address.port #=> Integer
resp.port_mappings[0].protocols #=> Array
resp.port_mappings[0].protocols[0] #=> String, one of "TCP", "UDP"
resp.port_mappings[0].destination_traffic_state #=> String, one of "ALLOW", "DENY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :accelerator_arn (required, String) —

    The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.

  • :endpoint_group_arn (String) —

    The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.

  • :max_results (Integer) —

    The number of destination port mappings 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:



2519
2520
2521
2522
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2519

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

#list_custom_routing_port_mappings_by_destination(params = {}) ⇒ Types::ListCustomRoutingPortMappingsByDestinationResponse

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_custom_routing_port_mappings_by_destination({
  endpoint_id: "GenericString", # required
  destination_address: "GenericString", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.destination_port_mappings #=> Array
resp.destination_port_mappings[0].accelerator_arn #=> String
resp.destination_port_mappings[0].accelerator_socket_addresses #=> Array
resp.destination_port_mappings[0].accelerator_socket_addresses[0].ip_address #=> String
resp.destination_port_mappings[0].accelerator_socket_addresses[0].port #=> Integer
resp.destination_port_mappings[0].endpoint_group_arn #=> String
resp.destination_port_mappings[0].endpoint_id #=> String
resp.destination_port_mappings[0].endpoint_group_region #=> String
resp.destination_port_mappings[0].destination_socket_address.ip_address #=> String
resp.destination_port_mappings[0].destination_socket_address.port #=> Integer
resp.destination_port_mappings[0].ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
resp.destination_port_mappings[0].destination_traffic_state #=> String, one of "ALLOW", "DENY"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_id (required, String) —

    The ID for the virtual private cloud (VPC) subnet.

  • :destination_address (required, String) —

    The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.

  • :max_results (Integer) —

    The number of destination port mappings 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:



2582
2583
2584
2585
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2582

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

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

List the endpoint groups that are associated with a listener.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.endpoint_groups[0].port_overrides #=> Array
resp.endpoint_groups[0].port_overrides[0].listener_port #=> Integer
resp.endpoint_groups[0].port_overrides[0].endpoint_port #=> 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:



2641
2642
2643
2644
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2641

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



2690
2691
2692
2693
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2690

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List all tags for an accelerator.

For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.

Returns:

See Also:



2728
2729
2730
2731
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2728

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

#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResponse

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using [ AdvertiseByoipCidr].

For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html [2]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

Examples:

Request syntax with placeholder values


resp = client.provision_byoip_cidr({
  cidr: "GenericString", # required
  cidr_authorization_context: { # required
    message: "GenericString", # required
    signature: "GenericString", # required
  },
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
resp.byoip_cidr.events #=> Array
resp.byoip_cidr.events[0].message #=> String
resp.byoip_cidr.events[0].timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :cidr (required, String) —

    The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you’ve brought to this Amazon Web Services Region or another Region.

    For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

  • :cidr_authorization_context (required, Types::CidrAuthorizationContext) —

    A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

Returns:

See Also:



2789
2790
2791
2792
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2789

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

#remove_custom_routing_endpoints(params = {}) ⇒ Struct

Remove endpoints from a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.remove_custom_routing_endpoints({
  endpoint_ids: ["GenericString"], # required
  endpoint_group_arn: "GenericString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_ids (required, Array<String>) —

    The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.

  • :endpoint_group_arn (required, String) —

    The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2817
2818
2819
2820
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2817

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

#remove_endpoints(params = {}) ⇒ Struct

Remove endpoints from an endpoint group.

The ‘RemoveEndpoints` API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the [UpdateEndpointGroup] API operation. There are two advantages to using `AddEndpoints` to remove endpoints instead:

  • It’s more convenient, because you only need to specify the endpoints that you want to remove. With the ‘UpdateEndpointGroup` API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.

  • It’s faster, because Global Accelerator doesn’t need to resolve any endpoints. With the ‘UpdateEndpointGroup` API operation, Global Accelerator must resolve all of the endpoints that remain in the group.

[1]: docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html

Examples:

Request syntax with placeholder values


resp = client.remove_endpoints({
  endpoint_identifiers: [ # required
    {
      endpoint_id: "GenericString", # required
      client_ip_preservation_enabled: false,
    },
  ],
  endpoint_group_arn: "GenericString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :endpoint_identifiers (required, Array<Types::EndpointIdentifier>) —

    The identifiers of the endpoints that you want to remove.

  • :endpoint_group_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2868
2869
2870
2871
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2868

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

#tag_resource(params = {}) ⇒ Struct

Add tags to an accelerator resource.

For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

  • :tags (required, Array<Types::Tag>) —

    The tags to add to a resource. A tag consists of a key and a value that you define.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2908
2909
2910
2911
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2908

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

#untag_resource(params = {}) ⇒ Struct

Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

For more information, see [Tagging in Global Accelerator] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

  • :tag_keys (required, Array<String>) —

    The tag key pairs that you want to remove from the specified resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2946
2947
2948
2949
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 2946

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

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

Update an accelerator to make changes, such as the following:

  • Change the name of the accelerator.

  • Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.

  • Enable the accelerator, if it is disabled.

  • Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it’s dual-stack.

Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify ‘–region us-west-2` on Amazon Web Services CLI commands.

Examples:

Request syntax with placeholder values


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

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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
resp.accelerator.dual_stack_dns_name #=> String
resp.accelerator.events #=> Array
resp.accelerator.events[0].message #=> String
resp.accelerator.events[0].timestamp #=> 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 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

  • :ip_address_type (String) —

    The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

  • :ip_addresses (Array<String>) —

    The IP addresses for an accelerator.

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



3035
3036
3037
3038
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3035

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.

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 *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html

  • :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 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 specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    s3-bucket_name//AWSLogs/aws_account_id

Returns:

See Also:



3096
3097
3098
3099
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3096

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

#update_cross_account_attachment(params = {}) ⇒ Types::UpdateCrossAccountAttachmentResponse

Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.

For more information, see [ Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html

Examples:

Request syntax with placeholder values


resp = client.({
  attachment_arn: "GenericString", # required
  name: "AttachmentName",
  add_principals: ["Principal"],
  remove_principals: ["Principal"],
  add_resources: [
    {
      endpoint_id: "GenericString",
      cidr: "GenericString",
      region: "GenericString",
    },
  ],
  remove_resources: [
    {
      endpoint_id: "GenericString",
      cidr: "GenericString",
      region: "GenericString",
    },
  ],
})

Response structure


resp..attachment_arn #=> String
resp..name #=> String
resp..principals #=> Array
resp..principals[0] #=> String
resp..resources #=> Array
resp..resources[0].endpoint_id #=> String
resp..resources[0].cidr #=> String
resp..resources[0].region #=> String
resp..last_modified_time #=> Time
resp..created_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_arn (required, String) —

    The Amazon Resource Name (ARN) of the cross-account attachment to update.

  • :name (String) —

    The name of the cross-account attachment.

  • :add_principals (Array<String>) —

    The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

    To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

  • :remove_principals (Array<String>) —

    The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

    To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

  • :add_resources (Array<Types::Resource>) —

    The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

    To add more than one resource, separate the resource ARNs with commas.

  • :remove_resources (Array<Types::Resource>) —

    The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

    To remove more than one resource, separate the resource ARNs with commas.

Returns:

See Also:



3199
3200
3201
3202
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3199

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

#update_custom_routing_accelerator(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorResponse

Update a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.update_custom_routing_accelerator({
  accelerator_arn: "GenericString", # required
  name: "GenericString",
  ip_address_type: "IPV4", # accepts IPV4, DUAL_STACK
  ip_addresses: ["IpAddress"],
  enabled: false,
})

Response structure


resp.accelerator.accelerator_arn #=> String
resp.accelerator.name #=> String
resp.accelerator.ip_address_type #=> String, one of "IPV4", "DUAL_STACK"
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.ip_sets[0].ip_address_family #=> String, one of "IPv4", "IPv6"
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

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 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

  • :ip_address_type (String) —

    The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

  • :ip_addresses (Array<String>) —

    The IP addresses for an accelerator.

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



3262
3263
3264
3265
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3262

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

#update_custom_routing_accelerator_attributes(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorAttributesResponse

Update the attributes for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.update_custom_routing_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 custom routing accelerator to update attributes for.

  • :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 *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html

  • :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 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. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

    DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

Returns:

See Also:



3325
3326
3327
3328
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3325

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

#update_custom_routing_listener(params = {}) ⇒ Types::UpdateCustomRoutingListenerResponse

Update a listener for a custom routing accelerator.

Examples:

Request syntax with placeholder values


resp = client.update_custom_routing_listener({
  listener_arn: "GenericString", # required
  port_ranges: [ # required
    {
      from_port: 1,
      to_port: 1,
    },
  ],
})

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3374
3375
3376
3377
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3374

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

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

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

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,
      attachment_arn: "GenericString",
    },
  ],
  traffic_dial_percentage: 1.0,
  health_check_port: 1,
  health_check_protocol: "TCP", # accepts TCP, HTTP, HTTPS
  health_check_path: "HealthCheckPath",
  health_check_interval_seconds: 1,
  threshold_count: 1,
  port_overrides: [
    {
      listener_port: 1,
      endpoint_port: 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
resp.endpoint_group.port_overrides #=> Array
resp.endpoint_group.port_overrides[0].listener_port #=> Integer
resp.endpoint_group.port_overrides[0].endpoint_port #=> 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. A resource must be valid and active when you add it as an endpoint.

  • :traffic_dial_percentage (Float) —

    The percentage of traffic to send to an Amazon Web Services 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 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 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.

  • :port_overrides (Array<Types::PortOverride>) —

    Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see [ Overriding listener ports] in the *Global Accelerator Developer Guide*.

    [1]: docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html

Returns:

See Also:



3494
3495
3496
3497
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3494

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. Client affinity gives you control over whether to always route each client to the same specific endpoint.

    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:



3567
3568
3569
3570
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3567

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


3647
3648
3649
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3647

def waiter_names
  []
end

#withdraw_byoip_cidr(params = {}) ⇒ Types::WithdrawByoipCidrResponse

Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.

For more information, see [Bring your own IP addresses (BYOIP)] in the *Global Accelerator Developer Guide*.

[1]: docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html

Examples:

Request syntax with placeholder values


resp = client.withdraw_byoip_cidr({
  cidr: "GenericString", # required
})

Response structure


resp.byoip_cidr.cidr #=> String
resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
resp.byoip_cidr.events #=> Array
resp.byoip_cidr.events[0].message #=> String
resp.byoip_cidr.events[0].timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3618
3619
3620
3621
 
# File 'lib/aws-sdk-globalaccelerator/client.rb', line 3618

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