globalaccelerator: AWS Global Accelerator

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

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

AWS Global Accelerator is a 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.

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.

By default, Global Accelerator provides you with two static IP addresses that you associate with your accelerator. With a standard accelerator, instead of using the IP 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. The static IP addresses are anycast from the AWS edge network. For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple AWS 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 AWS Region or multiple 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 AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.

For a list of the AWS Regions where Global Accelerator and other services are currently supported, see the AWS Region Table.

AWS Global Accelerator includes the following components:

Static IP addresses

Global Accelerator provides you with a set of two static IP addresses that are anycast from the AWS edge network. If you bring your own IP address range to AWS (BYOIP) to use with a standard accelerator, you can instead assign IP addresses from your own pool to use with your accelerator. For more information, see Bring your own IP addresses (BYOIP) in AWS Global Accelerator.

The IP addresses serve as single fixed entry points for your clients. If you already have Elastic Load Balancing load balancers, Amazon EC2 instances, or Elastic IP address resources set up for your applications, you can easily add those to a standard accelerator in Global Accelerator. This allows Global Accelerator to use static IP addresses to access the resources.

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 delete an accelerator. For more information, see Tag-based policies.

Accelerator

An accelerator directs traffic to endpoints over the AWS global network to improve the performance of your internet applications. Each accelerator includes one or more listeners.

There are two types of accelerators:

For more information, see Types of accelerators.

DNS name

Global Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to a1234567890abcdef.awsglobalaccelerator.com, that points to the static IP addresses that Global Accelerator assigns to you or that you choose from your own IP address range. Depending on the use case, you can use your accelerator's static IP addresses or DNS name to route traffic to your accelerator, or set up DNS records to route traffic using your own custom domain name.

Network zone

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

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the port (or port range) and protocol (or protocols) that you configure. A listener can be configured for TCP, UDP, or both TCP and UDP protocols. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. With a standard accelerator, traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

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

Endpoint

An endpoint is a resource that Global Accelerator directs traffic to.

Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses. An Application Load Balancer endpoint can be internet-facing or internal. Traffic for standard accelerators is routed to endpoints based on the health of the endpoint along with configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.

Endpoints for custom routing accelerators are virtual private cloud (VPC) subnets with one or many EC2 instances.

Usage

1
globalaccelerator(config = list())

Arguments

config

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- globalaccelerator(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_custom_routing_endpoints Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator
advertise_byoip_cidr Advertises an IPv4 address range that is provisioned for use with your AWS 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_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_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 AWS 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_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 AWS 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_custom_routing_accelerators List the custom routing accelerators for an AWS 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 AWS 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
tag_resource Add tags to an accelerator resource
untag_resource Remove tags from a Global Accelerator resource
update_accelerator Update an accelerator
update_accelerator_attributes Update the attributes for an accelerator
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

1
2
3
4
5
6
7
## Not run: 
svc <- globalaccelerator()
svc$add_custom_routing_endpoints(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to globalaccelerator in paws...