libZSservicesZSamazonka-elbZSamazonka-elb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ELB.Lens

Description

 
Synopsis

Operations

DescribeLoadBalancers

describeLoadBalancers_marker :: Lens' DescribeLoadBalancers (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeLoadBalancers_pageSize :: Lens' DescribeLoadBalancers (Maybe Natural) Source #

The maximum number of results to return with this call (a number from 1 to 400). The default is 400.

describeLoadBalancersResponse_nextMarker :: Lens' DescribeLoadBalancersResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

DescribeTags

DescribeLoadBalancerPolicyTypes

describeLoadBalancerPolicyTypes_policyTypeNames :: Lens' DescribeLoadBalancerPolicyTypes (Maybe [Text]) Source #

The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

ApplySecurityGroupsToLoadBalancer

applySecurityGroupsToLoadBalancer_securityGroups :: Lens' ApplySecurityGroupsToLoadBalancer [Text] Source #

The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

RemoveTags

removeTags_loadBalancerNames :: Lens' RemoveTags [Text] Source #

The name of the load balancer. You can specify a maximum of one load balancer name.

removeTags_tags :: Lens' RemoveTags (NonEmpty TagKeyOnly) Source #

The list of tag keys to remove.

CreateLBCookieStickinessPolicy

createLBCookieStickinessPolicy_cookieExpirationPeriod :: Lens' CreateLBCookieStickinessPolicy (Maybe Integer) Source #

The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

createLBCookieStickinessPolicy_policyName :: Lens' CreateLBCookieStickinessPolicy Text Source #

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

DeleteLoadBalancer

DeregisterInstancesFromLoadBalancer

CreateLoadBalancerPolicy

createLoadBalancerPolicy_policyName :: Lens' CreateLoadBalancerPolicy Text Source #

The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.

createLoadBalancerPolicy_policyTypeName :: Lens' CreateLoadBalancerPolicy Text Source #

The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

DescribeLoadBalancerPolicies

DisableAvailabilityZonesForLoadBalancer

EnableAvailabilityZonesForLoadBalancer

enableAvailabilityZonesForLoadBalancer_availabilityZones :: Lens' EnableAvailabilityZonesForLoadBalancer [Text] Source #

The Availability Zones. These must be in the same region as the load balancer.

SetLoadBalancerPoliciesForBackendServer

setLoadBalancerPoliciesForBackendServer_policyNames :: Lens' SetLoadBalancerPoliciesForBackendServer [Text] Source #

The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

SetLoadBalancerListenerSSLCertificate

DescribeAccountLimits

describeAccountLimits_marker :: Lens' DescribeAccountLimits (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeAccountLimits_pageSize :: Lens' DescribeAccountLimits (Maybe Natural) Source #

The maximum number of results to return with this call.

describeAccountLimitsResponse_nextMarker :: Lens' DescribeAccountLimitsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

AttachLoadBalancerToSubnets

attachLoadBalancerToSubnets_subnets :: Lens' AttachLoadBalancerToSubnets [Text] Source #

The IDs of the subnets to add. You can add only one subnet per Availability Zone.

attachLoadBalancerToSubnetsResponse_subnets :: Lens' AttachLoadBalancerToSubnetsResponse (Maybe [Text]) Source #

The IDs of the subnets attached to the load balancer.

ConfigureHealthCheck

ModifyLoadBalancerAttributes

CreateAppCookieStickinessPolicy

createAppCookieStickinessPolicy_policyName :: Lens' CreateAppCookieStickinessPolicy Text Source #

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

createAppCookieStickinessPolicy_cookieName :: Lens' CreateAppCookieStickinessPolicy Text Source #

The name of the application cookie used for stickiness.

DescribeInstanceHealth

AddTags

addTags_loadBalancerNames :: Lens' AddTags [Text] Source #

The name of the load balancer. You can specify one load balancer only.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.

DescribeLoadBalancerAttributes

CreateLoadBalancerListeners

DeleteLoadBalancerPolicy

DetachLoadBalancerFromSubnets

RegisterInstancesWithLoadBalancer

CreateLoadBalancer

createLoadBalancer_securityGroups :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

The IDs of the security groups to assign to the load balancer.

createLoadBalancer_subnets :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

createLoadBalancer_availabilityZones :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

One or more Availability Zones from the same region as the load balancer.

You must specify at least one Availability Zone.

You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

createLoadBalancer_scheme :: Lens' CreateLoadBalancer (Maybe Text) Source #

The type of a load balancer. Valid only for load balancers in a VPC.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe (NonEmpty Tag)) Source #

A list of tags to assign to the load balancer.

For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

createLoadBalancer_loadBalancerName :: Lens' CreateLoadBalancer Text Source #

The name of the load balancer.

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

createLoadBalancer_listeners :: Lens' CreateLoadBalancer [Listener] Source #

The listeners.

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

DeleteLoadBalancerListeners

SetLoadBalancerPoliciesOfListener

setLoadBalancerPoliciesOfListener_policyNames :: Lens' SetLoadBalancerPoliciesOfListener [Text] Source #

The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled.

Types

AccessLog

accessLog_emitInterval :: Lens' AccessLog (Maybe Int) Source #

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

Default: 60 minutes

accessLog_s3BucketPrefix :: Lens' AccessLog (Maybe Text) Source #

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

accessLog_s3BucketName :: Lens' AccessLog (Maybe Text) Source #

The name of the Amazon S3 bucket where the access logs are stored.

accessLog_enabled :: Lens' AccessLog Bool Source #

Specifies whether access logs are enabled for the load balancer.

AdditionalAttribute

additionalAttribute_key :: Lens' AdditionalAttribute (Maybe Text) Source #

The name of the attribute.

The following attribute is supported.

  • elb.http.desyncmitigationmode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.

AppCookieStickinessPolicy

appCookieStickinessPolicy_policyName :: Lens' AppCookieStickinessPolicy (Maybe Text) Source #

The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

appCookieStickinessPolicy_cookieName :: Lens' AppCookieStickinessPolicy (Maybe Text) Source #

The name of the application cookie used for stickiness.

BackendServerDescription

backendServerDescription_policyNames :: Lens' BackendServerDescription (Maybe [Text]) Source #

The names of the policies enabled for the EC2 instance.

backendServerDescription_instancePort :: Lens' BackendServerDescription (Maybe Natural) Source #

The port on which the EC2 instance is listening.

ConnectionDraining

connectionDraining_timeout :: Lens' ConnectionDraining (Maybe Int) Source #

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

connectionDraining_enabled :: Lens' ConnectionDraining Bool Source #

Specifies whether connection draining is enabled for the load balancer.

ConnectionSettings

connectionSettings_idleTimeout :: Lens' ConnectionSettings Natural Source #

The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

CrossZoneLoadBalancing

crossZoneLoadBalancing_enabled :: Lens' CrossZoneLoadBalancing Bool Source #

Specifies whether cross-zone load balancing is enabled for the load balancer.

HealthCheck

healthCheck_target :: Lens' HealthCheck Text Source #

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

healthCheck_interval :: Lens' HealthCheck Natural Source #

The approximate interval, in seconds, between health checks of an individual instance.

healthCheck_timeout :: Lens' HealthCheck Natural Source #

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

healthCheck_unhealthyThreshold :: Lens' HealthCheck Natural Source #

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

healthCheck_healthyThreshold :: Lens' HealthCheck Natural Source #

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Instance

InstanceState

instanceState_state :: Lens' InstanceState (Maybe Text) Source #

The current state of the instance.

Valid values: InService | OutOfService | Unknown

instanceState_reasonCode :: Lens' InstanceState (Maybe Text) Source #

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

instanceState_description :: Lens' InstanceState (Maybe Text) Source #

A description of the instance state. This string can contain one or more of the following messages.

  • N/A
  • A transient error occurred. Please try again later.
  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.
  • Instance registration is still in progress.
  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
  • Instance is not currently registered with the LoadBalancer.
  • Instance deregistration currently in progress.
  • Disable Availability Zone is currently in progress.
  • Instance is in pending state.
  • Instance is in stopped state.
  • Instance is in terminated state.

LBCookieStickinessPolicy

lBCookieStickinessPolicy_policyName :: Lens' LBCookieStickinessPolicy (Maybe Text) Source #

The name of the policy. This name must be unique within the set of policies for this load balancer.

lBCookieStickinessPolicy_cookieExpirationPeriod :: Lens' LBCookieStickinessPolicy (Maybe Integer) Source #

The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.

Limit

limit_max :: Lens' Limit (Maybe Text) Source #

The maximum value of the limit.

limit_name :: Lens' Limit (Maybe Text) Source #

The name of the limit. The possible values are:

  • classic-listeners
  • classic-load-balancers
  • classic-registered-instances

Listener

listener_instanceProtocol :: Lens' Listener (Maybe Text) Source #

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

listener_sSLCertificateId :: Lens' Listener (Maybe Text) Source #

The Amazon Resource Name (ARN) of the server certificate.

listener_protocol :: Lens' Listener Text Source #

The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

listener_loadBalancerPort :: Lens' Listener Int Source #

The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

listener_instancePort :: Lens' Listener Natural Source #

The port on which the instance is listening.

ListenerDescription

listenerDescription_policyNames :: Lens' ListenerDescription (Maybe [Text]) Source #

The policies. If there are no policies enabled, the list is empty.

LoadBalancerAttributes

loadBalancerAttributes_crossZoneLoadBalancing :: Lens' LoadBalancerAttributes (Maybe CrossZoneLoadBalancing) Source #

If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

loadBalancerAttributes_accessLog :: Lens' LoadBalancerAttributes (Maybe AccessLog) Source #

If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

For more information, see Enable Access Logs in the Classic Load Balancers Guide.

loadBalancerAttributes_connectionSettings :: Lens' LoadBalancerAttributes (Maybe ConnectionSettings) Source #

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

loadBalancerAttributes_connectionDraining :: Lens' LoadBalancerAttributes (Maybe ConnectionDraining) Source #

If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

LoadBalancerDescription

loadBalancerDescription_sourceSecurityGroup :: Lens' LoadBalancerDescription (Maybe SourceSecurityGroup) Source #

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

loadBalancerDescription_canonicalHostedZoneName :: Lens' LoadBalancerDescription (Maybe Text) Source #

The DNS name of the load balancer.

For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.

loadBalancerDescription_securityGroups :: Lens' LoadBalancerDescription (Maybe [Text]) Source #

The security groups for the load balancer. Valid only for load balancers in a VPC.

loadBalancerDescription_healthCheck :: Lens' LoadBalancerDescription (Maybe HealthCheck) Source #

Information about the health checks conducted on the load balancer.

loadBalancerDescription_createdTime :: Lens' LoadBalancerDescription (Maybe UTCTime) Source #

The date and time the load balancer was created.

loadBalancerDescription_vPCId :: Lens' LoadBalancerDescription (Maybe Text) Source #

The ID of the VPC for the load balancer.

loadBalancerDescription_subnets :: Lens' LoadBalancerDescription (Maybe [Text]) Source #

The IDs of the subnets for the load balancer.

loadBalancerDescription_availabilityZones :: Lens' LoadBalancerDescription (Maybe [Text]) Source #

The Availability Zones for the load balancer.

loadBalancerDescription_canonicalHostedZoneNameID :: Lens' LoadBalancerDescription (Maybe Text) Source #

The ID of the Amazon Route 53 hosted zone for the load balancer.

loadBalancerDescription_instances :: Lens' LoadBalancerDescription (Maybe [Instance]) Source #

The IDs of the instances for the load balancer.

loadBalancerDescription_scheme :: Lens' LoadBalancerDescription (Maybe Text) Source #

The type of load balancer. Valid only for load balancers in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

loadBalancerDescription_policies :: Lens' LoadBalancerDescription (Maybe Policies) Source #

The policies defined for the load balancer.

Policies

policies_otherPolicies :: Lens' Policies (Maybe [Text]) Source #

The policies other than the stickiness policies.

policies_lBCookieStickinessPolicies :: Lens' Policies (Maybe [LBCookieStickinessPolicy]) Source #

The stickiness policies created using CreateLBCookieStickinessPolicy.

policies_appCookieStickinessPolicies :: Lens' Policies (Maybe [AppCookieStickinessPolicy]) Source #

The stickiness policies created using CreateAppCookieStickinessPolicy.

PolicyAttribute

PolicyAttributeDescription

PolicyAttributeTypeDescription

policyAttributeTypeDescription_attributeType :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source #

The type of the attribute. For example, Boolean or Integer.

policyAttributeTypeDescription_cardinality :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source #

The cardinality of the attribute.

Valid values:

  • ONE(1) : Single value required
  • ZERO_OR_ONE(0..1) : Up to one value is allowed
  • ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
  • ONE_OR_MORE(1..*0) : Required. Multiple values are allowed

PolicyDescription

PolicyTypeDescription

policyTypeDescription_policyAttributeTypeDescriptions :: Lens' PolicyTypeDescription (Maybe [PolicyAttributeTypeDescription]) Source #

The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

SourceSecurityGroup

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The value of the tag.

tag_key :: Lens' Tag Text Source #

The key of the tag.

TagDescription

TagKeyOnly

tagKeyOnly_key :: Lens' TagKeyOnly (Maybe Text) Source #

The name of the key.