GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::ELB (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



  use Paws;

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

Elastic Load Balancing distributes incoming traffic across your EC2 instances.

For information about the features of Elastic Load Balancing, see What Is Elastic Load Balancing? in the Elastic Load Balancing Developer Guide.

For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints - Elastic Load Balancing in the Amazon Web Services General Reference.

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], 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 Load Balancer in the Elastic Load Balancing Developer Guide.

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

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 Elastic Load Balancing Developer Guide.

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

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 Elastic Load Balancing Developer 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 back-end instances.

For more information, see Configure Health Checks in the Elastic Load Balancing Developer 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 Elastic Load Balancing Developer 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 back-end server 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 Elastic Load Balancing Developer Guide.

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

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

Returns: a Paws::ELB::CreateAccessPointOutput instance

Creates a load balancer.

If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see How Elastic Load Balancing Works in the Elastic Load Balancing Developer Guide.

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 Elastic Load Balancing Limits in the Elastic Load Balancing Developer 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 Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer 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 front-end listener or the back-end 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 back-end 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 Deregister and Register Amazon EC2 Instances in the Elastic Load Balancing Developer 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 registered with the specified load balancer. If no instances are specified, the call describes the state of all instances registered with the load balancer, not including any terminated instances.

    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]])

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]])

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

Returns: a Paws::ELB::DescribeLoadBalancerPolicyTypesOutput instance

Describes the specified load balancer policy types.

You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.

    DescribeLoadBalancers([LoadBalancerNames => ArrayRef[Str], 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])

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])

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], 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 Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.

    EnableAvailabilityZonesForLoadBalancer(AvailabilityZones => ArrayRef[Str], 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 Availability Zone in the Elastic Load Balancing Developer 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 Elastic Load Balancing Developer Guide:
o Cross-Zone Load Balancing
o Connection Draining
o Access Logs
o 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 happens shortly afterwards. 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.

If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide.

    RemoveTags(LoadBalancerNames => ArrayRef[Str], 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 Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.

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

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 back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end 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 back-end server.

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

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

Returns: a Paws::ELB::SetLoadBalancerPoliciesOfListenerOutput instance

Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::ELB (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.