.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VM::EC2::REST::elastic_load_balancer 3pm" .TH VM::EC2::REST::elastic_load_balancer 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME VM::EC2::REST::elastic_load_balancer \- Elastic Load Balancers" .IX Header "NAME VM::EC2::REST::elastic_load_balancer - Elastic Load Balancers" .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use VM::EC2 \*(Aq:elb\*(Aq; .Ve .SH "METHODS" .IX Header "METHODS" The methods in this module allow you to retrieve information about Elastic Load Balancers, create new ELBs, and change the properties of the ELBs. .PP Implemented: AddTags ApplySecurityGroupsToLoadBalancer AttachLoadBalancerToSubnets ConfigureHealthCheck CreateAppCookieStickinessPolicy CreateLBCookieStickinessPolicy CreateLoadBalancer CreateLoadBalancerListeners CreateLoadBalancerPolicy DeleteLoadBalancer DeleteLoadBalancerListeners DeleteLoadBalancerPolicy DeregisterInstancesFromLoadBalancer DescribeInstanceHealth DescribeLoadBalancerAttributes DescribeLoadBalancerPolicies DescribeLoadBalancerPolicyTypes DescribeLoadBalancers DescribeTags DetachLoadBalancerFromSubnets DisableAvailabilityZonesForLoadBalancer EnableAvailabilityZonesForLoadBalancer ModifyLoadBalancerAttributes RegisterInstancesWithLoadBalancer RemoveTags SetLoadBalancerListenerSSLCertificate SetLoadBalancerPoliciesForBackendServer SetLoadBalancerPoliciesOfListener .PP Unimplemented: (none) .PP The primary object manipulated by these methods is \&\s-1VM::EC2::ELB\s0. Please see the \s-1VM::EC2::ELB\s0 manual page .ie n .SS "$success = $ec2\->tag_load_balancer(\-load_balancer_names => $name, \-tags => { key => value, [key2 => value2], ... })" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->tag_load_balancer(\-load_balancer_names => \f(CW$name\fP, \-tags => { key => value, [key2 => value2], ... })" .IX Subsection "$success = $ec2->tag_load_balancer(-load_balancer_names => $name, -tags => { key => value, [key2 => value2], ... })" Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. .PP Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key. .PP Arguments: .PP .Vb 2 \& \-load_balancer_names The name of the load balancer to tag. You can specify a \& maximum of one load balancer name. \& \& \-tags Hashref of tag key/value pairs. .Ve .PP Returns true on success. .ie n .SS "%tags = $ec2\->describe_load_balancer_tags(\-load_balancer_name=>\e@names)" .el .SS "\f(CW%tags\fP = \f(CW$ec2\fP\->describe_load_balancer_tags(\-load_balancer_name=>\e@names)" .IX Subsection "%tags = $ec2->describe_load_balancer_tags(-load_balancer_name=>@names)" .ie n .SS "%tags = $ec2\->describe_load_balancer_tags(@names)" .el .SS "\f(CW%tags\fP = \f(CW$ec2\fP\->describe_load_balancer_tags(@names)" .IX Subsection "%tags = $ec2->describe_load_balancer_tags(@names)" Describes the tags associated with one or more load balancers. .PP Arguments: .PP .Vb 1 \& \-load_balancer_names The name of the load balancers to retrieve tags for. .Ve .PP Returns a hash of hashes in this format: .PP { 'LBName' => { TagName => TagValue, TagName => TagValue, } } .ie n .SS "$success = $ec2\->remove_load_balancer_tags(\-load_balancer_names => $name, \-tags => [ name1,[name2,name3,...] ])" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->remove_load_balancer_tags(\-load_balancer_names => \f(CW$name\fP, \-tags => [ name1,[name2,name3,...] ])" .IX Subsection "$success = $ec2->remove_load_balancer_tags(-load_balancer_names => $name, -tags => [ name1,[name2,name3,...] ])" .ie n .SS "$success = $ec2\->remove_load_balancer_tags(\-load_balancer_names => $name, \-tags => $tag)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->remove_load_balancer_tags(\-load_balancer_names => \f(CW$name\fP, \-tags => \f(CW$tag\fP)" .IX Subsection "$success = $ec2->remove_load_balancer_tags(-load_balancer_names => $name, -tags => $tag)" .ie n .SS "$attrs = $ec2\->describe_load_balancer_attributes(\-load_balancer_name => $name)" .el .SS "\f(CW$attrs\fP = \f(CW$ec2\fP\->describe_load_balancer_attributes(\-load_balancer_name => \f(CW$name\fP)" .IX Subsection "$attrs = $ec2->describe_load_balancer_attributes(-load_balancer_name => $name)" Returns detailed information about all of the attributes associated with the specified load balancer. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name Name of the ELB to return information on. .Ve .PP Returns a VM::EC2::ELB::Attributes object. .ie n .SS "$attr = $ec2\->modify_load_balancer_attributes(%args)" .el .SS "\f(CW$attr\fP = \f(CW$ec2\fP\->modify_load_balancer_attributes(%args)" .IX Subsection "$attr = $ec2->modify_load_balancer_attributes(%args)" Modifies the attributes of a specified load balancer. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name Name of the ELB to change attributes on. (Required) .Ve .PP One or more of the following arguments are required: .PP .Vb 2 \& \-access_log A hashref of attribute values for AccessLog \& ex: \-access_log => { Enabled => \*(Aqfalse\*(Aq } \& \& \-connection_draining A hashref of attribute values for ConnectionDraining \& ex: \-connection_draining => { Enabled => \*(Aqfalse\*(Aq } \& \& \-connection_settings A hashref of attribute values for ConnectionSettings \& ex: \-connection_settings => { IdleTimeout => 30 } \& \& \-cross_zone_load_balancing A hashref of attribute values for \& CrossZoneLoadBalancing. ex: \& \-cross_zone_load_balancing => { Enabled => \*(Aqtrue\*(Aq } .Ve .PP Returns a VM::EC2::ELB::Attributes object. .ie n .SS "@lbs = $ec2\->describe_load_balancers(\-load_balancer_name=>\e@names)" .el .SS "\f(CW@lbs\fP = \f(CW$ec2\fP\->describe_load_balancers(\-load_balancer_name=>\e@names)" .IX Subsection "@lbs = $ec2->describe_load_balancers(-load_balancer_name=>@names)" .ie n .SS "@lbs = $ec2\->describe_load_balancers(@names)" .el .SS "\f(CW@lbs\fP = \f(CW$ec2\fP\->describe_load_balancers(@names)" .IX Subsection "@lbs = $ec2->describe_load_balancers(@names)" Provides detailed configuration information for the specified \s-1ELB\s0(s). .PP Optional parameters are: .PP .Vb 2 \& \-load_balancer_names Name of the ELB to return information on. \& This can be a string scalar, or an arrayref. \& \& \-lb_name,\-lb_names, \& \-load_balancer_name Aliases for \-load_balancer_names .Ve .PP Returns a series of \s-1VM::EC2::ELB\s0 objects. .ie n .SS "$success = $ec2\->delete_load_balancer(\-load_balancer_name=>$name)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_load_balancer(\-load_balancer_name=>$name)" .IX Subsection "$success = $ec2->delete_load_balancer(-load_balancer_name=>$name)" .ie n .SS "$success = $ec2\->delete_load_balancer($name)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_load_balancer($name)" .IX Subsection "$success = $ec2->delete_load_balancer($name)" Deletes the specified \s-1ELB.\s0 .PP Arguments: .PP .Vb 1 \& \-load_balancer_name \-\- The name of the ELB to delete \& \& \-lb_name \-\- Alias for \-load_balancer_name .Ve .PP Returns true on successful deletion. \s-1NOTE: \s0 This \s-1API\s0 call will return success regardless of existence of the \s-1ELB.\s0 .ie n .SS "$healthcheck = $ec2\->configure_health_check(\-load_balancer_name => $name, \-healthy_threshold => $cnt, \-interval => $secs, \-target => $target, \-timeout => $secs, \-unhealthy_threshold => $cnt)" .el .SS "\f(CW$healthcheck\fP = \f(CW$ec2\fP\->configure_health_check(\-load_balancer_name => \f(CW$name\fP, \-healthy_threshold => \f(CW$cnt\fP, \-interval => \f(CW$secs\fP, \-target => \f(CW$target\fP, \-timeout => \f(CW$secs\fP, \-unhealthy_threshold => \f(CW$cnt\fP)" .IX Subsection "$healthcheck = $ec2->configure_health_check(-load_balancer_name => $name, -healthy_threshold => $cnt, -interval => $secs, -target => $target, -timeout => $secs, -unhealthy_threshold => $cnt)" Defines an application healthcheck for the instances. .PP All Parameters are required. .PP .Vb 1 \& \-load_balancer_name Name of the ELB. \& \& \-healthy_threashold Specifies the number of consecutive health probe successes \& required before moving the instance to the Healthy state. \& \& \-interval Specifies the approximate interval, in seconds, between \& health checks of an individual instance. \& \& \-target Must be a string in the form: Protocol:Port[/PathToPing] \& \- Valid Protocol types are: HTTP, HTTPS, TCP, SSL \& \- Port must be in range 1\-65535 \& \- PathToPing is only applicable to HTTP or HTTPS protocol \& types and must be 1024 characters long or fewer. \& \& \-timeout Specifies the amount of time, in seconds, during which no \& response means a failed health probe. \& \& \-unhealthy_threashold Specifies the number of consecutive health probe failures \& required before moving the instance to the Unhealthy state. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns a VM::EC2::ELB::HealthCheck object. .ie n .SS "$success = $ec2\->create_app_cookie_stickiness_policy(\-load_balancer_name => $name, \-cookie_name => $cookie, \-policy_name => $policy)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_app_cookie_stickiness_policy(\-load_balancer_name => \f(CW$name\fP, \-cookie_name => \f(CW$cookie\fP, \-policy_name => \f(CW$policy\fP)" .IX Subsection "$success = $ec2->create_app_cookie_stickiness_policy(-load_balancer_name => $name, -cookie_name => $cookie, -policy_name => $policy)" Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with \&\s-1HTTP/HTTPS\s0 listeners. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name Name of the ELB. \& \& \-cookie_name Name of the application cookie used for stickiness. \& \& \-policy_name The name of the policy being created. The name must \& be unique within the set of policies for this ELB. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true on successful execution. .ie n .SS "$success = $ec2\->create_lb_cookie_stickiness_policy(\-load_balancer_name => $name, \-cookie_expiration_period => $secs, \-policy_name => $policy)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_lb_cookie_stickiness_policy(\-load_balancer_name => \f(CW$name\fP, \-cookie_expiration_period => \f(CW$secs\fP, \-policy_name => \f(CW$policy\fP)" .IX Subsection "$success = $ec2->create_lb_cookie_stickiness_policy(-load_balancer_name => $name, -cookie_expiration_period => $secs, -policy_name => $policy)" 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 \s-1HTTP/HTTPS\s0 listeners. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name Name of the ELB. \& \& \-cookie_expiration_period The time period in seconds after which the \& cookie should be considered stale. Not \& specifying this parameter indicates that the \& sticky session will last for the duration of \& the browser session. OPTIONAL \& \& \-policy_name The name of the policy being created. The name \& must be unique within the set of policies for \& this ELB. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true on successful execution. .ie n .SS "$lb = $ec2\->create_load_balancer(\-load_balancer_name => $name, \-listeners => \e@listeners, \-availability_zones => \e@zones, \-scheme => $scheme, )" .el .SS "\f(CW$lb\fP = \f(CW$ec2\fP\->create_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-listeners => \e@listeners, \-availability_zones => \e@zones, \-scheme => \f(CW$scheme\fP, )" .IX Subsection "$lb = $ec2->create_load_balancer(-load_balancer_name => $name, -listeners => @listeners, -availability_zones => @zones, -scheme => $scheme, )" Creates a new \s-1ELB.\s0 .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name Name of the ELB. \& \& \-listeners Must either be a L object \& (or arrayref of objects) or a hashref (or arrayref \& of hashrefs) containing the following keys: \& \& Protocol \-\- Value as one of: HTTP, HTTPS, TCP, or SSL \& LoadBalancerPort \-\- Value in range 1\-65535 \& InstancePort \-\- Value in range 1\-65535 \& and optionally: \& InstanceProtocol \-\- Value as one of: HTTP, HTTPS, TCP, or SSL \& SSLCertificateId \-\- Certificate ID from AWS IAM certificate list \& \& \& \-availability_zones Literal string or array of strings containing valid \& availability zones. Optional if subnets are \& specified in a VPC usage scenario. .Ve .PP Optional arguments: .PP .Vb 7 \& \-scheme The type of ELB. By default, Elastic Load Balancing \& creates an Internet\-facing LoadBalancer with a \& publicly resolvable DNS name, which resolves to \& public IP addresses. Specify the value \*(Aqinternal\*(Aq \& for this option to create an internal LoadBalancer \& with a DNS name that resolves to private IP addresses. \& This option is only available in a VPC. \& \& \-security_groups The security groups assigned to your ELB within your \& VPC. String or arrayref. \& \& \-subnets A list of subnet IDs in your VPC to attach to your \& ELB. String or arrayref. REQUIRED if availability \& zones are not specified above. \& \& \-tags A list of tags to assign to the load balancer. \& Hashref of tag key/value pairs. \& ex: { Name => Value, Name => Value, ... } .Ve .PP Argument aliases: .PP .Vb 2 \& \-zones Alias for \-availability_zones \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns a \s-1VM::EC2::ELB\s0 object if successful. .ie n .SS "$success = $ec2\->create_load_balancer_listeners(\-load_balancer_name => $name, \-listeners => \e@listeners)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_load_balancer_listeners(\-load_balancer_name => \f(CW$name\fP, \-listeners => \e@listeners)" .IX Subsection "$success = $ec2->create_load_balancer_listeners(-load_balancer_name => $name, -listeners => @listeners)" Creates one or more listeners on a \s-1ELB\s0 for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener. .PP .Vb 3 \& \-listeners Must either be a L object (or arrayref of \& objects) or a hash (or arrayref of hashes) containing the \& following keys: \& \& Protocol \-\- Value as one of: HTTP, HTTPS, TCP, or SSL \& LoadBalancerPort \-\- Value in range 1\-65535 \& InstancePort \-\- Value in range 1\-65535 \& and optionally: \& InstanceProtocol \-\- Value as one of: HTTP, HTTPS, TCP, or SSL \& SSLCertificateId \-\- Certificate ID from AWS IAM certificate list \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true on successful execution. .ie n .SS "$success = $ec2\->delete_load_balancer_listeners(\-load_balancer_name => $name, \-load_balancer_ports => \e@ports)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_load_balancer_listeners(\-load_balancer_name => \f(CW$name\fP, \-load_balancer_ports => \e@ports)" .IX Subsection "$success = $ec2->delete_load_balancer_listeners(-load_balancer_name => $name, -load_balancer_ports => @ports)" Deletes listeners from the \s-1ELB\s0 for the specified port. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-load_balancer_ports An arrayref of strings or literal string containing \& the port numbers. \& \& \-ports Alias for \-load_balancer_ports \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true on successful execution. .ie n .SS "@z = $ec2\->disable_availability_zones_for_load_balancer(\-load_balancer_name => $name, \-availability_zones => \e@zones)" .el .SS "\f(CW@z\fP = \f(CW$ec2\fP\->disable_availability_zones_for_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-availability_zones => \e@zones)" .IX Subsection "@z = $ec2->disable_availability_zones_for_load_balancer(-load_balancer_name => $name, -availability_zones => @zones)" Removes the specified \s-1EC2\s0 Availability Zones from the set of configured Availability Zones for the \s-1ELB. \s0 There must be at least one Availability Zone registered with a LoadBalancer at all times. Instances registered with the \s-1ELB\s0 that are in the removed Availability Zone go into the OutOfService state. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-availability_zones Arrayref or literal string of availability zone names \& (ie. us\-east\-1a) \& \& \-zones Alias for \-availability_zones \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns an array of VM::EC2::AvailabilityZone objects now associated with the \s-1ELB.\s0 .ie n .SS "@z = $ec2\->enable_availability_zones_for_load_balancer(\-load_balancer_name => $name, \-availability_zones => \e@zones)" .el .SS "\f(CW@z\fP = \f(CW$ec2\fP\->enable_availability_zones_for_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-availability_zones => \e@zones)" .IX Subsection "@z = $ec2->enable_availability_zones_for_load_balancer(-load_balancer_name => $name, -availability_zones => @zones)" Adds one or more \s-1EC2\s0 Availability Zones to the \s-1ELB. \s0 The \s-1ELB\s0 evenly distributes requests across all its registered Availability Zones that contain instances. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-availability_zones Array or literal string of availability zone names \& (ie. us\-east\-1a) \& \& \-zones Alias for \-availability_zones \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns an array of VM::EC2::AvailabilityZone objects now associated with the \s-1ELB.\s0 .ie n .SS "@i = $ec2\->register_instances_with_load_balancer(\-load_balancer_name => $name, \-instances => \e@instance_ids)" .el .SS "\f(CW@i\fP = \f(CW$ec2\fP\->register_instances_with_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-instances => \e@instance_ids)" .IX Subsection "@i = $ec2->register_instances_with_load_balancer(-load_balancer_name => $name, -instances => @instance_ids)" Adds new instances to the \s-1ELB. \s0 If the instance is in an availability zone that is not registered with the \s-1ELB\s0 will be in the OutOfService state. Once the zone is added to the \s-1ELB\s0 the instance will go into the InService state. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-instances An arrayref or literal string of Instance IDs. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns an array of instances now associated with the \s-1ELB\s0 in the form of VM::EC2::Instance objects. .ie n .SS "@i = $ec2\->deregister_instances_from_load_balancer(\-load_balancer_name => $name, \-instances => \e@instance_ids)" .el .SS "\f(CW@i\fP = \f(CW$ec2\fP\->deregister_instances_from_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-instances => \e@instance_ids)" .IX Subsection "@i = $ec2->deregister_instances_from_load_balancer(-load_balancer_name => $name, -instances => @instance_ids)" Deregisters instances from the \s-1ELB.\s0 Once the instance is deregistered, it will stop receiving traffic from the \s-1ELB. \s0 .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-instances An arrayref or literal string of Instance IDs. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns an array of instances now associated with the \s-1ELB\s0 in the form of VM::EC2::Instance objects. .ie n .SS "$success = $ec2\->set_load_balancer_listener_ssl_certificate(\-load_balancer_name => $name, \-load_balancer_port => $port, \-ssl_certificate_id => $cert_id)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->set_load_balancer_listener_ssl_certificate(\-load_balancer_name => \f(CW$name\fP, \-load_balancer_port => \f(CW$port\fP, \-ssl_certificate_id => \f(CW$cert_id\fP)" .IX Subsection "$success = $ec2->set_load_balancer_listener_ssl_certificate(-load_balancer_name => $name, -load_balancer_port => $port, -ssl_certificate_id => $cert_id)" Sets the certificate that terminates the specified listener's \s-1SSL\s0 connections. The specified certificate replaces any prior certificate that was used on the same \s-1ELB\s0 and port. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name of the the ELB. \& \& \-load_balancer_port The port that uses the specified SSL certificate. \& \& \-ssl_certificate_id The ID of the SSL certificate chain to use. See the \& AWS Identity and Access Management documentation under \& Managing Server Certificates for more information. .Ve .PP Alias arguments: .PP .Vb 1 \& \-lb_name Alias for \-load_balancer_name \& \& \-port Alias for \-load_balancer_port \& \& \-cert_id Alias for \-ssl_certificate_id .Ve .PP Returns true on successful execution. .ie n .SS "@states = $ec2\->describe_instance_health(\-load_balancer_name => $name, \-instances => \e@instance_ids)" .el .SS "\f(CW@states\fP = \f(CW$ec2\fP\->describe_instance_health(\-load_balancer_name => \f(CW$name\fP, \-instances => \e@instance_ids)" .IX Subsection "@states = $ec2->describe_instance_health(-load_balancer_name => $name, -instances => @instance_ids)" Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the instances for the \s-1ELB\s0 is returned. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB .Ve .PP Optional parameters: .PP .Vb 1 \& \-instances Literal string or arrayref of Instance IDs \& \& \-lb_name Alias for \-load_balancer_name \& \& \-instance_id Alias for \-instances .Ve .PP Returns an array of VM::EC2::ELB::InstanceState objects. .ie n .SS "$success = $ec2\->create_load_balancer_policy(\-load_balancer_name => $name, \-policy_name => $policy, \-policy_type_name => $type_name, \-policy_attributes => \e@attrs)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_load_balancer_policy(\-load_balancer_name => \f(CW$name\fP, \-policy_name => \f(CW$policy\fP, \-policy_type_name => \f(CW$type_name\fP, \-policy_attributes => \e@attrs)" .IX Subsection "$success = $ec2->create_load_balancer_policy(-load_balancer_name => $name, -policy_name => $policy, -policy_type_name => $type_name, -policy_attributes => @attrs)" Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your \s-1ELB\s0 and that can be applied to the front-end listener, or the back-end application server, depending on your policy type. .PP Required Arguments: .PP .Vb 3 \& \-load_balancer_name The name associated with the LoadBalancer for which the \& policy is being created. This name must be unique within \& the client AWS account. \& \& \-policy_name The name of the ELB policy being created. The name must \& be unique within the set of policies for this ELB. \& \& \-policy_type_name The name of the base policy type being used to create \& this policy. To get the list of policy types, use the \& describe_load_balancer_policy_types function. .Ve .PP Optional Arguments: .PP .Vb 3 \& \-policy_attributes or hashref containing AttributeName and AttributeValue \& or \& Arrayref of VM::EC2::ELB::PolicyAttribute object or single object \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true if successful. .ie n .SS "$success = $ec2\->delete_load_balancer_policy(\-load_balancer_name => $name, \-policy_name => $policy)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_load_balancer_policy(\-load_balancer_name => \f(CW$name\fP, \-policy_name => \f(CW$policy\fP)" .IX Subsection "$success = $ec2->delete_load_balancer_policy(-load_balancer_name => $name, -policy_name => $policy)" Deletes a policy from the \s-1ELB.\s0 The specified policy must not be enabled for any listeners. .PP Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB \& \& \-policy_name The name of the ELB policy \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true if successful. .ie n .SS "@policy_descs = $ec2\->describe_load_balancer_policies(\-load_balancer_name => $name, \-policy_names => \e@names)" .el .SS "\f(CW@policy_descs\fP = \f(CW$ec2\fP\->describe_load_balancer_policies(\-load_balancer_name => \f(CW$name\fP, \-policy_names => \e@names)" .IX Subsection "@policy_descs = $ec2->describe_load_balancer_policies(-load_balancer_name => $name, -policy_names => @names)" Returns detailed descriptions of \s-1ELB\s0 policies. If you specify an \s-1ELB\s0 name, the operation returns either the descriptions of the specified policies, or descriptions of all the policies created for the \s-1ELB.\s0 If you don't specify a \s-1ELB\s0 name, the operation returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample\- prefix. .PP Optional Arguments: .PP .Vb 1 \& \-load_balancer_name The name of the ELB. \& \& \-policy_names The names of ELB policies created or ELB sample policy names. \& \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns an array of VM::EC2::ELB::PolicyDescription objects if successful. .ie n .SS "@policy_types = $ec2\->describe_load_balancer_policy_types(\-policy_type_names => \e@names)" .el .SS "\f(CW@policy_types\fP = \f(CW$ec2\fP\->describe_load_balancer_policy_types(\-policy_type_names => \e@names)" .IX Subsection "@policy_types = $ec2->describe_load_balancer_policy_types(-policy_type_names => @names)" Returns meta-information on the specified \s-1ELB\s0 policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a create_load_balander_policy call to instantiate specific policy configurations that will be applied to an \s-1ELB.\s0 .PP Required arguemnts: .PP .Vb 1 \& \-load_balancer_name The name of the ELB. .Ve .PP Optional arguments: .PP .Vb 1 \& \-policy_type_names Literal string or arrayref of policy type names \& \& \-names Alias for \-policy_type_names .Ve .PP Returns an array of VM::EC2::ELB::PolicyTypeDescription objects if successful. .ie n .SS "$success = $ec2\->set_load_balancer_policies_of_listener(\-load_balancer_name => $name, \-load_balancer_port => $port, \-policy_names => \e@names)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->set_load_balancer_policies_of_listener(\-load_balancer_name => \f(CW$name\fP, \-load_balancer_port => \f(CW$port\fP, \-policy_names => \e@names)" .IX Subsection "$success = $ec2->set_load_balancer_policies_of_listener(-load_balancer_name => $name, -load_balancer_port => $port, -policy_names => @names)" Associates, updates, or disables a policy with a listener on the \s-1ELB. \s0 Multiple policies may be associated with a listener. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name associated with the ELB. \& \& \-load_balancer_port The external port of the LoadBalancer with which this \& policy applies to. \& \& \-policy_names List of policies to be associated with the listener. \& Currently this list can have at most one policy. If the \& list is empty, the current policy is removed from the \& listener. String or arrayref. .Ve .PP Returns true if successful. .ie n .SS "@sgs = $ec2\->apply_security_groups_to_load_balancer(\-load_balancer_name => $name, \-security_groups => \e@groups)" .el .SS "\f(CW@sgs\fP = \f(CW$ec2\fP\->apply_security_groups_to_load_balancer(\-load_balancer_name => \f(CW$name\fP, \-security_groups => \e@groups)" .IX Subsection "@sgs = $ec2->apply_security_groups_to_load_balancer(-load_balancer_name => $name, -security_groups => @groups)" Associates one or more security groups with your \s-1ELB\s0 in \s-1VPC. \s0 The provided security group IDs will override any currently applied security groups. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name associated with the ELB. \& \& \-security_groups A list of security group IDs to associate with your ELB in \& VPC. The security group IDs must be provided as the ID and \& not the security group name (For example, sg\-123456). \& String or arrayref. .Ve .PP Returns a series of VM::EC2::SecurityGroup objects. .ie n .SS "@subnets = $ec2\->attach_load_balancer_to_subnets(\-load_balancer_name => $name, \-subnets => \e@subnets)" .el .SS "\f(CW@subnets\fP = \f(CW$ec2\fP\->attach_load_balancer_to_subnets(\-load_balancer_name => \f(CW$name\fP, \-subnets => \e@subnets)" .IX Subsection "@subnets = $ec2->attach_load_balancer_to_subnets(-load_balancer_name => $name, -subnets => @subnets)" Adds one or more subnets to the set of configured subnets for the \s-1ELB.\s0 .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name associated with the ELB. \& \& \-subnets A list of subnet IDs to add for the ELB. String or \& arrayref. .Ve .PP Returns a series of VM::EC2::VPC::Subnet objects corresponding to the subnets the \s-1ELB\s0 is now attached to. .ie n .SS "@subnets = $ec2\->detach_load_balancer_from_subnets(\-load_balancer_name => $name, \-subnets => \e@subnets)" .el .SS "\f(CW@subnets\fP = \f(CW$ec2\fP\->detach_load_balancer_from_subnets(\-load_balancer_name => \f(CW$name\fP, \-subnets => \e@subnets)" .IX Subsection "@subnets = $ec2->detach_load_balancer_from_subnets(-load_balancer_name => $name, -subnets => @subnets)" Removes subnets from the set of configured subnets in the \s-1VPC\s0 for the \s-1ELB.\s0 .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name associated with the ELB. \& \& \-subnets A list of subnet IDs to add for the ELB. String or \& arrayref. .Ve .PP Returns a series of VM::EC2::VPC::Subnet objects corresponding to the subnets the \s-1ELB\s0 is now attached to. .ie n .SS "$success = $ec2\->set_load_balancer_policies_for_backend_server(\-instance_port => $port, \-load_balancer_name => $name, \-policy_names => \e@policies)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->set_load_balancer_policies_for_backend_server(\-instance_port => \f(CW$port\fP, \-load_balancer_name => \f(CW$name\fP, \-policy_names => \e@policies)" .IX Subsection "$success = $ec2->set_load_balancer_policies_for_backend_server(-instance_port => $port, -load_balancer_name => $name, -policy_names => @policies)" Replaces the current set of policies associated with a port on which the back\- end server is listening with a new set of policies. After the policies have been created, they can be applied here as a list. 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. .PP Required arguments: .PP .Vb 1 \& \-load_balancer_name The name associated with the ELB. \& \& \-instance_port The port number associated with the back\-end server. \& \& \-policy_names List of policy names to be set. If the list is empty, \& then all current polices are removed from the back\-end \& server. .Ve .PP Aliases: .PP .Vb 2 \& \-port Alias for \-instance_port \& \-lb_name Alias for \-load_balancer_name .Ve .PP Returns true if successful. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1VM::EC2\s0 .SH "AUTHOR" .IX Header "AUTHOR" Lance Kinley . Lincoln Stein . .PP Copyright (c) 2012 Loyalty Methods, Inc. Copyright (c) 2012 Ontario Institute for Cancer Research .PP This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the \s-1GPL \s0(either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to \s-1LICENSE\s0 for the full license text. In addition, please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.