NAME

Paws::ELB - Perl Interface to AWS Elastic Load Balancing

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ELB');
  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

Elastic Load Balancing

A load balancer distributes incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports two types of load balancers: Classic Load Balancers and Application Load Balancers (new). A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

METHODS

AddTags(LoadBalancerNames => ArrayRef[Str|Undef], Tags => ArrayRef[Paws::ELB::Tag])

Each argument is described in detail in: Paws::ELB::AddTags

Returns: a Paws::ELB::AddTagsOutput instance

  Adds the specified tags to the specified load balancer. Each load
balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Classic Load Balancer in the Classic Load Balancer Guide.

ApplySecurityGroupsToLoadBalancer(LoadBalancerName => Str, SecurityGroups => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::ApplySecurityGroupsToLoadBalancer

Returns: a Paws::ELB::ApplySecurityGroupsToLoadBalancerOutput instance

  Associates one or more security groups with your load balancer in a
virtual private cloud (VPC). The specified security groups override the
previously associated security groups.

For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancer Guide.

AttachLoadBalancerToSubnets(LoadBalancerName => Str, Subnets => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::AttachLoadBalancerToSubnets

Returns: a Paws::ELB::AttachLoadBalancerToSubnetsOutput instance

  Adds one or more subnets to the set of configured subnets for the
specified load balancer.

The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancer Guide.

ConfigureHealthCheck(HealthCheck => Paws::ELB::HealthCheck, LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::ConfigureHealthCheck

Returns: a Paws::ELB::ConfigureHealthCheckOutput instance

  Specifies the health check settings to use when evaluating the health
state of your EC2 instances.

For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancer Guide.

CreateAppCookieStickinessPolicy(CookieName => Str, LoadBalancerName => Str, PolicyName => Str)

Each argument is described in detail in: Paws::ELB::CreateAppCookieStickinessPolicy

Returns: a Paws::ELB::CreateAppCookieStickinessPolicyOutput instance

  Generates a stickiness policy with sticky session lifetimes that follow
that of an application-generated cookie. This policy can be associated
only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Application-Controlled Session Stickiness in the Classic Load Balancer Guide.

CreateLBCookieStickinessPolicy(LoadBalancerName => Str, PolicyName => Str, [CookieExpirationPeriod => Int])

Each argument is described in detail in: Paws::ELB::CreateLBCookieStickinessPolicy

Returns: a Paws::ELB::CreateLBCookieStickinessPolicyOutput instance

  Generates a stickiness policy with sticky session lifetimes controlled
by the lifetime of the browser (user-agent) or a specified expiration
period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Duration-Based Session Stickiness in the Classic Load Balancer Guide.

CreateLoadBalancer(Listeners => ArrayRef[Paws::ELB::Listener], LoadBalancerName => Str, [AvailabilityZones => ArrayRef[Str|Undef], Scheme => Str, SecurityGroups => ArrayRef[Str|Undef], Subnets => ArrayRef[Str|Undef], Tags => ArrayRef[Paws::ELB::Tag]])

Each argument is described in detail in: Paws::ELB::CreateLoadBalancer

Returns: a Paws::ELB::CreateAccessPointOutput instance

  Creates a Classic Load Balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancer Guide.

CreateLoadBalancerListeners(Listeners => ArrayRef[Paws::ELB::Listener], LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::CreateLoadBalancerListeners

Returns: a Paws::ELB::CreateLoadBalancerListenerOutput instance

  Creates one or more listeners for the specified load balancer. If a
listener with the specified port does not already exist, it is created;
otherwise, the properties of the new listener must match the properties
of the existing listener.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancer Guide.

CreateLoadBalancerPolicy(LoadBalancerName => Str, PolicyName => Str, PolicyTypeName => Str, [PolicyAttributes => ArrayRef[Paws::ELB::PolicyAttribute]])

Each argument is described in detail in: Paws::ELB::CreateLoadBalancerPolicy

Returns: a Paws::ELB::CreateLoadBalancerPolicyOutput instance

  Creates a policy with the specified attributes for the specified load
balancer.

Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.

DeleteLoadBalancer(LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::DeleteLoadBalancer

Returns: a Paws::ELB::DeleteAccessPointOutput instance

  Deletes the specified load balancer.

If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.

If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.

DeleteLoadBalancerListeners(LoadBalancerName => Str, LoadBalancerPorts => ArrayRef[Int])

Each argument is described in detail in: Paws::ELB::DeleteLoadBalancerListeners

Returns: a Paws::ELB::DeleteLoadBalancerListenerOutput instance

  Deletes the specified listeners from the specified load balancer.

DeleteLoadBalancerPolicy(LoadBalancerName => Str, PolicyName => Str)

Each argument is described in detail in: Paws::ELB::DeleteLoadBalancerPolicy

Returns: a Paws::ELB::DeleteLoadBalancerPolicyOutput instance

  Deletes the specified policy from the specified load balancer. This
policy must not be enabled for any listeners.

DeregisterInstancesFromLoadBalancer(Instances => ArrayRef[Paws::ELB::Instance], LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::DeregisterInstancesFromLoadBalancer

Returns: a Paws::ELB::DeregisterEndPointsOutput instance

  Deregisters the specified instances from the specified load balancer.
After the instance is deregistered, it no longer receives traffic from
the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancer Guide.

DescribeAccountLimits([Marker => Str, PageSize => Int])

Each argument is described in detail in: Paws::ELB::DescribeAccountLimits

Returns: a Paws::ELB::DescribeAccountLimitsOutput instance

  Describes the current Elastic Load Balancing resource limits for your
AWS account.

For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancer Guide.

DescribeInstanceHealth(LoadBalancerName => Str, [Instances => ArrayRef[Paws::ELB::Instance]])

Each argument is described in detail in: Paws::ELB::DescribeInstanceHealth

Returns: a Paws::ELB::DescribeEndPointStateOutput instance

  Describes the state of the specified instances with respect to the
specified load balancer. If no instances are specified, the call
describes the state of all instances that are currently registered with
the load balancer. If instances are specified, their state is returned
even if they are no longer registered with the load balancer. The state
of terminated instances is not returned.

DescribeLoadBalancerAttributes(LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::DescribeLoadBalancerAttributes

Returns: a Paws::ELB::DescribeLoadBalancerAttributesOutput instance

  Describes the attributes for the specified load balancer.

DescribeLoadBalancerPolicies([LoadBalancerName => Str, PolicyNames => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ELB::DescribeLoadBalancerPolicies

Returns: a Paws::ELB::DescribeLoadBalancerPoliciesOutput instance

  Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.

DescribeLoadBalancerPolicyTypes([PolicyTypeNames => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ELB::DescribeLoadBalancerPolicyTypes

Returns: a Paws::ELB::DescribeLoadBalancerPolicyTypesOutput instance

  Describes the specified load balancer policy types or all load balancer
policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

DescribeLoadBalancers([LoadBalancerNames => ArrayRef[Str|Undef], Marker => Str, PageSize => Int])

Each argument is described in detail in: Paws::ELB::DescribeLoadBalancers

Returns: a Paws::ELB::DescribeAccessPointsOutput instance

  Describes the specified the load balancers. If no load balancers are
specified, the call describes all of your load balancers.

DescribeTags(LoadBalancerNames => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::DescribeTags

Returns: a Paws::ELB::DescribeTagsOutput instance

  Describes the tags associated with the specified load balancers.

DetachLoadBalancerFromSubnets(LoadBalancerName => Str, Subnets => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::DetachLoadBalancerFromSubnets

Returns: a Paws::ELB::DetachLoadBalancerFromSubnetsOutput instance

  Removes the specified subnets from the set of configured subnets for
the load balancer.

After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.

DisableAvailabilityZonesForLoadBalancer(AvailabilityZones => ArrayRef[Str|Undef], LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::DisableAvailabilityZonesForLoadBalancer

Returns: a Paws::ELB::RemoveAvailabilityZonesOutput instance

  Removes the specified Availability Zones from the set of Availability
Zones for the specified load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

For more information, see Add or Remove Availability Zones in the Classic Load Balancer Guide.

EnableAvailabilityZonesForLoadBalancer(AvailabilityZones => ArrayRef[Str|Undef], LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::EnableAvailabilityZonesForLoadBalancer

Returns: a Paws::ELB::AddAvailabilityZonesOutput instance

  Adds the specified Availability Zones to the set of Availability Zones
for the specified load balancer.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.

For more information, see Add or Remove Availability Zones in the Classic Load Balancer Guide.

ModifyLoadBalancerAttributes(LoadBalancerAttributes => Paws::ELB::LoadBalancerAttributes, LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::ModifyLoadBalancerAttributes

Returns: a Paws::ELB::ModifyLoadBalancerAttributesOutput instance

  Modifies the attributes of the specified load balancer.

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following in the Classic Load Balancer Guide:

• Cross-Zone Load Balancing

• Connection Draining

• Access Logs

• Idle Connection Timeout

RegisterInstancesWithLoadBalancer(Instances => ArrayRef[Paws::ELB::Instance], LoadBalancerName => Str)

Each argument is described in detail in: Paws::ELB::RegisterInstancesWithLoadBalancer

Returns: a Paws::ELB::RegisterEndPointsOutput instance

  Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancer Guide.

RemoveTags(LoadBalancerNames => ArrayRef[Str|Undef], Tags => ArrayRef[Paws::ELB::TagKeyOnly])

Each argument is described in detail in: Paws::ELB::RemoveTags

Returns: a Paws::ELB::RemoveTagsOutput instance

  Removes one or more tags from the specified load balancer.

SetLoadBalancerListenerSSLCertificate(LoadBalancerName => Str, LoadBalancerPort => Int, SSLCertificateId => Str)

Each argument is described in detail in: Paws::ELB::SetLoadBalancerListenerSSLCertificate

Returns: a Paws::ELB::SetLoadBalancerListenerSSLCertificateOutput instance

  Sets the certificate that terminates the specified listener's SSL
connections. The specified certificate replaces any prior certificate
that was used on the same load balancer and port.

For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancer Guide.

SetLoadBalancerPoliciesForBackendServer(InstancePort => Int, LoadBalancerName => Str, PolicyNames => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::SetLoadBalancerPoliciesForBackendServer

Returns: a Paws::ELB::SetLoadBalancerPoliciesForBackendServerOutput instance

  Replaces the set of policies associated with the specified port on
which the EC2 instance is listening with a new set of policies. At this
time, only the back-end server authentication policy type can be
applied to the instance ports; this policy type is composed of multiple
public key policies.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancer Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancer Guide.

SetLoadBalancerPoliciesOfListener(LoadBalancerName => Str, LoadBalancerPort => Int, PolicyNames => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::ELB::SetLoadBalancerPoliciesOfListener

Returns: a Paws::ELB::SetLoadBalancerPoliciesOfListenerOutput instance

  Replaces the current set of policies for the specified load balancer
port with the specified set of policies.

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancer Guide.

PAGINATORS

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

DescribeAllLoadBalancers(sub { },[LoadBalancerNames => ArrayRef[Str|Undef], Marker => Str, PageSize => Int])

DescribeAllLoadBalancers([LoadBalancerNames => ArrayRef[Str|Undef], Marker => Str, PageSize => Int])

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

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

If not, it will return a a Paws::ELB::DescribeAccessPointsOutput 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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config