libZSservicesZSamazonka-elbv2ZSamazonka-elbv2
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.ELBV2.Lens

Description

 
Synopsis

Operations

DescribeLoadBalancers

describeLoadBalancers_loadBalancerArns :: Lens' DescribeLoadBalancers (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

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.

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

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

DescribeTags

describeTags_resourceArns :: Lens' DescribeTags [Text] Source #

The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.

DeleteRule

deleteRule_ruleArn :: Lens' DeleteRule Text Source #

The Amazon Resource Name (ARN) of the rule.

RemoveTags

removeTags_resourceArns :: Lens' RemoveTags [Text] Source #

The Amazon Resource Name (ARN) of the resource.

removeTags_tagKeys :: Lens' RemoveTags [Text] Source #

The tag keys for the tags to remove.

DeleteTargetGroup

deleteTargetGroup_targetGroupArn :: Lens' DeleteTargetGroup Text Source #

The Amazon Resource Name (ARN) of the target group.

SetSubnets

setSubnets_subnetMappings :: Lens' SetSubnets (Maybe [SubnetMapping]) Source #

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

Application Load Balancers
You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
Application Load Balancers on Outposts
You must specify one Outpost subnet.
Application Load Balancers on Local Zones
You can specify subnets from one or more Local Zones.
Network Load Balancers
You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

setSubnets_subnets :: Lens' SetSubnets (Maybe [Text]) Source #

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

Application Load Balancers
You must specify subnets from at least two Availability Zones.
Application Load Balancers on Outposts
You must specify one Outpost subnet.
Application Load Balancers on Local Zones
You can specify subnets from one or more Local Zones.
Network Load Balancers
You can specify subnets from one or more Availability Zones.

setSubnets_ipAddressType :: Lens' SetSubnets (Maybe IpAddressType) Source #

Network Load Balancers
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener. Internal load balancers must use ipv4.

setSubnets_loadBalancerArn :: Lens' SetSubnets Text Source #

The Amazon Resource Name (ARN) of the load balancer.

CreateRule

createRule_tags :: Lens' CreateRule (Maybe (NonEmpty Tag)) Source #

The tags to assign to the rule.

createRule_listenerArn :: Lens' CreateRule Text Source #

The Amazon Resource Name (ARN) of the listener.

createRule_priority :: Lens' CreateRule Natural Source #

The rule priority. A listener can't have multiple rules with the same priority.

DescribeListenerCertificates

describeListenerCertificates_marker :: Lens' DescribeListenerCertificates (Maybe Text) Source #

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

describeListenerCertificates_pageSize :: Lens' DescribeListenerCertificates (Maybe Natural) Source #

The maximum number of results to return with this call.

describeListenerCertificates_listenerArn :: Lens' DescribeListenerCertificates Text Source #

The Amazon Resource Names (ARN) of the listener.

describeListenerCertificatesResponse_nextMarker :: Lens' DescribeListenerCertificatesResponse (Maybe Text) Source #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

SetSecurityGroups

setSecurityGroups_loadBalancerArn :: Lens' SetSecurityGroups Text Source #

The Amazon Resource Name (ARN) of the load balancer.

setSecurityGroupsResponse_securityGroupIds :: Lens' SetSecurityGroupsResponse (Maybe [Text]) Source #

The IDs of the security groups associated with the load balancer.

SetRulePriorities

DescribeTargetGroups

describeTargetGroups_targetGroupArns :: Lens' DescribeTargetGroups (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the target groups.

describeTargetGroups_loadBalancerArn :: Lens' DescribeTargetGroups (Maybe Text) Source #

The Amazon Resource Name (ARN) of the load balancer.

describeTargetGroups_marker :: Lens' DescribeTargetGroups (Maybe Text) Source #

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

describeTargetGroups_pageSize :: Lens' DescribeTargetGroups (Maybe Natural) Source #

The maximum number of results to return with this call.

describeTargetGroupsResponse_nextMarker :: Lens' DescribeTargetGroupsResponse (Maybe Text) Source #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

DescribeRules

describeRules_listenerArn :: Lens' DescribeRules (Maybe Text) Source #

The Amazon Resource Name (ARN) of the listener.

describeRules_marker :: Lens' DescribeRules (Maybe Text) Source #

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

describeRules_ruleArns :: Lens' DescribeRules (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the rules.

describeRules_pageSize :: Lens' DescribeRules (Maybe Natural) Source #

The maximum number of results to return with this call.

describeRulesResponse_nextMarker :: Lens' DescribeRulesResponse (Maybe Text) Source #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

DeleteLoadBalancer

deleteLoadBalancer_loadBalancerArn :: Lens' DeleteLoadBalancer Text Source #

The Amazon Resource Name (ARN) of the load balancer.

RegisterTargets

registerTargets_targetGroupArn :: Lens' RegisterTargets Text Source #

The Amazon Resource Name (ARN) of the target group.

ModifyListener

modifyListener_sslPolicy :: Lens' ModifyListener (Maybe Text) Source #

HTTPS and TLS listeners
The security policy that defines which protocols and ciphers are supported.

For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.

modifyListener_protocol :: Lens' ModifyListener (Maybe ProtocolEnum) Source #

The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.

modifyListener_defaultActions :: Lens' ModifyListener (Maybe [Action]) Source #

The actions for the default rule.

modifyListener_certificates :: Lens' ModifyListener (Maybe [Certificate]) Source #

HTTPS and TLS listeners
The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

modifyListener_alpnPolicy :: Lens' ModifyListener (Maybe [Text]) Source #

TLS listeners
The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
  • HTTP1Only
  • HTTP2Only
  • HTTP2Optional
  • HTTP2Preferred
  • None

For more information, see ALPN policies in the Network Load Balancers Guide.

modifyListener_port :: Lens' ModifyListener (Maybe Natural) Source #

The port for connections from clients to the load balancer. You cannot specify a port for a Gateway Load Balancer.

modifyListener_listenerArn :: Lens' ModifyListener Text Source #

The Amazon Resource Name (ARN) of the listener.

modifyListenerResponse_listeners :: Lens' ModifyListenerResponse (Maybe [Listener]) Source #

Information about the modified listener.

ModifyTargetGroup

modifyTargetGroup_matcher :: Lens' ModifyTargetGroup (Maybe Matcher) Source #

HTTP/HTTPS health checks
The HTTP or gRPC codes to use when checking for a successful response from a target.

With Network Load Balancers, you can't modify this setting.

modifyTargetGroup_healthCheckPath :: Lens' ModifyTargetGroup (Maybe Text) Source #

HTTP/HTTPS health checks
The destination for health checks on the targets.
HTTP1 or HTTP2 protocol version
The ping path. The default is /.
GRPC protocol version
The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

modifyTargetGroup_healthCheckEnabled :: Lens' ModifyTargetGroup (Maybe Bool) Source #

Indicates whether health checks are enabled.

modifyTargetGroup_unhealthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural) Source #

The number of consecutive health check failures required before considering the target unhealthy. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.

modifyTargetGroup_healthCheckIntervalSeconds :: Lens' ModifyTargetGroup (Maybe Natural) Source #

The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 or 30 seconds.

With Network Load Balancers, you can't modify this setting.

modifyTargetGroup_healthyThresholdCount :: Lens' ModifyTargetGroup (Maybe Natural) Source #

The number of consecutive health checks successes required before considering an unhealthy target healthy.

modifyTargetGroup_healthCheckProtocol :: Lens' ModifyTargetGroup (Maybe ProtocolEnum) Source #

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

With Network Load Balancers, you can't modify this setting.

modifyTargetGroup_healthCheckTimeoutSeconds :: Lens' ModifyTargetGroup (Maybe Natural) Source #

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

With Network Load Balancers, you can't modify this setting.

modifyTargetGroup_healthCheckPort :: Lens' ModifyTargetGroup (Maybe Text) Source #

The port the load balancer uses when performing health checks on targets.

modifyTargetGroup_targetGroupArn :: Lens' ModifyTargetGroup Text Source #

The Amazon Resource Name (ARN) of the target group.

ModifyTargetGroupAttributes

modifyTargetGroupAttributes_targetGroupArn :: Lens' ModifyTargetGroupAttributes Text Source #

The Amazon Resource Name (ARN) of the target group.

DescribeTargetGroupAttributes

DeleteListener

deleteListener_listenerArn :: Lens' DeleteListener Text Source #

The Amazon Resource Name (ARN) of the listener.

DescribeSSLPolicies

describeSSLPolicies_loadBalancerType :: Lens' DescribeSSLPolicies (Maybe LoadBalancerTypeEnum) Source #

The type of load balancer. The default lists the SSL policies for all load balancers.

describeSSLPolicies_marker :: Lens' DescribeSSLPolicies (Maybe Text) Source #

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

describeSSLPolicies_pageSize :: Lens' DescribeSSLPolicies (Maybe Natural) Source #

The maximum number of results to return with this call.

describeSSLPoliciesResponse_nextMarker :: Lens' DescribeSSLPoliciesResponse (Maybe Text) Source #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

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 #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

DeregisterTargets

deregisterTargets_targetGroupArn :: Lens' DeregisterTargets Text Source #

The Amazon Resource Name (ARN) of the target group.

deregisterTargets_targets :: Lens' DeregisterTargets [TargetDescription] Source #

The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

CreateListener

createListener_sslPolicy :: Lens' CreateListener (Maybe Text) Source #

HTTPS and TLS listeners
The security policy that defines which protocols and ciphers are supported.

For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.

createListener_protocol :: Lens' CreateListener (Maybe ProtocolEnum) Source #

The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.

createListener_certificates :: Lens' CreateListener (Maybe [Certificate]) Source #

HTTPS and TLS listeners
The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

createListener_alpnPolicy :: Lens' CreateListener (Maybe [Text]) Source #

TLS listeners
The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
  • HTTP1Only
  • HTTP2Only
  • HTTP2Optional
  • HTTP2Preferred
  • None

For more information, see ALPN policies in the Network Load Balancers Guide.

createListener_tags :: Lens' CreateListener (Maybe (NonEmpty Tag)) Source #

The tags to assign to the listener.

createListener_port :: Lens' CreateListener (Maybe Natural) Source #

The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.

createListener_loadBalancerArn :: Lens' CreateListener Text Source #

The Amazon Resource Name (ARN) of the load balancer.

createListener_defaultActions :: Lens' CreateListener [Action] Source #

The actions for the default rule.

CreateTargetGroup

createTargetGroup_protocolVersion :: Lens' CreateTargetGroup (Maybe Text) Source #

HTTP/HTTPS protocol
The protocol version. Specify GRPC to send requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The default is HTTP1, which sends requests to targets using HTTP/1.1.

createTargetGroup_matcher :: Lens' CreateTargetGroup (Maybe Matcher) Source #

HTTP/HTTPS health checks
The HTTP or gRPC codes to use when checking for a successful response from a target.

createTargetGroup_healthCheckPath :: Lens' CreateTargetGroup (Maybe Text) Source #

HTTP/HTTPS health checks
The destination for health checks on the targets.
HTTP1 or HTTP2 protocol version
The ping path. The default is /.
GRPC protocol version
The path of a custom health check method with the format /package.service/method. The default is /Amazon Web Services.ALB/healthcheck.

createTargetGroup_healthCheckEnabled :: Lens' CreateTargetGroup (Maybe Bool) Source #

Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.

createTargetGroup_unhealthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural) Source #

The number of consecutive health check failures required before considering a target unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If the target group protocol is GENEVE, the default is 3. If the target type is lambda, the default is 2.

createTargetGroup_vpcId :: Lens' CreateTargetGroup (Maybe Text) Source #

The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

createTargetGroup_protocol :: Lens' CreateTargetGroup (Maybe ProtocolEnum) Source #

The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

createTargetGroup_healthCheckIntervalSeconds :: Lens' CreateTargetGroup (Maybe Natural) Source #

The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is 35 seconds.

createTargetGroup_targetType :: Lens' CreateTargetGroup (Maybe TargetTypeEnum) Source #

The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.

  • instance - Register targets by instance ID. This is the default value.
  • ip - Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
  • lambda - Register a single Lambda function as a target.
  • alb - Register a single Application Load Balancer as a target.

createTargetGroup_healthyThresholdCount :: Lens' CreateTargetGroup (Maybe Natural) Source #

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is lambda, the default is 5.

createTargetGroup_healthCheckProtocol :: Lens' CreateTargetGroup (Maybe ProtocolEnum) Source #

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

createTargetGroup_ipAddressType :: Lens' CreateTargetGroup (Maybe TargetGroupIpAddressTypeEnum) Source #

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

createTargetGroup_healthCheckTimeoutSeconds :: Lens' CreateTargetGroup (Maybe Natural) Source #

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

createTargetGroup_healthCheckPort :: Lens' CreateTargetGroup (Maybe Text) Source #

The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port, which is the port on which each target receives traffic from the load balancer. If the protocol is GENEVE, the default is port 80.

createTargetGroup_tags :: Lens' CreateTargetGroup (Maybe (NonEmpty Tag)) Source #

The tags to assign to the target group.

createTargetGroup_port :: Lens' CreateTargetGroup (Maybe Natural) Source #

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.

createTargetGroup_name :: Lens' CreateTargetGroup Text Source #

The name of the target group.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

ModifyLoadBalancerAttributes

modifyLoadBalancerAttributes_loadBalancerArn :: Lens' ModifyLoadBalancerAttributes Text Source #

The Amazon Resource Name (ARN) of the load balancer.

SetIpAddressType

setIpAddressType_loadBalancerArn :: Lens' SetIpAddressType Text Source #

The Amazon Resource Name (ARN) of the load balancer.

setIpAddressType_ipAddressType :: Lens' SetIpAddressType IpAddressType Source #

The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. You can’t specify dualstack for a load balancer with a UDP or TCP_UDP listener.

AddTags

addTags_resourceArns :: Lens' AddTags [Text] Source #

The Amazon Resource Name (ARN) of the resource.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.

DescribeLoadBalancerAttributes

DescribeListeners

describeListeners_listenerArns :: Lens' DescribeListeners (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the listeners.

describeListeners_loadBalancerArn :: Lens' DescribeListeners (Maybe Text) Source #

The Amazon Resource Name (ARN) of the load balancer.

describeListeners_marker :: Lens' DescribeListeners (Maybe Text) Source #

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

describeListeners_pageSize :: Lens' DescribeListeners (Maybe Natural) Source #

The maximum number of results to return with this call.

describeListenersResponse_nextMarker :: Lens' DescribeListenersResponse (Maybe Text) Source #

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

DescribeTargetHealth

describeTargetHealth_targetGroupArn :: Lens' DescribeTargetHealth Text Source #

The Amazon Resource Name (ARN) of the target group.

CreateLoadBalancer

createLoadBalancer_subnetMappings :: Lens' CreateLoadBalancer (Maybe [SubnetMapping]) Source #

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

Application Load Balancers
You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
Application Load Balancers on Outposts
You must specify one Outpost subnet.
Application Load Balancers on Local Zones
You can specify subnets from one or more Local Zones.
Network Load Balancers
You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
Gateway Load Balancers
You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.

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

Application Load Balancers
The IDs of the security groups for the load balancer.

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

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

Application Load Balancers
You must specify subnets from at least two Availability Zones.
Application Load Balancers on Outposts
You must specify one Outpost subnet.
Application Load Balancers on Local Zones
You can specify subnets from one or more Local Zones.
Network Load Balancers
You can specify subnets from one or more Availability Zones.
Gateway Load Balancers
You can specify subnets from one or more Availability Zones.

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

Application Load Balancers on Outposts
The ID of the customer-owned address pool (CoIP pool).

createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType) Source #

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

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

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

You cannot specify a scheme for a Gateway Load Balancer.

createLoadBalancer_type :: Lens' CreateLoadBalancer (Maybe LoadBalancerTypeEnum) Source #

The type of load balancer. The default is application.

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

The tags to assign to the load balancer.

createLoadBalancer_name :: Lens' CreateLoadBalancer Text Source #

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

RemoveListenerCertificates

removeListenerCertificates_listenerArn :: Lens' RemoveListenerCertificates Text Source #

The Amazon Resource Name (ARN) of the listener.

removeListenerCertificates_certificates :: Lens' RemoveListenerCertificates [Certificate] Source #

The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

ModifyRule

modifyRule_ruleArn :: Lens' ModifyRule Text Source #

The Amazon Resource Name (ARN) of the rule.

modifyRuleResponse_rules :: Lens' ModifyRuleResponse (Maybe [Rule]) Source #

Information about the modified rule.

AddListenerCertificates

addListenerCertificates_listenerArn :: Lens' AddListenerCertificates Text Source #

The Amazon Resource Name (ARN) of the listener.

addListenerCertificates_certificates :: Lens' AddListenerCertificates [Certificate] Source #

The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

addListenerCertificatesResponse_certificates :: Lens' AddListenerCertificatesResponse (Maybe [Certificate]) Source #

Information about the certificates in the certificate list.

Types

Action

action_fixedResponseConfig :: Lens' Action (Maybe FixedResponseActionConfig) Source #

Application Load Balancer
Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

action_targetGroupArn :: Lens' Action (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

action_forwardConfig :: Lens' Action (Maybe ForwardActionConfig) Source #

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

action_redirectConfig :: Lens' Action (Maybe RedirectActionConfig) Source #

Application Load Balancer
Information for creating a redirect action. Specify only when Type is redirect.

action_authenticateCognitoConfig :: Lens' Action (Maybe AuthenticateCognitoActionConfig) Source #

HTTPS listeners
Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

action_order :: Lens' Action (Maybe Natural) Source #

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

action_authenticateOidcConfig :: Lens' Action (Maybe AuthenticateOidcActionConfig) Source #

HTTPS listeners
Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

AuthenticateCognitoActionConfig

authenticateCognitoActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateCognitoActionConfig (Maybe (HashMap Text Text)) Source #

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

authenticateCognitoActionConfig_scope :: Lens' AuthenticateCognitoActionConfig (Maybe Text) Source #

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

authenticateCognitoActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateCognitoActionConfig (Maybe AuthenticateCognitoActionConditionalBehaviorEnum) Source #

The behavior if the user is not authenticated. The following are possible values:

  • deny@@ - Return an HTTP 401 Unauthorized error.
  • allow@@ - Allow the request to be forwarded to the target.
  • authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.

authenticateCognitoActionConfig_sessionCookieName :: Lens' AuthenticateCognitoActionConfig (Maybe Text) Source #

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

authenticateCognitoActionConfig_sessionTimeout :: Lens' AuthenticateCognitoActionConfig (Maybe Integer) Source #

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

authenticateCognitoActionConfig_userPoolArn :: Lens' AuthenticateCognitoActionConfig Text Source #

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

authenticateCognitoActionConfig_userPoolDomain :: Lens' AuthenticateCognitoActionConfig Text Source #

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

AuthenticateOidcActionConfig

authenticateOidcActionConfig_clientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

authenticateOidcActionConfig_useExistingClientSecret :: Lens' AuthenticateOidcActionConfig (Maybe Bool) Source #

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

authenticateOidcActionConfig_authenticationRequestExtraParams :: Lens' AuthenticateOidcActionConfig (Maybe (HashMap Text Text)) Source #

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

authenticateOidcActionConfig_scope :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

authenticateOidcActionConfig_onUnauthenticatedRequest :: Lens' AuthenticateOidcActionConfig (Maybe AuthenticateOidcActionConditionalBehaviorEnum) Source #

The behavior if the user is not authenticated. The following are possible values:

  • deny@@ - Return an HTTP 401 Unauthorized error.
  • allow@@ - Allow the request to be forwarded to the target.
  • authenticate@@ - Redirect the request to the IdP authorization endpoint. This is the default value.

authenticateOidcActionConfig_sessionCookieName :: Lens' AuthenticateOidcActionConfig (Maybe Text) Source #

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

authenticateOidcActionConfig_sessionTimeout :: Lens' AuthenticateOidcActionConfig (Maybe Integer) Source #

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

authenticateOidcActionConfig_issuer :: Lens' AuthenticateOidcActionConfig Text Source #

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

authenticateOidcActionConfig_authorizationEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

authenticateOidcActionConfig_tokenEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #

The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

authenticateOidcActionConfig_userInfoEndpoint :: Lens' AuthenticateOidcActionConfig Text Source #

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

AvailabilityZone

availabilityZone_subnetId :: Lens' AvailabilityZone (Maybe Text) Source #

The ID of the subnet. You can specify one subnet per Availability Zone.

availabilityZone_zoneName :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the Availability Zone.

availabilityZone_loadBalancerAddresses :: Lens' AvailabilityZone (Maybe [LoadBalancerAddress]) Source #

Network Load Balancers
If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.

availabilityZone_outpostId :: Lens' AvailabilityZone (Maybe Text) Source #

Application Load Balancers on Outposts
The ID of the Outpost.

Certificate

certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the certificate.

certificate_isDefault :: Lens' Certificate (Maybe Bool) Source #

Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

Cipher

cipher_priority :: Lens' Cipher (Maybe Int) Source #

The priority of the cipher.

cipher_name :: Lens' Cipher (Maybe Text) Source #

The name of the cipher.

FixedResponseActionConfig

fixedResponseActionConfig_contentType :: Lens' FixedResponseActionConfig (Maybe Text) Source #

The content type.

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

ForwardActionConfig

forwardActionConfig_targetGroups :: Lens' ForwardActionConfig (Maybe [TargetGroupTuple]) Source #

One or more target groups. For Network Load Balancers, you can specify a single target group.

HostHeaderConditionConfig

hostHeaderConditionConfig_values :: Lens' HostHeaderConditionConfig (Maybe [Text]) Source #

One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.

HttpHeaderConditionConfig

httpHeaderConditionConfig_values :: Lens' HttpHeaderConditionConfig (Maybe [Text]) Source #

One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If the same header appears multiple times in the request, we search them in order until a match is found.

If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.

httpHeaderConditionConfig_httpHeaderName :: Lens' HttpHeaderConditionConfig (Maybe Text) Source #

The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.

You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.

HttpRequestMethodConditionConfig

httpRequestMethodConditionConfig_values :: Lens' HttpRequestMethodConditionConfig (Maybe [Text]) Source #

The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.

If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.

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:

  • application-load-balancers
  • condition-values-per-alb-rule
  • condition-wildcards-per-alb-rule
  • gateway-load-balancers
  • gateway-load-balancers-per-vpc
  • geneve-target-groups
  • listeners-per-application-load-balancer
  • listeners-per-network-load-balancer
  • network-load-balancers
  • rules-per-application-load-balancer
  • target-groups
  • target-groups-per-action-on-application-load-balancer
  • target-groups-per-action-on-network-load-balancer
  • target-groups-per-application-load-balancer
  • targets-per-application-load-balancer
  • targets-per-availability-zone-per-gateway-load-balancer
  • targets-per-availability-zone-per-network-load-balancer
  • targets-per-network-load-balancer

Listener

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

HTTPS or TLS listener
The security policy that defines which protocols and ciphers are supported.

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

The Amazon Resource Name (ARN) of the listener.

listener_protocol :: Lens' Listener (Maybe ProtocolEnum) Source #

The protocol for connections from clients to the load balancer.

listener_defaultActions :: Lens' Listener (Maybe [Action]) Source #

The default actions for the listener.

listener_certificates :: Lens' Listener (Maybe [Certificate]) Source #

HTTPS or TLS listener
The default certificate for the listener.

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

The Amazon Resource Name (ARN) of the load balancer.

listener_alpnPolicy :: Lens' Listener (Maybe [Text]) Source #

TLS listener
The name of the Application-Layer Protocol Negotiation (ALPN) policy.

listener_port :: Lens' Listener (Maybe Natural) Source #

The port on which the load balancer is listening.

LoadBalancer

loadBalancer_securityGroups :: Lens' LoadBalancer (Maybe [Text]) Source #

The IDs of the security groups for the load balancer.

loadBalancer_createdTime :: Lens' LoadBalancer (Maybe UTCTime) Source #

The date and time the load balancer was created.

loadBalancer_vpcId :: Lens' LoadBalancer (Maybe Text) Source #

The ID of the VPC for the load balancer.

loadBalancer_canonicalHostedZoneId :: Lens' LoadBalancer (Maybe Text) Source #

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

loadBalancer_customerOwnedIpv4Pool :: Lens' LoadBalancer (Maybe Text) Source #

Application Load Balancers on Outposts
The ID of the customer-owned address pool.

loadBalancer_loadBalancerArn :: Lens' LoadBalancer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the load balancer.

loadBalancer_ipAddressType :: Lens' LoadBalancer (Maybe IpAddressType) Source #

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

loadBalancer_scheme :: Lens' LoadBalancer (Maybe LoadBalancerSchemeEnum) Source #

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

loadBalancer_dNSName :: Lens' LoadBalancer (Maybe Text) Source #

The public DNS name of the load balancer.

LoadBalancerAddress

loadBalancerAddress_iPv6Address :: Lens' LoadBalancerAddress (Maybe Text) Source #

Network Load Balancers
The IPv6 address.

loadBalancerAddress_allocationId :: Lens' LoadBalancerAddress (Maybe Text) Source #

Network Load Balancers
The allocation ID of the Elastic IP address for an internal-facing load balancer.

loadBalancerAddress_privateIPv4Address :: Lens' LoadBalancerAddress (Maybe Text) Source #

Network Load Balancers
The private IPv4 address for an internal load balancer.

LoadBalancerAttribute

loadBalancerAttribute_key :: Lens' LoadBalancerAttribute (Maybe Text) Source #

The name of the attribute.

The following attribute is supported by all load balancers:

  • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

  • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
  • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
  • access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.

The following attributes are supported by only Application Load Balancers:

  • idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
  • routing.http.desync_mitigation_mode - 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.
  • routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
  • routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.
  • routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.
  • routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
  • waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.

The following attribute is supported by Network Load Balancers and Gateway Load Balancers:

  • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default is false.

LoadBalancerState

loadBalancerState_code :: Lens' LoadBalancerState (Maybe LoadBalancerStateEnum) Source #

The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If load balancer is routing traffic but does not have the resources it needs to scale, its state isactive_impaired. If the load balancer could not be set up, its state is failed.

Matcher

matcher_httpCode :: Lens' Matcher (Maybe Text) Source #

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

For Network Load Balancers and Gateway Load Balancers, this must be "200–399".

Note that when using shorthand syntax, some values such as commas need to be escaped.

matcher_grpcCode :: Lens' Matcher (Maybe Text) Source #

You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5"). The default value is 12.

PathPatternConditionConfig

pathPatternConditionConfig_values :: Lens' PathPatternConditionConfig (Maybe [Text]) Source #

One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.

QueryStringConditionConfig

queryStringConditionConfig_values :: Lens' QueryStringConditionConfig (Maybe [QueryStringKeyValuePair]) Source #

One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\' character.

If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.

QueryStringKeyValuePair

RedirectActionConfig

redirectActionConfig_path :: Lens' RedirectActionConfig (Maybe Text) Source #

The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

redirectActionConfig_protocol :: Lens' RedirectActionConfig (Maybe Text) Source #

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

redirectActionConfig_query :: Lens' RedirectActionConfig (Maybe Text) Source #

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

redirectActionConfig_host :: Lens' RedirectActionConfig (Maybe Text) Source #

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

redirectActionConfig_port :: Lens' RedirectActionConfig (Maybe Text) Source #

The port. You can specify a value from 1 to 65535 or #{port}.

redirectActionConfig_statusCode :: Lens' RedirectActionConfig RedirectActionStatusCodeEnum Source #

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

Rule

rule_actions :: Lens' Rule (Maybe [Action]) Source #

The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.

rule_conditions :: Lens' Rule (Maybe [RuleCondition]) Source #

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

rule_ruleArn :: Lens' Rule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

rule_isDefault :: Lens' Rule (Maybe Bool) Source #

Indicates whether this is the default rule.

RuleCondition

ruleCondition_field :: Lens' RuleCondition (Maybe Text) Source #

The field in the HTTP request. The following are the possible values:

  • http-header
  • http-request-method
  • host-header
  • path-pattern
  • query-string
  • source-ip

ruleCondition_httpHeaderConfig :: Lens' RuleCondition (Maybe HttpHeaderConditionConfig) Source #

Information for an HTTP header condition. Specify only when Field is http-header.

ruleCondition_hostHeaderConfig :: Lens' RuleCondition (Maybe HostHeaderConditionConfig) Source #

Information for a host header condition. Specify only when Field is host-header.

ruleCondition_values :: Lens' RuleCondition (Maybe [Text]) Source #

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9
  • - .
  • * (matches 0 or more characters)
  • ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9
  • _ - . $ / ~ " ' @ : +
  • & (using &amp;)
  • * (matches 0 or more characters)
  • ? (matches exactly 1 character)

ruleCondition_sourceIpConfig :: Lens' RuleCondition (Maybe SourceIpConditionConfig) Source #

Information for a source IP condition. Specify only when Field is source-ip.

ruleCondition_httpRequestMethodConfig :: Lens' RuleCondition (Maybe HttpRequestMethodConditionConfig) Source #

Information for an HTTP method condition. Specify only when Field is http-request-method.

ruleCondition_pathPatternConfig :: Lens' RuleCondition (Maybe PathPatternConditionConfig) Source #

Information for a path pattern condition. Specify only when Field is path-pattern.

ruleCondition_queryStringConfig :: Lens' RuleCondition (Maybe QueryStringConditionConfig) Source #

Information for a query string condition. Specify only when Field is query-string.

RulePriorityPair

rulePriorityPair_ruleArn :: Lens' RulePriorityPair (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

SourceIpConditionConfig

sourceIpConditionConfig_values :: Lens' SourceIpConditionConfig (Maybe [Text]) Source #

One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.

If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.

SslPolicy

sslPolicy_name :: Lens' SslPolicy (Maybe Text) Source #

The name of the policy.

SubnetMapping

subnetMapping_iPv6Address :: Lens' SubnetMapping (Maybe Text) Source #

Network Load Balancers
The IPv6 address.

subnetMapping_allocationId :: Lens' SubnetMapping (Maybe Text) Source #

Network Load Balancers
The allocation ID of the Elastic IP address for an internet-facing load balancer.

subnetMapping_privateIPv4Address :: Lens' SubnetMapping (Maybe Text) Source #

Network Load Balancers
The private IPv4 address for an internal load balancer.

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

tagDescription_resourceArn :: Lens' TagDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

tagDescription_tags :: Lens' TagDescription (Maybe (NonEmpty Tag)) Source #

Information about the tags.

TargetDescription

targetDescription_availabilityZone :: Lens' TargetDescription (Maybe Text) Source #

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance or alb.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

targetDescription_port :: Lens' TargetDescription (Maybe Natural) Source #

The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.

targetDescription_id :: Lens' TargetDescription Text Source #

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

TargetGroup

targetGroup_protocolVersion :: Lens' TargetGroup (Maybe Text) Source #

HTTP/HTTPS protocol
The protocol version. The possible values are GRPC, HTTP1, and HTTP2.

targetGroup_matcher :: Lens' TargetGroup (Maybe Matcher) Source #

The HTTP or gRPC codes to use when checking for a successful response from a target.

targetGroup_healthCheckPath :: Lens' TargetGroup (Maybe Text) Source #

The destination for health checks on the targets.

targetGroup_healthCheckEnabled :: Lens' TargetGroup (Maybe Bool) Source #

Indicates whether health checks are enabled.

targetGroup_unhealthyThresholdCount :: Lens' TargetGroup (Maybe Natural) Source #

The number of consecutive health check failures required before considering the target unhealthy.

targetGroup_vpcId :: Lens' TargetGroup (Maybe Text) Source #

The ID of the VPC for the targets.

targetGroup_targetGroupArn :: Lens' TargetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target group.

targetGroup_protocol :: Lens' TargetGroup (Maybe ProtocolEnum) Source #

The protocol to use for routing traffic to the targets.

targetGroup_healthCheckIntervalSeconds :: Lens' TargetGroup (Maybe Natural) Source #

The approximate amount of time, in seconds, between health checks of an individual target.

targetGroup_targetType :: Lens' TargetGroup (Maybe TargetTypeEnum) Source #

The type of target that you must specify when registering targets with this target group. The possible values are instance (register targets by instance ID), ip (register targets by IP address), lambda (register a single Lambda function as a target), or alb (register a single Application Load Balancer as a target).

targetGroup_healthyThresholdCount :: Lens' TargetGroup (Maybe Natural) Source #

The number of consecutive health checks successes required before considering an unhealthy target healthy.

targetGroup_healthCheckProtocol :: Lens' TargetGroup (Maybe ProtocolEnum) Source #

The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.

targetGroup_loadBalancerArns :: Lens' TargetGroup (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

targetGroup_ipAddressType :: Lens' TargetGroup (Maybe TargetGroupIpAddressTypeEnum) Source #

The type of IP address used for this target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

targetGroup_healthCheckTimeoutSeconds :: Lens' TargetGroup (Maybe Natural) Source #

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

targetGroup_healthCheckPort :: Lens' TargetGroup (Maybe Text) Source #

The port to use to connect with the target.

targetGroup_targetGroupName :: Lens' TargetGroup (Maybe Text) Source #

The name of the target group.

targetGroup_port :: Lens' TargetGroup (Maybe Natural) Source #

The port on which the targets are listening. Not used if the target is a Lambda function.

TargetGroupAttribute

targetGroupAttribute_key :: Lens' TargetGroupAttribute (Maybe Text) Source #

The name of the attribute.

The following attribute is supported by all load balancers:

  • deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

  • stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.
  • stickiness.type - The type of sticky sessions. The possible values are lb_cookie and app_cookie for Application Load Balancers or source_ip for Network Load Balancers.

The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:

  • load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin.
  • slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
  • stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer.
  • stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
  • stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:

  • lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.

The following attributes are supported only by Network Load Balancers:

  • deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. The default is false.
  • preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.
  • proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

TargetGroupStickinessConfig

targetGroupStickinessConfig_enabled :: Lens' TargetGroupStickinessConfig (Maybe Bool) Source #

Indicates whether target group stickiness is enabled.

targetGroupStickinessConfig_durationSeconds :: Lens' TargetGroupStickinessConfig (Maybe Int) Source #

The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

TargetGroupTuple

targetGroupTuple_weight :: Lens' TargetGroupTuple (Maybe Int) Source #

The weight. The range is 0 to 999.

targetGroupTuple_targetGroupArn :: Lens' TargetGroupTuple (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target group.

TargetHealth

targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReasonEnum) Source #

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
  • Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.
  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
  • Target.InvalidState - The target is in the stopped or terminated state.
  • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
  • Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

targetHealth_description :: Lens' TargetHealth (Maybe Text) Source #

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

TargetHealthDescription