Smaws_Client_ElasticLoadBalancingv2.Typestype nonrec capacity_reservation_status = {reason : state_reason option;The reason code for the status.
*)code : capacity_reservation_state_enum option;The status code.
*)}The status of a capacity reservation.
type nonrec zonal_capacity_reservation_state = {effective_capacity_units : capacity_units_double option;The number of effective capacity units.
*)availability_zone : zone_name option;Information about the Availability Zone.
*)state : capacity_reservation_status option;The state of the capacity reservation.
*)}The capacity reservation status for each Availability Zone.
type nonrec zonal_capacity_reservation_states =
zonal_capacity_reservation_state listtype nonrec rewrite_config = {replace : string_value;The replacement string to use when rewriting the matched input. The maximum length of the string is 1,024 characters. You can specify capture groups in the regular expression (for example, $1 and $2).
*)regex : string_value;The regular expression to match in the input string. The maximum length of the string is 1,024 characters.
*)}Information about a rewrite transform. This transform matches a pattern and replaces it with the specified string.
type nonrec rewrite_config_list = rewrite_config listtype nonrec url_rewrite_config = {rewrites : rewrite_config_list option;The URL rewrite transform to apply to the request. The transform consists of a regular expression to match and a replacement string.
*)}Information about a URL rewrite transform. This transform matches a pattern in the request URL and replaces it with the specified string.
The specified protocol is not supported.
type nonrec total_revoked_entries = Smaws_Lib.CoreTypes.Int64.ttype nonrec trust_store = {total_revoked_entries : total_revoked_entries option;The number of revoked certificates in the trust store.
*)number_of_ca_certificates : number_of_ca_certificates option;The number of ca certificates in the trust store.
*)status : trust_store_status option;The current status of the trust store.
*)trust_store_arn : trust_store_arn option;The Amazon Resource Name (ARN) of the trust store.
*)name : trust_store_name option;The name of the trust store.
*)}Information about a trust store.
type nonrec trust_stores = trust_store listtype nonrec revocation_id = Smaws_Lib.CoreTypes.Int64.ttype nonrec number_of_revoked_entries = Smaws_Lib.CoreTypes.Int64.ttype nonrec trust_store_revocation = {number_of_revoked_entries : number_of_revoked_entries option;The number of revoked certificates.
*)revocation_type : revocation_type option;The type of revocation file.
*)revocation_id : revocation_id option;The revocation ID of the revocation file.
*)trust_store_arn : trust_store_arn option;The Amazon Resource Name (ARN) of the trust store.
*)}Information about a revocation file in use by a trust store.
type nonrec trust_store_revocations = trust_store_revocation listThe specified trust store is not active.
The specified trust store does not exist.
type nonrec trust_store_names = trust_store_name listThe specified trust store is currently in use.
type nonrec trust_store_association = {resource_arn : trust_store_association_resource_arn option;The Amazon Resource Name (ARN) of the resource.
*)}Information about the resources a trust store is associated with.
type nonrec trust_store_associations = trust_store_association listThe specified association does not exist.
type nonrec trust_store_arns = trust_store_arn listtype nonrec too_many_unique_target_groups_per_load_balancer_exception = {message : error_description option;}You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.
You've reached the limit on the number of trust stores for your Amazon Web Services account.
type nonrec too_many_trust_store_revocation_entries_exception = {message : error_description option;}The specified trust store has too many revocation entries.
You've reached the limit on the number of targets.
You've reached the limit on the number of target groups for your Amazon Web Services account.
You've reached the limit on the number of tags for this resource.
You've reached the limit on the number of rules per load balancer.
You've reached the limit on the number of times a target can be registered with a load balancer.
You've reached the limit on the number of load balancers for your Amazon Web Services account.
You've reached the limit on the number of listeners per load balancer.
You've reached the limit on the number of certificates per load balancer.
You've reached the limit on the number of actions per rule.
type nonrec target_description = {quic_server_id : quic_server_id option;The server ID for the targets. This value is required if the protocol is QUIC or TCP_QUIC and can't be used with other protocols.
The ID consists of the 0x prefix followed by 16 hexadecimal characters. Any letters must be lowercase. The value must be unique at the listener level. You can't modify the server ID for a registered target. You must deregister the target and then provide a new server ID when you register the target again.
availability_zone : zone_name option;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.
For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.
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.
For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.
If the target type is lambda, this parameter is optional and the only supported value is all.
port : port option;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. This parameter is not used if the target is a Lambda function.
id : target_id;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.
}Information about a target.
type nonrec target_health = {description : description option;A description of the target health that provides additional details. If the state is healthy, a description is not provided.
reason : target_health_reason_enum option;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.Target.Timeout - The health check requests timed out.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.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.Elb.InternalError - Target health is unavailable due to an internal error.state : target_health_state_enum option;The state of the target.
*)}Information about the current health of a target.
type nonrec anomaly_detection = {mitigation_in_effect : mitigation_in_effect_enum option;Indicates whether anomaly mitigation is in progress.
*)result_ : anomaly_result_enum option;The latest anomaly detection result.
*)}Information about anomaly detection and mitigation.
type nonrec administrative_override = {description : description option;A description of the override state that provides additional details.
*)reason : target_administrative_override_reason_enum option;The reason code for the state.
*)state : target_administrative_override_state_enum option;The state of the override.
*)}Information about the override status applied to a target.
type nonrec target_health_description = {administrative_override : administrative_override option;The administrative override information for the target.
*)anomaly_detection : anomaly_detection option;The anomaly detection result for the target.
If no anomalies were detected, the result is normal.
If anomalies were detected, the result is anomalous.
target_health : target_health option;The health information for the target.
*)health_check_port : health_check_port option;The port to use to connect with the target.
*)target : target_description option;The description of the target.
*)}Information about the health of a target.
type nonrec target_health_descriptions = target_health_description listtype nonrec matcher = {grpc_code : grpc_code option;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.
*)http_code : http_code option;For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, you can specify values between 200 and 599, with the default value being 200-399. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Gateway Load Balancers, this must be "200–399".
Note that when using shorthand syntax, some values such as commas need to be escaped.
*)}The codes to use when checking for a successful response from a target. If the protocol version is gRPC, these are gRPC codes. Otherwise, these are HTTP codes.
type nonrec load_balancer_arns = load_balancer_arn listtype nonrec target_group = {target_control_port : target_control_port option;The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.
*)ip_address_type : target_group_ip_address_type_enum option;The IP address type. The default value is ipv4.
protocol_version : protocol_version option;[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.
target_type : target_type_enum option;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).
load_balancer_arns : load_balancer_arns option;The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target group. You can use each target group with only one load balancer.
*)matcher : matcher option;The HTTP or gRPC codes to use when checking for a successful response from a target.
*)health_check_path : path option;The destination for health checks on the targets.
*)unhealthy_threshold_count : health_check_threshold_count option;The number of consecutive health check failures required before considering the target unhealthy.
*)healthy_threshold_count : health_check_threshold_count option;The number of consecutive health checks successes required before considering an unhealthy target healthy.
*)health_check_timeout_seconds : health_check_timeout_seconds option;The amount of time, in seconds, during which no response means a failed health check.
*)health_check_interval_seconds : health_check_interval_seconds option;The approximate amount of time, in seconds, between health checks of an individual target.
*)health_check_enabled : health_check_enabled option;Indicates whether health checks are enabled.
*)health_check_port : health_check_port option;The port to use to connect with the target.
*)health_check_protocol : protocol_enum option;The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
*)vpc_id : vpc_id option;The ID of the VPC for the targets.
*)port : port option;The port on which the targets are listening. This parameter is not used if the target is a Lambda function.
*)protocol : protocol_enum option;The protocol to use for routing traffic to the targets.
*)target_group_name : target_group_name option;The name of the target group.
*)target_group_arn : target_group_arn option;The Amazon Resource Name (ARN) of the target group.
*)}Information about a target group.
type nonrec target_groups = target_group listtype nonrec target_group_tuple = {weight : target_group_weight option;The weight. The range is 0 to 999.
*)target_group_arn : target_group_arn option;The Amazon Resource Name (ARN) of the target group.
*)}Information about how traffic will be distributed between multiple target groups in a forward rule.
type nonrec target_group_stickiness_config = {duration_seconds : target_group_stickiness_duration_seconds option;[Application Load Balancers] 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). You must specify this value when enabling target group stickiness.
*)enabled : target_group_stickiness_enabled option;Indicates whether target group stickiness is enabled.
*)}Information about the target group stickiness for a rule.
The specified target group does not exist.
type nonrec target_group_names = target_group_name listtype nonrec target_group_list = target_group_tuple listtype nonrec target_group_attribute = {value : target_group_attribute_value option;The value of the attribute.
*)key : target_group_attribute_key option;The name of the attribute.
The following attributes are 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.stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false.stickiness.type - Indicates the type of stickiness. The possible values are:
lb_cookie and app_cookie for Application Load Balancers.source_ip for Network Load Balancers.source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.The following attributes are supported by Application Load Balancers and Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration.target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is 1.target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off.target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1.target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off.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, least_outstanding_requests, or weighted_random. The default is round_robin.load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on or off. The default is off.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. For new UDP/TCP_UDP target groups the default is true. Otherwise, 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 can't 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.target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer terminates connections to unhealthy targets. The value is true or false. The default is true. This attribute can't be enabled for UDP and TCP_UDP target groups.target_health_state.unhealthy.draining_interval_seconds - The amount of time for Elastic Load Balancing to wait before changing the state of an unhealthy target from unhealthy.draining to unhealthy. The range is 0-360000 seconds. The default value is 0 seconds.
Note: This attribute can only be configured when target_health_state.unhealthy.connection_termination.enabled is false.
The following attributes are supported only by Gateway Load Balancers:
target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same.}Information about a target group attribute.
type nonrec target_group_attributes = target_group_attribute listYou've reached the limit on the number of load balancers per target group.
type nonrec target_group_arns = target_group_arn listtype nonrec target_descriptions = target_description listtype nonrec tag_list = tag listtype nonrec tag_keys = tag_key listtype nonrec tag_description = {resource_arn : resource_arn option;The Amazon Resource Name (ARN) of the resource.
*)}The tags associated with a resource.
type nonrec tag_descriptions = tag_description listtype nonrec subnets = subnet_id listThe specified subnet does not exist.
type nonrec subnet_mapping = {source_nat_ipv6_prefix : source_nat_ipv6_prefix option;[Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT. Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or auto_assigned to use an IPv6 prefix selected at random from the subnet CIDR block.
i_pv6_address : i_pv6_address option;[Network Load Balancers] The IPv6 address.
*)private_i_pv4_address : private_i_pv4_address option;[Network Load Balancers] The private IPv4 address for an internal load balancer.
*)allocation_id : allocation_id option;[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
*)subnet_id : subnet_id option;The ID of the subnet.
*)}Information about a subnet mapping.
type nonrec subnet_mappings = subnet_mapping listtype nonrec ssl_protocols = ssl_protocol listtype nonrec ssl_policy_names = ssl_policy_name listtype nonrec cipher = {priority : cipher_priority option;The priority of the cipher.
*)name : cipher_name option;The name of the cipher.
*)}Information about a cipher used in a policy.
type nonrec ciphers = cipher listtype nonrec list_of_string = string_value listtype nonrec ssl_policy = {supported_load_balancer_types : list_of_string option;The supported load balancers.
*)name : ssl_policy_name option;The name of the policy.
*)ciphers : ciphers option;The ciphers.
*)ssl_protocols : ssl_protocols option;The protocols.
*)}Information about a policy used for SSL negotiation.
type nonrec ssl_policies = ssl_policy listtype nonrec source_nat_ipv6_prefixes = source_nat_ipv6_prefix listtype nonrec source_ip_condition_config = {values : list_of_string option;The 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 an HTTP header condition.
The total number of values must be less than, or equal to five.
*)}Information about a source IP condition.
You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.
type nonrec load_balancer_address = {i_pv6_address : i_pv6_address option;[Network Load Balancers] The IPv6 address.
*)private_i_pv4_address : private_i_pv4_address option;[Network Load Balancers] The private IPv4 address for an internal load balancer.
*)allocation_id : allocation_id option;[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
*)ip_address : ip_address option;The static IP address.
*)}Information about a static IP address for a load balancer.
type nonrec load_balancer_addresses = load_balancer_address listtype nonrec availability_zone = {source_nat_ipv6_prefixes : source_nat_ipv6_prefixes option;[Network Load Balancers with UDP listeners] The IPv6 prefixes to use for source NAT. For each subnet, specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or auto_assigned to use an IPv6 prefix selected at random from the subnet CIDR block.
load_balancer_addresses : load_balancer_addresses option;[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.
*)outpost_id : outpost_id option;[Application Load Balancers on Outposts] The ID of the Outpost.
*)subnet_id : subnet_id option;The ID of the subnet. You can specify one subnet per Availability Zone.
*)zone_name : zone_name option;The name of the Availability Zone.
*)}Information about an Availability Zone.
type nonrec availability_zones = availability_zone listtype nonrec set_subnets_output = {enable_prefix_for_ipv6_source_nat : enable_prefix_for_ipv6_source_nat_enum
option;[Network Load Balancers] Indicates whether to use an IPv6 prefix from each subnet for source NAT.
*)ip_address_type : ip_address_type option;The IP address type.
*)availability_zones : availability_zones option;Information about the subnets.
*)}type nonrec set_subnets_input = {enable_prefix_for_ipv6_source_nat : enable_prefix_for_ipv6_source_nat_enum
option;[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
ip_address_type : ip_address_type option;The IP address type.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
subnet_mappings : subnet_mappings option;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 can't 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.
*)subnets : subnets option;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. You must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}The specified load balancer does not exist.
The specified subnet is out of available addresses.
The requested configuration is not valid.
There is a pending capacity reservation.
The specified Availability Zone is not supported.
The specified allocation ID does not exist.
type nonrec security_groups = security_group_id listtype nonrec set_security_groups_output = {enforce_security_group_inbound_rules_on_private_link_traffic : enforce_security_group_inbound_rules_on_private_link_traffic_enum
option;Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.
*)security_group_ids : security_groups option;The IDs of the security groups associated with the load balancer.
*)}type nonrec set_security_groups_input = {enforce_security_group_inbound_rules_on_private_link_traffic : enforce_security_group_inbound_rules_on_private_link_traffic_enum
option;Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink. Applies only if the load balancer has an associated security group. The default is on.
security_groups : security_groups;The IDs of the security groups.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}The specified security group does not exist.
type nonrec host_header_condition_config = {regex_values : list_of_string option;The regular expressions to compare against the host header. The maximum length of each string is 128 characters.
*)values : list_of_string option;The host names. The maximum length 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). You must include at least one "." character. You can include only alphabetical characters after the final "." character.
If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
*)}Information about a host header condition.
type nonrec path_pattern_condition_config = {regex_values : list_of_string option;The regular expressions to compare against the request URL. The maximum length of each string is 128 characters.
*)values : list_of_string option;The path patterns to compare against the request URL. The maximum length 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 a query string condition.
*)}Information about a path pattern condition.
type nonrec http_header_condition_config = {regex_values : list_of_string option;The regular expression to compare against the HTTP header. The maximum length of each string is 128 characters.
*)values : list_of_string option;The strings to compare against the value of the HTTP header. The maximum length 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.
*)http_header_name : http_header_condition_name option;The name of the HTTP header field. The maximum length 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. Instead, use a host condition.
*)}Information about an HTTP header condition.
There is a set of standard HTTP header fields. You can also define custom HTTP header fields.
type nonrec query_string_key_value_pair = {value : string_value option;The value.
*)key : string_value option;The key. You can omit the key.
*)}Information about a key/value pair.
type nonrec query_string_key_value_pair_list = query_string_key_value_pair listtype nonrec query_string_condition_config = {values : query_string_key_value_pair_list option;The key/value pairs or values to find in the query string. The maximum length 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.
*)}Information about a query string condition.
The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.
type nonrec http_request_method_condition_config = {values : list_of_string option;The name of the request method. The maximum length 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.
*)}Information about an HTTP method condition.
HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry. You can also define custom HTTP methods.
type nonrec rule_condition = {regex_values : list_of_string option;The regular expressions to match against the condition field. The maximum length of each string is 128 characters. Specify only when Field is http-header, host-header, or path-pattern.
source_ip_config : source_ip_condition_config option;Information for a source IP condition. Specify only when Field is source-ip.
http_request_method_config : http_request_method_condition_config option;Information for an HTTP method condition. Specify only when Field is http-request-method.
query_string_config : query_string_condition_config option;Information for a query string condition. Specify only when Field is query-string.
http_header_config : http_header_condition_config option;Information for an HTTP header condition. Specify only when Field is http-header.
path_pattern_config : path_pattern_condition_config option;Information for a path pattern condition. Specify only when Field is path-pattern.
host_header_config : host_header_condition_config option;Information for a host header condition. Specify only when Field is host-header.
values : list_of_string option;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.
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.
field : condition_field_name option;The field in the HTTP request. The following are the possible values:
http-headerhttp-request-methodhost-headerpath-patternquery-stringsource-ip}Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string. Note that the value for a condition can't be empty.
For more information, see Quotas for your Application Load Balancers.
type nonrec rule_condition_list = rule_condition listtype nonrec authenticate_oidc_action_session_timeout =
Smaws_Lib.CoreTypes.Int64.ttype nonrec authenticate_oidc_action_authentication_request_extra_params =
(authenticate_oidc_action_authentication_request_param_name
* authenticate_oidc_action_authentication_request_param_value)
listtype nonrec authenticate_oidc_action_config = {use_existing_client_secret : authenticate_oidc_action_use_existing_client_secret
option;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.
*)on_unauthenticated_request : authenticate_oidc_action_conditional_behavior_enum
option;The behavior if the user is not authenticated. The following are possible values:
authentication_request_extra_params : authenticate_oidc_action_authentication_request_extra_params
option;The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*)session_timeout : authenticate_oidc_action_session_timeout option;The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*)scope : authenticate_oidc_action_scope option;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.
*)client_secret : authenticate_oidc_action_client_secret option;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.
client_id : authenticate_oidc_action_client_id;The OAuth 2.0 client identifier.
*)user_info_endpoint : authenticate_oidc_action_user_info_endpoint;The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*)token_endpoint : authenticate_oidc_action_token_endpoint;The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*)issuer : authenticate_oidc_action_issuer;The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*)}Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
type nonrec authenticate_cognito_action_session_timeout =
Smaws_Lib.CoreTypes.Int64.ttype nonrec authenticate_cognito_action_authentication_request_extra_params =
(authenticate_cognito_action_authentication_request_param_name
* authenticate_cognito_action_authentication_request_param_value)
listtype nonrec authenticate_cognito_action_config = {on_unauthenticated_request : authenticate_cognito_action_conditional_behavior_enum
option;The behavior if the user is not authenticated. The following are possible values:
authentication_request_extra_params : authenticate_cognito_action_authentication_request_extra_params
option;The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*)session_timeout : authenticate_cognito_action_session_timeout option;The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*)scope : authenticate_cognito_action_scope option;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.
*)user_pool_domain : authenticate_cognito_action_user_pool_domain;The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*)user_pool_client_id : authenticate_cognito_action_user_pool_client_id;The ID of the Amazon Cognito user pool client.
*)user_pool_arn : authenticate_cognito_action_user_pool_arn;The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*)}Request parameters to use when integrating with Amazon Cognito to authenticate users.
type nonrec redirect_action_config = {status_code : redirect_action_status_code_enum;The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
*)query : redirect_action_query option;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.
*)path : redirect_action_path option;The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
*)host : redirect_action_host option;The hostname. This component is not percent-encoded. The hostname can contain #{host}.
*)port : redirect_action_port option;The port. You can specify a value from 1 to 65535 or #{port}.
*)protocol : redirect_action_protocol option;The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP.
*)}Information about a redirect action.
A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.
You can reuse URI components using the following reserved keywords:
For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".
type nonrec fixed_response_action_config = {content_type : fixed_response_action_content_type option;The content type.
Valid Values: text/plain | text/css | text/html | application/javascript | application/json
*)status_code : fixed_response_action_status_code;The HTTP response code (2XX, 4XX, or 5XX).
*)message_body : fixed_response_action_message option;The message.
*)}Information about an action that returns a custom HTTP response.
type nonrec forward_action_config = {target_group_stickiness_config : target_group_stickiness_config option;The target group stickiness for the rule.
*)target_groups : target_group_list option;The target groups.
*)}Information about a forward action.
type nonrec jwt_validation_action_additional_claim_values =
jwt_validation_action_additional_claim_value listtype nonrec jwt_validation_action_additional_claim = {values : jwt_validation_action_additional_claim_values;The claim value. The maximum size of the list is 10. Each value can be up to 256 characters in length. If the format is space-separated-values, the values can't include spaces.
name : jwt_validation_action_additional_claim_name;The name of the claim. You can't specify exp, iss, nbf, or iat because we validate them by default.
format : jwt_validation_action_additional_claim_format_enum;The format of the claim value.
*)}Information about an additional claim to validate.
type nonrec jwt_validation_action_additional_claims =
jwt_validation_action_additional_claim listtype nonrec jwt_validation_action_config = {additional_claims : jwt_validation_action_additional_claims option;Additional claims to validate. The maximum size of the list is 10. We validate the exp, iss, nbf, and iat claims by default.
issuer : jwt_validation_action_issuer;The issuer of the JWT. The maximum length is 256 characters.
*)jwks_endpoint : jwt_validation_action_jwks_endpoint;The JSON Web Key Set (JWKS) endpoint. This endpoint contains JSON Web Keys (JWK) that are used to validate signatures from the provider.
This must be a full URL, including the HTTPS protocol, the domain, and the path. The maximum length is 256 characters.
*)}Information about a JSON Web Token (JWT) validation action.
type nonrec action = {jwt_validation_config : jwt_validation_action_config option;[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when Type is jwt-validation.
forward_config : forward_action_config option;Information for creating an action that distributes requests among multiple target groups. 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.
fixed_response_config : fixed_response_action_config option;[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
redirect_config : redirect_action_config option;[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
order : action_order option;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.
*)authenticate_cognito_config : authenticate_cognito_action_config option;[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
authenticate_oidc_config : authenticate_oidc_action_config option;[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
target_group_arn : target_group_arn option;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 multiple target groups, you must use ForwardConfig instead.
type_ : action_type_enum;The type of action.
*)}Information about an action.
Each rule must include exactly one of the following routing actions: forward, fixed-response, or redirect, and it must be the last action to be performed.
Optionally, a rule for an HTTPS listener can also include one of the following user authentication actions: authenticate-oidc, authenticate-cognito, or jwt-validation.
type nonrec actions = action listtype nonrec host_header_rewrite_config = {rewrites : rewrite_config_list option;The host header rewrite transform. Each transform consists of a regular expression to match and a replacement string.
*)}Information about a host header rewrite transform. This transform matches a pattern in the host header in an HTTP request and replaces it with the specified string.
type nonrec rule_transform = {url_rewrite_config : url_rewrite_config option;Information about a URL rewrite transform. This transform modifies the request URL. Specify only when Type is url-rewrite.
host_header_rewrite_config : host_header_rewrite_config option;Information about a host header rewrite transform. This transform modifies the host header in an HTTP request. Specify only when Type is host-header-rewrite.
type_ : transform_type_enum;The type of transform.
host-header-rewrite - Rewrite the host header.url-rewrite - Rewrite the request URL.}Information about a transform to apply to requests that match a rule. Transforms are applied to requests before they are sent to targets.
type nonrec rule_transform_list = rule_transform listtype nonrec rule = {transforms : rule_transform_list option;The transforms for the rule.
*)is_default : is_default option;Indicates whether this is the default rule.
*)actions : actions option;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.
conditions : rule_condition_list option;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.
priority : string_ option;The priority.
*)rule_arn : rule_arn option;The Amazon Resource Name (ARN) of the rule.
*)}Information about a rule.
type nonrec rules = rule listtype nonrec rule_priority_pair = {priority : rule_priority option;The rule priority.
*)rule_arn : rule_arn option;The Amazon Resource Name (ARN) of the rule.
*)}Information about the priorities for the rules for a listener.
type nonrec rule_priority_list = rule_priority_pair listtype nonrec set_rule_priorities_input = {rule_priorities : rule_priority_list;The rule priorities.
*)}The specified rule does not exist.
The specified priority is in use.
This operation is not allowed.
type nonrec set_ip_address_type_output = {ip_address_type : ip_address_type option;The IP address type.
*)}type nonrec set_ip_address_type_input = {ip_address_type : ip_address_type;The IP address type. Internal load balancers must use ipv4.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
Application Load Balancer authentication supports IPv4 addresses only when connecting to an Identity Provider (IdP) or Amazon Cognito endpoint. Without a public IPv4 address the load balancer can't complete the authentication process, resulting in HTTP 500 errors.
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}The specified SSL policy does not exist.
type nonrec rule_arns = rule_arn listtype nonrec revocation_ids = revocation_id listThe specified revocation ID does not exist.
type nonrec revocation_content = {revocation_type : revocation_type option;The type of revocation file.
*)s3_object_version : s3_object_version option;The Amazon S3 object version of the revocation file.
*)s3_key : s3_key option;The Amazon S3 path for the revocation file.
*)s3_bucket : s3_bucket option;The Amazon S3 bucket for the revocation file.
*)}Information about a revocation file.
type nonrec revocation_contents = revocation_content listThe specified revocation file does not exist.
The specified resource does not exist.
A specified resource is in use.
type nonrec resource_arns = resource_arn listtype nonrec remove_trust_store_revocations_input = {revocation_ids : revocation_ids;The revocation IDs of the revocation files you want to remove.
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}The specified listener does not exist.
type nonrec certificate = {is_default : default option;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.
*)certificate_arn : certificate_arn option;The Amazon Resource Name (ARN) of the certificate.
*)}Information about an SSL server certificate.
type nonrec certificate_list = certificate listtype nonrec remove_listener_certificates_input = {certificates : certificate_list;The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}type nonrec remove_ipam_pools = remove_ipam_pool_enum listtype nonrec register_targets_input = {targets : target_descriptions;The targets.
*)target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.
This operation is not allowed while a prior request has not been completed.
type nonrec mutual_authentication_attributes = {advertise_trust_store_ca_names : advertise_trust_store_ca_names_enum option;Indicates whether trust store CA certificate names are advertised.
*)trust_store_association_status : trust_store_association_status_enum option;Indicates a shared trust stores association status.
*)ignore_client_certificate_expiry : ignore_client_certificate_expiry option;Indicates whether expired client certificates are ignored.
*)trust_store_arn : trust_store_arn option;The Amazon Resource Name (ARN) of the trust store.
*)mode : mode option;The client certificate handling method. Options are off, passthrough or verify. The default value is off.
}Information about the mutual authentication attributes of a listener.
type nonrec modify_trust_store_output = {trust_stores : trust_stores option;Information about the modified trust store.
*)}type nonrec modify_trust_store_input = {ca_certificates_bundle_s3_object_version : s3_object_version option;The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.
*)ca_certificates_bundle_s3_key : s3_key;The Amazon S3 path for the ca certificates bundle.
*)ca_certificates_bundle_s3_bucket : s3_bucket;The Amazon S3 bucket for the ca certificates bundle.
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}The specified ca certificate bundle is in an invalid format, or corrupt.
The specified ca certificate bundle does not exist.
type nonrec modify_target_group_output = {target_groups : target_groups option;Information about the modified target group.
*)}type nonrec modify_target_group_input = {matcher : matcher option;[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
*)unhealthy_threshold_count : health_check_threshold_count option;The number of consecutive health check failures required before considering the target unhealthy.
*)healthy_threshold_count : health_check_threshold_count option;The number of consecutive health checks successes required before considering an unhealthy target healthy.
*)health_check_timeout_seconds : health_check_timeout_seconds option;[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
*)health_check_interval_seconds : health_check_interval_seconds option;The approximate amount of time, in seconds, between health checks of an individual target.
*)health_check_enabled : health_check_enabled option;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 can't be disabled.
health_check_path : path option;[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.
*)health_check_port : health_check_port option;The port the load balancer uses when performing health checks on targets.
*)health_check_protocol : protocol_enum option;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, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.
*)target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}type nonrec modify_target_group_attributes_output = {attributes : target_group_attributes option;Information about the target group attributes.
*)}type nonrec modify_target_group_attributes_input = {attributes : target_group_attributes;The target group attributes.
*)target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}type nonrec modify_rule_input = {reset_transforms : reset_transforms option;Indicates whether to remove all transforms from the rule. If you specify ResetTransforms, you can't specify Transforms.
transforms : rule_transform_list option;The transforms to apply to requests that match this rule. You can add one host header rewrite transform and one URL rewrite transform. If you specify Transforms, you can't specify ResetTransforms.
actions : actions option;The actions.
*)conditions : rule_condition_list option;The conditions.
*)rule_arn : rule_arn;The Amazon Resource Name (ARN) of the rule.
*)}The requested action is not valid.
The specified configuration is not valid with this protocol.
type nonrec load_balancer_attribute = {value : load_balancer_attribute_value option;The value of the attribute.
*)key : load_balancer_attribute_key option;The name of the attribute.
The following attributes are supported by all load balancers:
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and can't be changed.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.ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.zonal_shift.config.enabled - Indicates whether zonal shift is enabled. The possible values are true and false. The default is false.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.client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false.connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection 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.connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs.health_check_logs.s3.enabled - Indicates whether health check logs are enabled. The value is true or false. The default is false.health_check_logs.s3.bucket - The name of the S3 bucket for the health check logs. This attribute is required if health check 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.health_check_logs.s3.prefix - The prefix for the location in the S3 bucket for the health check logs.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.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and 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.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.routing.http2.enabled - Indicates whether clients can connect to the load balancer using HTTP/2. If true, clients can connect using HTTP/2 or HTTP/1.1. However, all client requests are subject to the stricter HTTP/2 header validation rules. For example, message header names must contain only alphanumeric characters and hyphens. If false, clients must connect using HTTP/1.1. The default is true.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 attributes are supported by only Network Load Balancers:
dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity.secondary_ips.auto_assigned.per_subnet - The number of secondary IP addresses to configure for your load balancer nodes. Use to address port allocation errors if you can't add targets. The valid range is 0 to 7. The default is 0. After you set this value, you can't decrease it.}Information about a load balancer attribute.
type nonrec load_balancer_attributes = load_balancer_attribute listtype nonrec modify_load_balancer_attributes_output = {attributes : load_balancer_attributes option;Information about the load balancer attributes.
*)}type nonrec modify_load_balancer_attributes_input = {attributes : load_balancer_attributes;The load balancer attributes.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec alpn_policy_name = alpn_policy_value listtype nonrec listener = {mutual_authentication : mutual_authentication_attributes option;The mutual authentication configuration information.
*)alpn_policy : alpn_policy_name option;[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
*)default_actions : actions option;The default actions for the listener.
*)ssl_policy : ssl_policy_name option;[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.
*)certificates : certificate_list option;[HTTPS or TLS listener] The default certificate for the listener.
*)protocol : protocol_enum option;The protocol for connections from clients to the load balancer.
*)port : port option;The port on which the load balancer is listening.
*)load_balancer_arn : load_balancer_arn option;The Amazon Resource Name (ARN) of the load balancer.
*)listener_arn : listener_arn option;The Amazon Resource Name (ARN) of the listener.
*)}Information about a listener.
type nonrec listeners = listener listtype nonrec modify_listener_output = {listeners : listeners option;Information about the modified listener.
*)}type nonrec modify_listener_input = {mutual_authentication : mutual_authentication_attributes option;[HTTPS listeners] The mutual authentication configuration information.
*)alpn_policy : alpn_policy_name option;[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
HTTP1OnlyHTTP2OnlyHTTP2OptionalHTTP2PreferredNoneFor more information, see ALPN policies in the Network Load Balancers Guide.
*)default_actions : actions option;The actions for the default rule.
*)certificates : certificate_list option;[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.
ssl_policy : ssl_policy_name option;[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.
*)protocol : protocol_enum option;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, TCP_UDP, QUIC, and TCP_QUIC protocols. You can’t change the protocol to UDP, TCP_UDP, QUIC, or TCP_QUIC if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.
*)port : port option;The port for connections from clients to the load balancer. You can't specify a port for a Gateway Load Balancer.
*)listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}type nonrec listener_attribute = {value : listener_attribute_value option;The value of the attribute.
*)key : listener_attribute_key option;The name of the attribute.
The following attribute is supported by Network Load Balancers, and Gateway Load Balancers.
tcp.idle_timeout.seconds - The tcp idle timeout value, in seconds. The valid range is 60-6000 seconds. The default is 350 seconds.The following attributes are only supported by Application Load Balancers.
routing.http.request.x_amzn_mtls_clientcert_serial_number.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Serial-Number HTTP request header.routing.http.request.x_amzn_mtls_clientcert_issuer.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Issuer HTTP request header.routing.http.request.x_amzn_mtls_clientcert_subject.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Subject HTTP request header.routing.http.request.x_amzn_mtls_clientcert_validity.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Validity HTTP request header.routing.http.request.x_amzn_mtls_clientcert_leaf.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Leaf HTTP request header.routing.http.request.x_amzn_mtls_clientcert.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert HTTP request header.routing.http.request.x_amzn_tls_version.header_name - Enables you to modify the header name of the X-Amzn-Tls-Version HTTP request header.routing.http.request.x_amzn_tls_cipher_suite.header_name - Enables you to modify the header name of the X-Amzn-Tls-Cipher-Suite HTTP request header.routing.http.response.server.enabled - Enables you to allow or remove the HTTP response server header.routing.http.response.strict_transport_security.header_value - Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS.routing.http.response.access_control_allow_origin.header_value - Specifies which origins are allowed to access the server.routing.http.response.access_control_allow_methods.header_value - Returns which HTTP methods are allowed when accessing the server from a different origin.routing.http.response.access_control_allow_headers.header_value - Specifies which headers can be used during the request.routing.http.response.access_control_allow_credentials.header_value - Indicates whether the browser should include credentials such as cookies or authentication when making requests.routing.http.response.access_control_expose_headers.header_value - Returns which headers the browser can expose to the requesting client.routing.http.response.access_control_max_age.header_value - Specifies how long the results of a preflight request can be cached, in seconds.routing.http.response.content_security_policy.header_value - Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats.routing.http.response.x_content_type_options.header_value - Indicates whether the MIME types advertised in the Content-Type headers should be followed and not be changed.routing.http.response.x_frame_options.header_value - Indicates whether the browser is allowed to render a page in a frame, iframe, embed or object.}Information about a listener attribute.
type nonrec listener_attributes = listener_attribute listtype nonrec modify_listener_attributes_output = {attributes : listener_attributes option;Information about the listener attributes.
*)}type nonrec modify_listener_attributes_input = {attributes : listener_attributes;The listener attributes.
*)listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}A listener with the specified port already exists.
The specified certificate does not exist.
The specified ALPN policy is not supported.
type nonrec ipam_pools = {ipv4_ipam_pool_id : ipam_pool_id option;The ID of the IPv4 IPAM pool.
*)}An IPAM pool is a collection of IP address CIDRs. IPAM pools enable you to organize your IP addresses according to your routing and security needs.
type nonrec modify_ip_pools_input = {remove_ipam_pools : remove_ipam_pools option;Remove the IP pools in use by the load balancer.
*)ipam_pools : ipam_pools option;The IPAM pools to be modified.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec minimum_load_balancer_capacity = {capacity_units : capacity_units option;The number of capacity units.
*)}The minimum capacity for a load balancer.
type nonrec modify_capacity_reservation_output = {capacity_reservation_state : zonal_capacity_reservation_states option;The state of the capacity reservation.
*)minimum_load_balancer_capacity : minimum_load_balancer_capacity option;The requested minimum capacity reservation for the load balancer
*)decrease_requests_remaining : decrease_requests_remaining option;The amount of daily capacity decreases remaining.
*)last_modified_time : last_modified_time option;The last time the capacity reservation was modified.
*)}type nonrec modify_capacity_reservation_input = {reset_capacity_reservation : reset_capacity_reservation option;Resets the capacity reservation.
*)minimum_load_balancer_capacity : minimum_load_balancer_capacity option;The minimum load balancer capacity reserved.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}There is insufficient capacity to reserve.
You've exceeded the capacity units limit.
type nonrec capacity_decrease_requests_limit_exceeded_exception = {message : error_description option;}You've exceeded the daily capacity decrease limit for this reservation.
type nonrec load_balancer_state = {reason : state_reason option;A description of the state.
*)code : load_balancer_state_enum option;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.
}Information about the state of the load balancer.
type nonrec load_balancer = {ipam_pools : ipam_pools option;[Application Load Balancers] The IPAM pool in use by the load balancer, if configured.
*)enable_prefix_for_ipv6_source_nat : enable_prefix_for_ipv6_source_nat_enum
option;[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
enforce_security_group_inbound_rules_on_private_link_traffic : enforce_security_group_inbound_rules_on_private_link_traffic
option;Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink.
*)customer_owned_ipv4_pool : customer_owned_ipv4_pool option;[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
*)ip_address_type : ip_address_type option;The type of IP addresses used for public or private connections by the subnets attached to your load balancer.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
security_groups : security_groups option;The IDs of the security groups for the load balancer.
*)availability_zones : availability_zones option;The subnets for the load balancer.
*)type_ : load_balancer_type_enum option;The type of load balancer.
*)state : load_balancer_state option;The state of the load balancer.
*)vpc_id : vpc_id option;The ID of the VPC for the load balancer.
*)scheme : load_balancer_scheme_enum option;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.
*)load_balancer_name : load_balancer_name option;The name of the load balancer.
*)created_time : created_time option;The date and time the load balancer was created.
*)canonical_hosted_zone_id : canonical_hosted_zone_id option;The ID of the Amazon Route 53 hosted zone associated with the load balancer.
*)dns_name : dns_name option;The public DNS name of the load balancer.
*)load_balancer_arn : load_balancer_arn option;The Amazon Resource Name (ARN) of the load balancer.
*)}Information about a load balancer.
type nonrec load_balancers = load_balancer listtype nonrec load_balancer_names = load_balancer_name listtype nonrec listener_arns = listener_arn listtype nonrec list_of_describe_target_health_include_options =
describe_target_health_input_include_enum listInformation about an Elastic Load Balancing resource limit for your Amazon Web Services account.
For more information, see the following:
type nonrec limits = limit listThe requested scheme is not valid.
The provided revocation file is an invalid format, or uses an incorrect algorithm.
The health of the specified targets could not be retrieved due to an internal error.
type nonrec get_trust_store_revocation_content_output = {location : location option;The revocation files Amazon S3 URI.
*)}type nonrec get_trust_store_revocation_content_input = {revocation_id : revocation_id;The revocation ID of the revocation file.
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec get_trust_store_ca_certificates_bundle_output = {location : location option;The ca certificate bundles Amazon S3 URI.
*)}type nonrec get_trust_store_ca_certificates_bundle_input = {trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec get_resource_policy_output = {policy : policy option;The content of the resource policy.
*)}type nonrec get_resource_policy_input = {resource_arn : resource_arn;The Amazon Resource Name (ARN) of the resource.
*)}type nonrec describe_trust_stores_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)trust_stores : trust_stores option;Information about the trust stores.
*)}type nonrec describe_trust_stores_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)names : trust_store_names option;The names of the trust stores.
*)trust_store_arns : trust_store_arns option;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec describe_trust_store_revocation = {number_of_revoked_entries : number_of_revoked_entries option;The number of revoked certificates.
*)revocation_type : revocation_type option;The type of revocation file.
*)revocation_id : revocation_id option;The revocation ID of a revocation file in use.
*)trust_store_arn : trust_store_arn option;The Amazon Resource Name (ARN) of the trust store.
*)}Information about the revocations used by a trust store.
type nonrec describe_trust_store_revocation_response =
describe_trust_store_revocation listtype nonrec describe_trust_store_revocations_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)trust_store_revocations : describe_trust_store_revocation_response option;Information about the revocation file in the trust store.
*)}type nonrec describe_trust_store_revocations_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)revocation_ids : revocation_ids option;The revocation IDs of the revocation files you want to describe.
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec describe_trust_store_associations_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)trust_store_associations : trust_store_associations option;Information about the resources the trust store is associated to.
*)}type nonrec describe_trust_store_associations_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec describe_target_health_output = {target_health_descriptions : target_health_descriptions option;Information about the health of the targets.
*)}type nonrec describe_target_health_input = {include_ : list_of_describe_target_health_include_options option;Used to include anomaly detection information.
*)targets : target_descriptions option;The targets.
*)target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}type nonrec describe_target_groups_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)target_groups : target_groups option;Information about the target groups.
*)}type nonrec describe_target_groups_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)names : target_group_names option;The names of the target groups.
*)target_group_arns : target_group_arns option;The Amazon Resource Names (ARN) of the target groups.
*)load_balancer_arn : load_balancer_arn option;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec describe_target_group_attributes_output = {attributes : target_group_attributes option;Information about the target group attributes
*)}type nonrec describe_target_group_attributes_input = {target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}type nonrec describe_ssl_policies_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)ssl_policies : ssl_policies option;Information about the security policies.
*)}type nonrec describe_ssl_policies_input = {load_balancer_type : load_balancer_type_enum option;The type of load balancer. The default lists the SSL policies for all load balancers.
*)page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)names : ssl_policy_names option;The names of the policies.
*)}type nonrec describe_rules_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)rule_arns : rule_arns option;The Amazon Resource Names (ARN) of the rules.
*)listener_arn : listener_arn option;The Amazon Resource Name (ARN) of the listener.
*)}type nonrec describe_load_balancers_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)load_balancers : load_balancers option;Information about the load balancers.
*)}type nonrec describe_load_balancers_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)names : load_balancer_names option;The names of the load balancers.
*)load_balancer_arns : load_balancer_arns option;The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
*)}type nonrec describe_load_balancer_attributes_output = {attributes : load_balancer_attributes option;Information about the load balancer attributes.
*)}type nonrec describe_load_balancer_attributes_input = {load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec describe_listeners_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)listener_arns : listener_arns option;The Amazon Resource Names (ARN) of the listeners.
*)load_balancer_arn : load_balancer_arn option;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec describe_listener_certificates_output = {next_marker : marker option;If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*)certificates : certificate_list option;Information about the certificates.
*)}type nonrec describe_listener_certificates_input = {page_size : page_size option;The maximum number of results to return with this call.
*)marker : marker option;The marker for the next set of results. (You received this marker from a previous call.)
*)listener_arn : listener_arn;The Amazon Resource Names (ARN) of the listener.
*)}type nonrec describe_listener_attributes_output = {attributes : listener_attributes option;Information about the listener attributes.
*)}type nonrec describe_listener_attributes_input = {listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}type nonrec describe_capacity_reservation_output = {capacity_reservation_state : zonal_capacity_reservation_states option;The state of the capacity reservation.
*)minimum_load_balancer_capacity : minimum_load_balancer_capacity option;The requested minimum capacity reservation for the load balancer
*)decrease_requests_remaining : decrease_requests_remaining option;The amount of daily capacity decreases remaining.
*)last_modified_time : last_modified_time option;The last time the capacity reservation was modified.
*)}type nonrec describe_capacity_reservation_input = {load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec deregister_targets_input = {targets : target_descriptions;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.
*)target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}type nonrec delete_trust_store_input = {trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec delete_target_group_input = {target_group_arn : target_group_arn;The Amazon Resource Name (ARN) of the target group.
*)}The specified association can't be within the same account.
type nonrec delete_rule_input = {rule_arn : rule_arn;The Amazon Resource Name (ARN) of the rule.
*)}type nonrec delete_load_balancer_input = {load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec delete_listener_input = {listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}A trust store with the specified name already exists.
A tag key was specified more than once.
type nonrec create_trust_store_output = {trust_stores : trust_stores option;Information about the trust store created.
*)}type nonrec create_trust_store_input = {ca_certificates_bundle_s3_object_version : s3_object_version option;The Amazon S3 object version for the ca certificates bundle. If undefined the current version is used.
*)ca_certificates_bundle_s3_key : s3_key;The Amazon S3 path for the ca certificates bundle.
*)ca_certificates_bundle_s3_bucket : s3_bucket;The Amazon S3 bucket for the ca certificates bundle.
*)name : trust_store_name;The name of the trust store.
This name must be unique per region and can't be changed after creation.
*)}A target group with the specified name already exists.
type nonrec create_target_group_output = {target_groups : target_groups option;Information about the target group.
*)}type nonrec create_target_group_input = {target_control_port : target_control_port option;The port on which the target control agent and application load balancer exchange management traffic for the target optimizer feature.
*)ip_address_type : target_group_ip_address_type_enum option;The IP address type. The default value is ipv4.
target_type : target_type_enum option;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.matcher : matcher option;[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP, QUIC, TCP_QUIC, or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
*)unhealthy_threshold_count : health_check_threshold_count option;The number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, QUIC, TCP_QUIC, HTTP or HTTPS, the default is 2. For target groups with a protocol of GENEVE, the default is 2. If the target type is lambda, the default is 5.
healthy_threshold_count : health_check_threshold_count option;The number of consecutive health check successes required before considering a target healthy. The range is 2-10. If the target group protocol is TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol of GENEVE, the default is 5. If the target type is lambda, the default is 5.
health_check_timeout_seconds : health_check_timeout_seconds option;The amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
health_check_interval_seconds : health_check_interval_seconds option;The approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. If the target group protocol is TCP, TLS, UDP, TCP_UDP, QUIC, TCP_QUIC, 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.
health_check_path : path option;[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.
*)health_check_enabled : health_check_enabled option;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 can't be disabled.
health_check_port : health_check_port option;The port the load balancer uses when performing health checks on targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, TCP_UDP, QUIC, or TCP_QUIC 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.
health_check_protocol : protocol_enum option;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, TCP_UDP, QUIC, and TCP_QUIC protocols are not supported for health checks.
*)vpc_id : vpc_id option;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.
*)port : port option;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.
*)protocol_version : protocol_version option;[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.
protocol : protocol_enum option;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, TCP_UDP, QUIC, or TCP_QUIC. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. A TCP_QUIC listener must be associated with a TCP_QUIC target group. If the target is a Lambda function, this parameter does not apply.
*)name : target_group_name;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.
*)}type nonrec create_rule_input = {transforms : rule_transform_list option;The transforms to apply to requests that match this rule. You can add one host header rewrite transform and one URL rewrite transform.
*)actions : actions;The actions.
*)priority : rule_priority;The rule priority. A listener can't have multiple rules with the same priority.
*)conditions : rule_condition_list;The conditions.
*)listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}A load balancer with the specified name already exists.
type nonrec create_load_balancer_output = {load_balancers : load_balancers option;Information about the load balancer.
*)}type nonrec create_load_balancer_input = {ipam_pools : ipam_pools option;[Application Load Balancers] The IPAM pools to use with the load balancer.
*)enable_prefix_for_ipv6_source_nat : enable_prefix_for_ipv6_source_nat_enum
option;[Network Load Balancers with UDP listeners] Indicates whether to use an IPv6 prefix from each subnet for source NAT. The IP address type must be dualstack. The default value is off.
customer_owned_ipv4_pool : customer_owned_ipv4_pool option;[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).
*)ip_address_type : ip_address_type option;The IP address type. Internal load balancers must use ipv4.
[Application Load Balancers] The possible values are ipv4 (IPv4 addresses), dualstack (IPv4 and IPv6 addresses), and dualstack-without-public-ipv4 (public IPv6 addresses and private IPv4 and IPv6 addresses).
[Network Load Balancers and Gateway Load Balancers] The possible values are ipv4 (IPv4 addresses) and dualstack (IPv4 and IPv6 addresses).
type_ : load_balancer_type_enum option;The type of load balancer. The default is application.
scheme : load_balancer_scheme_enum option;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 can't specify a scheme for a Gateway Load Balancer.
*)security_groups : security_groups option;[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.
*)subnet_mappings : subnet_mappings option;The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You can't 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 can't specify Elastic IP addresses for your subnets.
*)subnets : subnets option;The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.
[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 and Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
*)name : load_balancer_name;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-".
*)}type nonrec create_listener_output = {listeners : listeners option;Information about the listener.
*)}type nonrec create_listener_input = {mutual_authentication : mutual_authentication_attributes option;[HTTPS listeners] The mutual authentication configuration information.
*)alpn_policy : alpn_policy_name option;[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
HTTP1OnlyHTTP2OnlyHTTP2OptionalHTTP2PreferredNoneFor more information, see ALPN policies in the Network Load Balancers Guide.
*)default_actions : actions;The actions for the default rule.
*)certificates : certificate_list option;[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.
ssl_policy : ssl_policy_name option;[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.
*)port : port option;The port on which the load balancer is listening. You can't specify a port for a Gateway Load Balancer.
*)protocol : protocol_enum option;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, TCP_UDP, QUIC, and TCP_QUIC. You can’t specify the UDP, TCP_UDP, QUIC, or TCP_QUIC protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.
*)load_balancer_arn : load_balancer_arn;The Amazon Resource Name (ARN) of the load balancer.
*)}type nonrec add_trust_store_revocations_output = {trust_store_revocations : trust_store_revocations option;Information about the revocation file added to the trust store.
*)}type nonrec add_trust_store_revocations_input = {revocation_contents : revocation_contents option;The revocation file to add.
*)trust_store_arn : trust_store_arn;The Amazon Resource Name (ARN) of the trust store.
*)}type nonrec add_listener_certificates_output = {certificates : certificate_list option;Information about the certificates in the certificate list.
*)}type nonrec add_listener_certificates_input = {certificates : certificate_list;The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
listener_arn : listener_arn;The Amazon Resource Name (ARN) of the listener.
*)}