NAME

Paws::GlobalAccelerator - Perl Interface to AWS AWS Global Accelerator

SYNOPSIS

  use Paws;

  my $obj = Paws->service('GlobalAccelerator');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Global Accelerator

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 (https://docs.aws.amazon.com/global-accelerator/latest/dg/Welcome.html).

AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.

Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.

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 directed to only healthy endpoints.

Global Accelerator includes components that work together to help you improve performance and availability for your applications:

Static IP address

AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.

Accelerator

An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.

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, 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 protocol and port that you configure. 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. 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. 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 new releases across different AWS Regions, for example.

Endpoint

An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the 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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08

METHODS

CreateAccelerator

IdempotencyToken => Str
Name => Str
[Enabled => Bool]
[IpAddressType => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::CreateAccelerator

Returns: a Paws::GlobalAccelerator::CreateAcceleratorResponse instance

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example.

CreateEndpointGroup

EndpointGroupRegion => Str
IdempotencyToken => Str
ListenerArn => Str
[EndpointConfigurations => ArrayRef[Paws::GlobalAccelerator::EndpointConfiguration]]
[HealthCheckIntervalSeconds => Int]
[HealthCheckPath => Str]
[HealthCheckPort => Int]
[HealthCheckProtocol => Str]
[ThresholdCount => Int]
[TrafficDialPercentage => Num]

Each argument is described in detail in: Paws::GlobalAccelerator::CreateEndpointGroup

Returns: a Paws::GlobalAccelerator::CreateEndpointGroupResponse instance

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

CreateListener

AcceleratorArn => Str
IdempotencyToken => Str
PortRanges => ArrayRef[Paws::GlobalAccelerator::PortRange]
Protocol => Str
[ClientAffinity => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::CreateListener

Returns: a Paws::GlobalAccelerator::CreateListenerResponse instance

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example.

DeleteAccelerator

AcceleratorArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DeleteAccelerator

Returns: nothing

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

DeleteEndpointGroup

EndpointGroupArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DeleteEndpointGroup

Returns: nothing

Delete an endpoint group from a listener.

DeleteListener

ListenerArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DeleteListener

Returns: nothing

Delete a listener from an accelerator.

DescribeAccelerator

AcceleratorArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DescribeAccelerator

Returns: a Paws::GlobalAccelerator::DescribeAcceleratorResponse instance

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

DescribeAcceleratorAttributes

[AcceleratorArn => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::DescribeAcceleratorAttributes

Returns: a Paws::GlobalAccelerator::DescribeAcceleratorAttributesResponse instance

Describe the attributes of an accelerator.

DescribeEndpointGroup

EndpointGroupArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DescribeEndpointGroup

Returns: a Paws::GlobalAccelerator::DescribeEndpointGroupResponse instance

Describe an endpoint group.

DescribeListener

ListenerArn => Str

Each argument is described in detail in: Paws::GlobalAccelerator::DescribeListener

Returns: a Paws::GlobalAccelerator::DescribeListenerResponse instance

Describe a listener.

ListAccelerators

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::ListAccelerators

Returns: a Paws::GlobalAccelerator::ListAcceleratorsResponse instance

List the accelerators for an AWS account.

ListEndpointGroups

ListenerArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::ListEndpointGroups

Returns: a Paws::GlobalAccelerator::ListEndpointGroupsResponse instance

List the endpoint groups that are associated with a listener.

ListListeners

AcceleratorArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::ListListeners

Returns: a Paws::GlobalAccelerator::ListListenersResponse instance

List the listeners for an accelerator.

UpdateAccelerator

AcceleratorArn => Str
[Enabled => Bool]
[IpAddressType => Str]
[Name => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::UpdateAccelerator

Returns: a Paws::GlobalAccelerator::UpdateAcceleratorResponse instance

Update an accelerator.

UpdateAcceleratorAttributes

[AcceleratorArn => Str]
[FlowLogsEnabled => Bool]
[FlowLogsS3Bucket => Str]
[FlowLogsS3Prefix => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::UpdateAcceleratorAttributes

Returns: a Paws::GlobalAccelerator::UpdateAcceleratorAttributesResponse instance

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

UpdateEndpointGroup

EndpointGroupArn => Str
[EndpointConfigurations => ArrayRef[Paws::GlobalAccelerator::EndpointConfiguration]]
[HealthCheckIntervalSeconds => Int]
[HealthCheckPath => Str]
[HealthCheckPort => Int]
[HealthCheckProtocol => Str]
[ThresholdCount => Int]
[TrafficDialPercentage => Num]

Each argument is described in detail in: Paws::GlobalAccelerator::UpdateEndpointGroup

Returns: a Paws::GlobalAccelerator::UpdateEndpointGroupResponse instance

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

UpdateListener

ListenerArn => Str
[ClientAffinity => Str]
[PortRanges => ArrayRef[Paws::GlobalAccelerator::PortRange]]
[Protocol => Str]

Each argument is described in detail in: Paws::GlobalAccelerator::UpdateListener

Returns: a Paws::GlobalAccelerator::UpdateListenerResponse instance

Update a listener.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAccelerators(sub { },[MaxResults => Int, NextToken => Str])

ListAllAccelerators([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Accelerators, passing the object as the first parameter, and the string 'Accelerators' as the second parameter 

If not, it will return a a Paws::GlobalAccelerator::ListAcceleratorsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEndpointGroups(sub { },ListenerArn => Str, [MaxResults => Int, NextToken => Str])

ListAllEndpointGroups(ListenerArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - EndpointGroups, passing the object as the first parameter, and the string 'EndpointGroups' as the second parameter 

If not, it will return a a Paws::GlobalAccelerator::ListEndpointGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllListeners(sub { },AcceleratorArn => Str, [MaxResults => Int, NextToken => Str])

ListAllListeners(AcceleratorArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Listeners, passing the object as the first parameter, and the string 'Listeners' as the second parameter 

If not, it will return a a Paws::GlobalAccelerator::ListListenersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues