The IDs of the public subnets. You can specify only one subnet per Availability Zone. You + *
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 @@ -1751,7 +1751,7 @@ export interface CreateLoadBalancerInput { /** * @public - *
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You + *
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 cannot specify Elastic IP addresses for your subnets.
@@ -2284,6 +2284,7 @@ export interface SourceIpConditionConfig { * the request matches one of the CIDR blocks. This condition is not satisfied by the addresses * in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use * HttpHeaderConditionConfig. + *The total number of values must be less than, or equal to five.
*/ Values?: string[]; } @@ -4151,6 +4152,15 @@ export interface TargetGroupAttribute { * the load balancer terminates connections to unhealthy targets. The value istrue
* or false. The default is true.
*
+ *
+ * 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:
*The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.
" + "smithy.api#documentation": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both. To specify an Elastic IP\n address, specify subnet mappings instead of subnets.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.
" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.
" + "smithy.api#documentation": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings, but not both.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You\n cannot specify Elastic IP addresses for your subnets.
" } }, "SecurityGroups": { @@ -3090,6 +3171,33 @@ } ] } + }, + { + "title": "To describe the health of a target", + "documentation": "This example describes the health of the specified target. This target is healthy.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade", + "Port": 80 + } + ] + }, + "output": { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + } } ], "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], @@ -5800,6 +5908,40 @@ } ] } + }, + { + "title": "To change the server certificate", + "documentation": "This example changes the server certificate for the specified HTTPS listener.", + "input": { + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ] + }, + "output": { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + } + ] + } } ] } @@ -5931,6 +6073,88 @@ } ] } + }, + { + "title": "To change the idle timeout", + "documentation": "This example changes the idle timeout value for the specified load balancer.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "30", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "true", + "Key": "deletion_protection.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + } + ] + } + }, + { + "title": "To enable access logs", + "documentation": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-loadbalancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + } + ] + }, + "output": { + "Attributes": [ + { + "Value": "true", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "my-load-balancer-logs", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "myapp", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + } + ] + } } ] } @@ -6748,6 +6972,23 @@ } ] } + }, + { + "title": "To register targets with a target group using port overrides", + "documentation": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", + "Targets": [ + { + "Id": "i-80c8dd94", + "Port": 80 + }, + { + "Id": "i-80c8dd94", + "Port": 766 + } + ] + } } ] } @@ -7629,7 +7870,7 @@ "Values": { "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", "traits": { - "smithy.api#documentation": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.
\nIf you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.
" + "smithy.api#documentation": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses.\n Wildcards are not supported.
\nIf you specify multiple addresses, the condition is satisfied if the source IP address of\n the request matches one of the CIDR blocks. This condition is not satisfied by the addresses\n in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use\n HttpHeaderConditionConfig.
\nThe total number of values must be less than, or equal to five.
" } } }, @@ -8033,7 +8274,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributeKey", "traits": { - "smithy.api#documentation": "The name of the attribute.
\nThe following attributes are supported by all load balancers:
\n\n deregistration_delay.timeout_seconds - The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target\n from draining to unused. The range is 0-3600 seconds. The\n default value is 300 seconds. If the target is a Lambda function, this attribute is not\n supported.
\n stickiness.enabled - Indicates whether target stickiness is enabled. The\n value is true or false. The default is\n false.
\n stickiness.type - Indicates the type of stickiness. The possible values are:
\n lb_cookie and app_cookie for Application Load Balancers.
\n source_ip for Network Load Balancers.
\n source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and \n Network Load Balancers:
\n\n load_balancing.cross_zone.enabled - Indicates whether cross zone load \n balancing is enabled. The value is true, false or \n use_load_balancer_configuration. The default is \n use_load_balancer_configuration.
\n target_group_health.dns_failover.minimum_healthy_targets.count - \n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off or an integer from 1 to the maximum number of targets.\n The default is off.
\n target_group_health.dns_failover.minimum_healthy_targets.percentage - \n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off or an integer from 1 to 100. The default is off.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - \n The minimum number of targets that must be healthy. \n If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are 1 to the maximum number of targets. The default is 1.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - \n The minimum percentage of targets that must be healthy. \n If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are off or an integer from 1 to 100.\n The default is off.
The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type - The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is\n round_robin, least_outstanding_requests, or weighted_random. The default is\n round_robin.
\n load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type \n is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on \n or off. The default is off.
\n slow_start.duration_seconds - The time period, in seconds, during which a\n newly registered target receives an increasing share of the traffic to the target group.\n After this time period ends, the target receives its full share of traffic. The range is\n 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.app_cookie.cookie_name - Indicates the name of the\n application-based cookie. Names that start with the following prefixes are not allowed:\n AWSALB, AWSALBAPP, and AWSALBTG; they're reserved\n for use by the load balancer.
\n stickiness.app_cookie.duration_seconds - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the application-based cookie is considered stale. The range is 1 second to\n 1 week (604800 seconds). The default value is 1 day (86400 seconds).
\n stickiness.lb_cookie.duration_seconds - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the load balancer-generated cookie is considered stale. The range is 1\n 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\n Balancer and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled - Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function\n include arrays of values or strings. The value is true or false.\n The default is false. If the value is false and the request\n contains a duplicate header field name or query parameter key, the load balancer uses the\n last value sent by the client.
The following attributes are supported only by Network Load Balancers:
\n\n deregistration_delay.connection_termination.enabled - Indicates whether\n the load balancer terminates connections at the end of the deregistration timeout. The\n value is true or false. For new UDP/TCP_UDP target groups the \n default is true. Otherwise, the default is false.
\n preserve_client_ip.enabled - Indicates whether client IP preservation is\n enabled. The value is true or false. The default is disabled if\n the target group type is IP address and the target group protocol is TCP or TLS.\n Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and\n TCP_UDP target groups.
\n proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is\n enabled. The value is true or false. The default is\n false.
\n target_health_state.unhealthy.connection_termination.enabled - Indicates whether \n the load balancer terminates connections to unhealthy targets. The value is true \n or false. The default is true.
The following attributes are supported only by Gateway Load Balancers:
\n\n target_failover.on_deregistration - Indicates how the Gateway Load\n Balancer handles existing flows when a target is deregistered. The possible values are\n rebalance and no_rebalance. The default is\n no_rebalance. The two attributes\n (target_failover.on_deregistration and\n target_failover.on_unhealthy) can't be set independently. The value you set\n for both attributes must be the same.
\n target_failover.on_unhealthy - Indicates how the Gateway Load Balancer\n handles existing flows when a target is unhealthy. The possible values are\n rebalance and no_rebalance. The default is\n no_rebalance. The two attributes\n (target_failover.on_deregistration and\n target_failover.on_unhealthy) cannot be set independently. The value you\n set for both attributes must be the same.
The name of the attribute.
\nThe following attributes are supported by all load balancers:
\n\n deregistration_delay.timeout_seconds - The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target\n from draining to unused. The range is 0-3600 seconds. The\n default value is 300 seconds. If the target is a Lambda function, this attribute is not\n supported.
\n stickiness.enabled - Indicates whether target stickiness is enabled. The\n value is true or false. The default is\n false.
\n stickiness.type - Indicates the type of stickiness. The possible values are:
\n lb_cookie and app_cookie for Application Load Balancers.
\n source_ip for Network Load Balancers.
\n source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers.
The following attributes are supported by Application Load Balancers and \n Network Load Balancers:
\n\n load_balancing.cross_zone.enabled - Indicates whether cross zone load \n balancing is enabled. The value is true, false or \n use_load_balancer_configuration. The default is \n use_load_balancer_configuration.
\n target_group_health.dns_failover.minimum_healthy_targets.count - \n The minimum number of targets that must be healthy.\n If the number of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off or an integer from 1 to the maximum number of targets.\n The default is off.
\n target_group_health.dns_failover.minimum_healthy_targets.percentage - \n The minimum percentage of targets that must be healthy.\n If the percentage of healthy targets is below this value, mark the zone as unhealthy\n in DNS, so that traffic is routed only to healthy zones. The possible values are\n off or an integer from 1 to 100. The default is off.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - \n The minimum number of targets that must be healthy. \n If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are 1 to the maximum number of targets. The default is 1.
\n target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - \n The minimum percentage of targets that must be healthy. \n If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets.\n The possible values are off or an integer from 1 to 100.\n The default is off.
The following attributes are supported only if the load balancer is an Application Load\n Balancer and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type - The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is\n round_robin, least_outstanding_requests, or weighted_random. The default is\n round_robin.
\n load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type \n is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on \n or off. The default is off.
\n slow_start.duration_seconds - The time period, in seconds, during which a\n newly registered target receives an increasing share of the traffic to the target group.\n After this time period ends, the target receives its full share of traffic. The range is\n 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.app_cookie.cookie_name - Indicates the name of the\n application-based cookie. Names that start with the following prefixes are not allowed:\n AWSALB, AWSALBAPP, and AWSALBTG; they're reserved\n for use by the load balancer.
\n stickiness.app_cookie.duration_seconds - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the application-based cookie is considered stale. The range is 1 second to\n 1 week (604800 seconds). The default value is 1 day (86400 seconds).
\n stickiness.lb_cookie.duration_seconds - The time period, in seconds,\n during which requests from a client should be routed to the same target. After this time\n period expires, the load balancer-generated cookie is considered stale. The range is 1\n 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\n Balancer and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled - Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function\n include arrays of values or strings. The value is true or false.\n The default is false. If the value is false and the request\n contains a duplicate header field name or query parameter key, the load balancer uses the\n last value sent by the client.
The following attributes are supported only by Network Load Balancers:
\n\n deregistration_delay.connection_termination.enabled - Indicates whether\n the load balancer terminates connections at the end of the deregistration timeout. The\n value is true or false. For new UDP/TCP_UDP target groups the \n default is true. Otherwise, the default is false.
\n preserve_client_ip.enabled - Indicates whether client IP preservation is\n enabled. The value is true or false. The default is disabled if\n the target group type is IP address and the target group protocol is TCP or TLS.\n Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and\n TCP_UDP target groups.
\n proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is\n enabled. The value is true or false. The default is\n false.
\n target_health_state.unhealthy.connection_termination.enabled - Indicates whether \n the load balancer terminates connections to unhealthy targets. The value is true \n or false. The default is true.
\n target_health_state.unhealthy.draining_interval_seconds - The amount of time \n for Elastic Load Balancing to wait before changing the state of an unhealthy target from \n unhealthy.draining to unhealthy. The range is 0-360000 seconds. \n The default value is 0 seconds.
Note: This attribute can only be configured when \n target_health_state.unhealthy.connection_termination.enabled is false.
The following attributes are supported only by Gateway Load Balancers:
\n\n target_failover.on_deregistration - Indicates how the Gateway Load\n Balancer handles existing flows when a target is deregistered. The possible values are\n rebalance and no_rebalance. The default is\n no_rebalance. The two attributes\n (target_failover.on_deregistration and\n target_failover.on_unhealthy) can't be set independently. The value you set\n for both attributes must be the same.
\n target_failover.on_unhealthy - Indicates how the Gateway Load Balancer\n handles existing flows when a target is unhealthy. The possible values are\n rebalance and no_rebalance. The default is\n no_rebalance. The two attributes\n (target_failover.on_deregistration and\n target_failover.on_unhealthy) cannot be set independently. The value you\n set for both attributes must be the same.