amazonka-elb-0.3.5: Amazon Elastic Load Balancing SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.ELB.Types

Contents

Synopsis

Service

data ELB Source

Version 2012-06-01 of the Amazon Elastic Load Balancing service.

Instances

AWSService ELB 
type Er ELB = RESTError 
type Sg ELB = V4 

Error

data RESTError :: *

Instances

Eq RESTError 
Show RESTError 
Generic RESTError 
AWSErrorCode RESTError 
FromXML RESTError 
type Rep RESTError = D1 D1RESTError (C1 C1_0RESTError ((:*:) ((:*:) (S1 S1_0_0RESTError (Rec0 Text)) (S1 S1_0_1RESTError (Rec0 (Maybe ErrorType)))) ((:*:) (S1 S1_0_2RESTError (Rec0 (Maybe ErrorCode))) (S1 S1_0_3RESTError (Rec0 Text))))) 

XML

ns :: Text Source

SourceSecurityGroup

data SourceSecurityGroup Source

Instances

sourceSecurityGroup :: SourceSecurityGroup Source

SourceSecurityGroup constructor.

The fields accessible through corresponding lenses are:

ssgGroupName :: Lens' SourceSecurityGroup (Maybe Text) Source

The name of the security group.

ssgOwnerAlias :: Lens' SourceSecurityGroup (Maybe Text) Source

The owner of the security group.

TagDescription

data TagDescription Source

Instances

tagDescription Source

Arguments

:: NonEmpty Tag

tdTags

-> TagDescription 

TagDescription constructor.

The fields accessible through corresponding lenses are:

tdLoadBalancerName :: Lens' TagDescription (Maybe Text) Source

The name of the load balancer.

tdTags :: Lens' TagDescription (NonEmpty Tag) Source

The tags.

Tag

data Tag Source

Instances

tag Source

Arguments

:: Text

tagKey

-> Tag 

Tag constructor.

The fields accessible through corresponding lenses are:

tagKey :: Lens' Tag Text Source

The key of the tag.

tagValue :: Lens' Tag (Maybe Text) Source

The value of the tag.

PolicyAttributeTypeDescription

data PolicyAttributeTypeDescription Source

Instances

policyAttributeTypeDescription :: PolicyAttributeTypeDescription Source

PolicyAttributeTypeDescription constructor.

The fields accessible through corresponding lenses are:

patdAttributeName :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source

The name of the attribute.

patdAttributeType :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source

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

patdCardinality :: 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 can be supplied ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed ONE_OR_MORE(1..*0) : Required. Multiple values are allowed

patdDefaultValue :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source

The default value of the attribute, if applicable.

patdDescription :: Lens' PolicyAttributeTypeDescription (Maybe Text) Source

A description of the attribute.

HealthCheck

data HealthCheck Source

Instances

healthCheck Source

Arguments

:: Text

hcTarget

-> Natural

hcInterval

-> Natural

hcTimeout

-> Natural

hcUnhealthyThreshold

-> Natural

hcHealthyThreshold

-> HealthCheck 

HealthCheck constructor.

The fields accessible through corresponding lenses are:

hcHealthyThreshold :: Lens' HealthCheck Natural Source

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

hcInterval :: Lens' HealthCheck Natural Source

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

hcTarget :: 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:80weatheruswaseattle". 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.

hcTimeout :: 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.

hcUnhealthyThreshold :: Lens' HealthCheck Natural Source

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

CrossZoneLoadBalancing

data CrossZoneLoadBalancing Source

Instances

crossZoneLoadBalancing Source

Arguments

:: Bool

czlbEnabled

-> CrossZoneLoadBalancing 

CrossZoneLoadBalancing constructor.

The fields accessible through corresponding lenses are:

czlbEnabled :: Lens' CrossZoneLoadBalancing Bool Source

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

LoadBalancerAttributes

data LoadBalancerAttributes Source

Instances

loadBalancerAttributes :: LoadBalancerAttributes Source

LoadBalancerAttributes constructor.

The fields accessible through corresponding lenses are:

lbaAccessLog :: 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 Elastic Load BalancingDeveloper Guide.

lbaAdditionalAttributes :: Lens' LoadBalancerAttributes [AdditionalAttribute] Source

This parameter is reserved.

lbaConnectionDraining :: 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 back-end instance.

For more information, see Enable Connection Draining in the Elastic LoadBalancing Developer Guide.

lbaConnectionSettings :: 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 ElasticLoad Balancing Developer Guide.

lbaCrossZoneLoadBalancing :: Lens' LoadBalancerAttributes (Maybe CrossZoneLoadBalancing) Source

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

For more information, see Enable Cross-Zone Load Balancing in the ElasticLoad Balancing Developer Guide.

AccessLog

data AccessLog Source

Instances

accessLog Source

Arguments

:: Bool

alEnabled

-> AccessLog 

AccessLog constructor.

The fields accessible through corresponding lenses are:

alEmitInterval :: 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

alEnabled :: Lens' AccessLog Bool Source

Specifies whether access log is enabled for the load balancer.

alS3BucketName :: Lens' AccessLog (Maybe Text) Source

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

alS3BucketPrefix :: 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.

ListenerDescription

data ListenerDescription Source

Instances

listenerDescription :: ListenerDescription Source

ListenerDescription constructor.

The fields accessible through corresponding lenses are:

ldListener :: Lens' ListenerDescription (Maybe Listener) Source

ldPolicyNames :: Lens' ListenerDescription [Text] Source

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

LBCookieStickinessPolicy

data LBCookieStickinessPolicy Source

Instances

lbcookieStickinessPolicy :: LBCookieStickinessPolicy Source

LBCookieStickinessPolicy constructor.

The fields accessible through corresponding lenses are:

lbcspCookieExpirationPeriod :: 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.

lbcspPolicyName :: Lens' LBCookieStickinessPolicy (Maybe Text) Source

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

PolicyDescription

data PolicyDescription Source

Instances

policyDescription :: PolicyDescription Source

PolicyDescription constructor.

The fields accessible through corresponding lenses are:

pdPolicyAttributeDescriptions :: Lens' PolicyDescription [PolicyAttributeDescription] Source

The policy attributes.

pdPolicyName :: Lens' PolicyDescription (Maybe Text) Source

The name of the policy.

pdPolicyTypeName :: Lens' PolicyDescription (Maybe Text) Source

The name of the policy type.

AppCookieStickinessPolicy

data AppCookieStickinessPolicy Source

Instances

appCookieStickinessPolicy :: AppCookieStickinessPolicy Source

AppCookieStickinessPolicy constructor.

The fields accessible through corresponding lenses are:

acspCookieName :: Lens' AppCookieStickinessPolicy (Maybe Text) Source

The name of the application cookie used for stickiness.

acspPolicyName :: 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.

PolicyAttribute

data PolicyAttribute Source

Instances

policyAttribute :: PolicyAttribute Source

PolicyAttribute constructor.

The fields accessible through corresponding lenses are:

paAttributeName :: Lens' PolicyAttribute (Maybe Text) Source

The name of the attribute.

paAttributeValue :: Lens' PolicyAttribute (Maybe Text) Source

The value of the attribute.

LoadBalancerDescription

data LoadBalancerDescription Source

Instances

loadBalancerDescription :: LoadBalancerDescription Source

LoadBalancerDescription constructor.

The fields accessible through corresponding lenses are:

lbdAvailabilityZones :: Lens' LoadBalancerDescription [Text] Source

The Availability Zones for the load balancer.

lbdBackendServerDescriptions :: Lens' LoadBalancerDescription [BackendServerDescription] Source

Information about the back-end servers.

lbdCanonicalHostedZoneName :: Lens' LoadBalancerDescription (Maybe Text) Source

The Amazon Route 53 hosted zone associated with the load balancer.

For more information, see Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

lbdCanonicalHostedZoneNameID :: Lens' LoadBalancerDescription (Maybe Text) Source

The ID of the Amazon Route 53 hosted zone name associated with the load balancer.

lbdCreatedTime :: Lens' LoadBalancerDescription (Maybe UTCTime) Source

The date and time the load balancer was created.

lbdDNSName :: Lens' LoadBalancerDescription (Maybe Text) Source

The external DNS name of the load balancer.

lbdHealthCheck :: Lens' LoadBalancerDescription (Maybe HealthCheck) Source

Information about the health checks conducted on the load balancer.

lbdInstances :: Lens' LoadBalancerDescription [Instance] Source

The IDs of the instances for the load balancer.

lbdListenerDescriptions :: Lens' LoadBalancerDescription [ListenerDescription] Source

The listeners for the load balancer.

lbdLoadBalancerName :: Lens' LoadBalancerDescription (Maybe Text) Source

The name of the load balancer.

lbdPolicies :: Lens' LoadBalancerDescription (Maybe Policies) Source

The policies defined for the load balancer.

lbdScheme :: 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.

lbdSecurityGroups :: Lens' LoadBalancerDescription [Text] Source

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

lbdSourceSecurityGroup :: Lens' LoadBalancerDescription (Maybe SourceSecurityGroup) Source

The security group that you can use as part of your inbound rules for your load balancer's back-end application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.

lbdSubnets :: Lens' LoadBalancerDescription [Text] Source

The IDs of the subnets for the load balancer.

lbdVPCId :: Lens' LoadBalancerDescription (Maybe Text) Source

The ID of the VPC for the load balancer.

BackendServerDescription

data BackendServerDescription Source

Instances

backendServerDescription :: BackendServerDescription Source

BackendServerDescription constructor.

The fields accessible through corresponding lenses are:

bsdInstancePort :: Lens' BackendServerDescription (Maybe Natural) Source

The port on which the back-end server is listening.

bsdPolicyNames :: Lens' BackendServerDescription [Text] Source

The names of the policies enabled for the back-end server.

PolicyAttributeDescription

data PolicyAttributeDescription Source

Instances

policyAttributeDescription :: PolicyAttributeDescription Source

PolicyAttributeDescription constructor.

The fields accessible through corresponding lenses are:

padAttributeName :: Lens' PolicyAttributeDescription (Maybe Text) Source

The name of the attribute.

padAttributeValue :: Lens' PolicyAttributeDescription (Maybe Text) Source

The value of the attribute.

AdditionalAttribute

data AdditionalAttribute Source

Instances

additionalAttribute :: AdditionalAttribute Source

AdditionalAttribute constructor.

The fields accessible through corresponding lenses are:

aaKey :: Lens' AdditionalAttribute (Maybe Text) Source

This parameter is reserved.

aaValue :: Lens' AdditionalAttribute (Maybe Text) Source

This parameter is reserved.

ConnectionSettings

data ConnectionSettings Source

Instances

connectionSettings Source

Arguments

:: Natural

csIdleTimeout

-> ConnectionSettings 

ConnectionSettings constructor.

The fields accessible through corresponding lenses are:

csIdleTimeout :: 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.

PolicyTypeDescription

data PolicyTypeDescription Source

Instances

policyTypeDescription :: PolicyTypeDescription Source

PolicyTypeDescription constructor.

The fields accessible through corresponding lenses are:

ptdDescription :: Lens' PolicyTypeDescription (Maybe Text) Source

A description of the policy type.

ptdPolicyAttributeTypeDescriptions :: Lens' PolicyTypeDescription [PolicyAttributeTypeDescription] Source

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

ptdPolicyTypeName :: Lens' PolicyTypeDescription (Maybe Text) Source

The name of the policy type.

Policies

data Policies Source

Instances

policies :: Policies Source

Policies constructor.

The fields accessible through corresponding lenses are:

pAppCookieStickinessPolicies :: Lens' Policies [AppCookieStickinessPolicy] Source

The stickiness policies created using CreateAppCookieStickinessPolicy.

pLBCookieStickinessPolicies :: Lens' Policies [LBCookieStickinessPolicy] Source

The stickiness policies created using CreateLBCookieStickinessPolicy.

pOtherPolicies :: Lens' Policies [Text] Source

The policies other than the stickiness policies.

Listener

data Listener Source

Instances

listener Source

Arguments

:: Text

lProtocol

-> Int

lLoadBalancerPort

-> Natural

lInstancePort

-> Listener 

Listener constructor.

The fields accessible through corresponding lenses are:

lInstancePort :: Lens' Listener Natural Source

The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

lInstanceProtocol :: Lens' Listener (Maybe Text) Source

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

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

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.

lLoadBalancerPort :: Lens' Listener Int Source

The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

lProtocol :: Lens' Listener Text Source

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

lSSLCertificateId :: Lens' Listener (Maybe Text) Source

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

ConnectionDraining

data ConnectionDraining Source

Instances

connectionDraining Source

Arguments

:: Bool

cdEnabled

-> ConnectionDraining 

ConnectionDraining constructor.

The fields accessible through corresponding lenses are:

cdEnabled :: Lens' ConnectionDraining Bool Source

Specifies whether connection draining is enabled for the load balancer.

cdTimeout :: Lens' ConnectionDraining (Maybe Int) Source

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

InstanceState

data InstanceState Source

Instances

instanceState :: InstanceState Source

InstanceState constructor.

The fields accessible through corresponding lenses are:

isDescription :: 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 healthchecks consecutively.'

'Instance has not passed the configured HealthyThreshold number of healthchecks consecutively.'

'Instance registration is still in progress.'

'Instance is in the EC2 Availability Zone for which LoadBalancer is notconfigured 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.'

isInstanceId :: Lens' InstanceState (Maybe Text) Source

The ID of the instance.

isReasonCode :: 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'

isState :: Lens' InstanceState (Maybe Text) Source

The current state of the instance.

Valid values: InService | OutOfService | Unknown

TagKeyOnly

data TagKeyOnly Source

Instances

tagKeyOnly :: TagKeyOnly Source

TagKeyOnly constructor.

The fields accessible through corresponding lenses are:

tkoKey :: Lens' TagKeyOnly (Maybe Text) Source

The name of the key.

Instance

data Instance Source

Instances

instance' :: Instance Source

Instance constructor.

The fields accessible through corresponding lenses are:

iInstanceId :: Lens' Instance (Maybe Text) Source

The ID of the instance.