Client

globalaccelerator

R Documentation

AWS Global Accelerator

Description

Global Accelerator

This is the Global Accelerator API Reference. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the Global Accelerator Developer Guide.

Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits.

• By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network.

• For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.

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.

By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP).

For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.

The 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 an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Tag-based policies.

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

For more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.

Usage

globalaccelerator(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- globalaccelerator(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

add_custom_routing_endpoints

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

add_endpoints

Add endpoints to an endpoint group

advertise_byoip_cidr

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP)

allow_custom_routing_traffic

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator

create_accelerator

Create an accelerator

create_cross_account_attachment

Create a cross-account attachment in Global Accelerator

create_custom_routing_accelerator

Create a custom routing accelerator

create_custom_routing_endpoint_group

Create an endpoint group for the specified listener for a custom routing accelerator

create_custom_routing_listener

Create a listener to process inbound connections from clients to a custom routing accelerator

create_endpoint_group

Create an endpoint group for the specified listener

create_listener

Create a listener to process inbound connections from clients to an accelerator

delete_accelerator

Delete an accelerator

delete_cross_account_attachment

Delete a cross-account attachment

delete_custom_routing_accelerator

Delete a custom routing accelerator

delete_custom_routing_endpoint_group

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

delete_custom_routing_listener

Delete a listener for a custom routing accelerator

delete_endpoint_group

Delete an endpoint group from a listener

delete_listener

Delete a listener from an accelerator

deny_custom_routing_traffic

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator

deprovision_byoip_cidr

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

describe_accelerator

Describe an accelerator

describe_accelerator_attributes

Describe the attributes of an accelerator

describe_cross_account_attachment

Gets configuration information about a cross-account attachment

describe_custom_routing_accelerator

Describe a custom routing accelerator

describe_custom_routing_accelerator_attributes

Describe the attributes of a custom routing accelerator

describe_custom_routing_endpoint_group

Describe an endpoint group for a custom routing accelerator

describe_custom_routing_listener

The description of a listener for a custom routing accelerator

describe_endpoint_group

Describe an endpoint group

describe_listener

Describe a listener

list_accelerators

List the accelerators for an Amazon Web Services account

list_byoip_cidrs

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

list_cross_account_attachments

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

list_cross_account_resource_accounts

List the accounts that have cross-account resources

list_cross_account_resources

List the cross-account resources available to work with

list_custom_routing_accelerators

List the custom routing accelerators for an Amazon Web Services account

list_custom_routing_endpoint_groups

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

list_custom_routing_listeners

List the listeners for a custom routing accelerator

list_custom_routing_port_mappings

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

list_custom_routing_port_mappings_by_destination

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint

list_endpoint_groups

List the endpoint groups that are associated with a listener

list_listeners

List the listeners for an accelerator

list_tags_for_resource

List all tags for an accelerator

provision_byoip_cidr

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

remove_custom_routing_endpoints

Remove endpoints from a custom routing accelerator

remove_endpoints

Remove endpoints from an endpoint group

tag_resource

Add tags to an accelerator resource

untag_resource

Remove tags from a Global Accelerator resource

update_accelerator

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

update_accelerator_attributes

Update the attributes for an accelerator

update_cross_account_attachment

Update a cross-account attachment to add or remove principals or resources

update_custom_routing_accelerator

Update a custom routing accelerator

update_custom_routing_accelerator_attributes

Update the attributes for a custom routing accelerator

update_custom_routing_listener

Update a listener for a custom routing accelerator

update_endpoint_group

Update an endpoint group

update_listener

Update a listener

withdraw_byoip_cidr

Stops advertising an address range that is provisioned as an address pool

Examples

## Not run: 
svc <- globalaccelerator()
svc$add_custom_routing_endpoints(
  Foo = 123
)

## End(Not run)