String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
String protocol
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 protocol is TCP.
Integer port
The port on which the load balancer is listening.
String sslPolicy
[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
List<E> certificates
[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.
List<E> defaultActions
The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.
String 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, and must not begin or end with a hyphen.
List<E> subnets
The IDs of the subnets to attach to the load balancer. 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.
[Network Load Balancers] You can specify subnets from one or more Availability Zones.
List<E> subnetMappings
The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.
[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet.
List<E> securityGroups
[Application Load Balancers] The IDs of the security groups to assign to the load balancer.
String scheme
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 only route requests from clients with access to the VPC for the load balancer.
The default is an Internet-facing load balancer.
List<E> tags
One or more tags to assign to the load balancer.
String type
The type of load balancer to create. The default is application
.
String ipAddressType
[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible
values are ipv4
(for IPv4 addresses) and dualstack
(for IPv4 and IPv6 addresses).
Internal load balancers must use ipv4
.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
List<E> conditions
The conditions. Each condition specifies a field name and a single value.
If the field name is host-header
, you can specify a single host name (for example, my.example.com).
A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following
characters. Note that you can include up to three wildcard characters.
A-Z, a-z, 0-9
- .
* (matches 0 or more characters)
? (matches exactly 1 character)
If the field name is path-pattern
, you can specify a single path pattern. A path pattern is case
sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you
can include up to three wildcard characters.
A-Z, a-z, 0-9
_ - . $ / ~ " ' @ : +
& (using &)
* (matches 0 or more characters)
? (matches exactly 1 character)
Integer priority
The priority for the rule. A listener can't have multiple rules with the same priority.
List<E> actions
An action. Each action has the type forward
and specifies a target group.
String 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.
String protocol
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 protocol is TCP.
Integer port
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.
String vpcId
The identifier of the virtual private cloud (VPC).
String healthCheckProtocol
The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
String healthCheckPort
The port the load balancer uses when performing health checks on targets. The default is
traffic-port
, which is the port on which each target receives traffic from the load balancer.
String healthCheckPath
[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
Integer healthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.
Integer healthCheckTimeoutSeconds
The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.
Integer healthyThresholdCount
The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.
Integer unhealthyThresholdCount
The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.
Matcher matcher
[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
String targetType
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(targets are specified by instance ID) or ip
(targets are specified by IP
address). The default is instance
. Note that you can't specify targets for a target group using both
instance IDs and IP addresses.
If the target type is ip
, 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.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
String ruleArn
The Amazon Resource Name (ARN) of the rule.
String targetGroupArn
The Amazon Resource Name (ARN) of the target group.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
List<E> listenerArns
The Amazon Resource Names (ARN) of the listeners.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer pageSize
The maximum number of results to return with this call.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
List<E> loadBalancerArns
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
List<E> names
The names of the load balancers.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer pageSize
The maximum number of results to return with this call.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
List<E> ruleArns
The Amazon Resource Names (ARN) of the rules.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer pageSize
The maximum number of results to return with this call.
String targetGroupArn
The Amazon Resource Name (ARN) of the target group.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
List<E> targetGroupArns
The Amazon Resource Names (ARN) of the target groups.
List<E> names
The names of the target groups.
String marker
The marker for the next set of results. (You received this marker from a previous call.)
Integer pageSize
The maximum number of results to return with this call.
String name
The name of the limit. The possible values are:
application-load-balancers
listeners-per-application-load-balancer
listeners-per-network-load-balancer
network-load-balancers
rules-per-application-load-balancer
target-groups
targets-per-application-load-balancer
targets-per-availability-zone-per-network-load-balancer
targets-per-network-load-balancer
String max
The maximum value of the limit.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
Integer port
The port on which the load balancer is listening.
String protocol
The protocol for connections from clients to the load balancer.
List<E> certificates
The SSL server certificate. You must provide a certificate if the protocol is HTTPS.
String sslPolicy
The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
List<E> defaultActions
The default actions for the listener.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
String dNSName
The public DNS name of the load balancer.
String canonicalHostedZoneId
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
Date createdTime
The date and time the load balancer was created.
String loadBalancerName
The name of the load balancer.
String scheme
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 only route requests from clients with access to the VPC for the load balancer.
String vpcId
The ID of the VPC for the load balancer.
LoadBalancerState state
The state of the load balancer.
String type
The type of load balancer.
List<E> availabilityZones
The Availability Zones for the load balancer.
List<E> securityGroups
The IDs of the security groups for the load balancer.
String ipAddressType
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4
(for IPv4 addresses) and dualstack
(for IPv4 and IPv6 addresses).
String key
The name of the attribute.
access_logs.s3.enabled
- [Application Load Balancers] Indicates whether access logs stored in Amazon
S3 are enabled. The value is true
or false
.
access_logs.s3.bucket
- [Application Load Balancers] The name of the S3 bucket for the access logs.
This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as
the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.
access_logs.s3.prefix
- [Application Load Balancers] The prefix for the location in the S3 bucket.
If you don't specify a prefix, the access logs are stored in the root of the bucket.
deletion_protection.enabled
- Indicates whether deletion protection is enabled. The value is
true
or false
.
idle_timeout.timeout_seconds
- [Application Load Balancers] The idle timeout value, in seconds. The
valid range is 1-4000. The default is 60 seconds.
String value
The value of the attribute.
String httpCode
The HTTP codes.
For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
For Network Load Balancers, this is 200 to 399.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
Integer port
The port for connections from clients to the load balancer.
String protocol
The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.
String sslPolicy
The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.
List<E> certificates
The default SSL server certificate.
List<E> defaultActions
The default action. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.
String targetGroupArn
The Amazon Resource Name (ARN) of the target group.
String healthCheckProtocol
The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP.
String healthCheckPort
The port the load balancer uses when performing health checks on targets.
String healthCheckPath
[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
Integer healthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.
Integer healthCheckTimeoutSeconds
[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
Integer healthyThresholdCount
The number of consecutive health checks successes required before considering an unhealthy target healthy.
Integer unhealthyThresholdCount
The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.
Matcher matcher
[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
String field
The name of the field. The possible values are host-header
and path-pattern
.
List<E> values
The condition value.
If the field name is host-header
, you can specify a single host name (for example, my.example.com).
A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following
characters. Note that you can include up to three wildcard characters.
A-Z, a-z, 0-9
- .
* (matches 0 or more characters)
? (matches exactly 1 character)
If the field name is path-pattern
, you can specify a single path pattern (for example, /img/*). A
path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following
characters. Note that you can include up to three wildcard characters.
A-Z, a-z, 0-9
_ - . $ / ~ " ' @ : +
& (using &)
* (matches 0 or more characters)
? (matches exactly 1 character)
String ipAddressType
The IP address type.
String loadBalancerArn
The Amazon Resource Name (ARN) of the load balancer.
List<E> subnets
The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
List<E> subnetMappings
The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
You cannot specify Elastic IP addresses for your subnets.
String 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.
Integer port
The port on which the target is listening.
String availabilityZone
An Availability Zone or all
. This determines whether the target receives traffic from the load
balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance
. If the IP
address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this
parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the IP address is outside the VPC for the target group, the only supported
value is all
.
String targetGroupArn
The Amazon Resource Name (ARN) of the target group.
String targetGroupName
The name of the target group.
String protocol
The protocol to use for routing traffic to the targets.
Integer port
The port on which the targets are listening.
String vpcId
The ID of the VPC for the targets.
String healthCheckProtocol
The protocol to use to connect with the target.
String healthCheckPort
The port to use to connect with the target.
Integer healthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target.
Integer healthCheckTimeoutSeconds
The amount of time, in seconds, during which no response means a failed health check.
Integer healthyThresholdCount
The number of consecutive health checks successes required before considering an unhealthy target healthy.
Integer unhealthyThresholdCount
The number of consecutive health check failures required before considering the target unhealthy.
String healthCheckPath
The destination for the health check request.
Matcher matcher
The HTTP codes to use when checking for a successful response from a target.
List<E> loadBalancerArns
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
String targetType
The type of target that you must specify when registering targets with this target group. The possible values are
instance
(targets are specified by instance ID) or ip
(targets are specified by IP
address).
String key
The name of the attribute.
deregistration_delay.timeout_seconds
- The amount time 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.
stickiness.enabled
- [Application Load Balancers] Indicates whether sticky sessions are enabled. The
value is true
or false
.
stickiness.type
- [Application Load Balancers] The type of sticky sessions. The possible value is
lb_cookie
.
stickiness.lb_cookie.duration_seconds
- [Application Load Balancers] 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).
String value
The value of the attribute.
String state
The state of the target.
String reason
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 health checks failed because the connection to the target timed out,
the target response was malformed, or the target failed the health check for an unknown reason.
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.IpUnusable
- The target IP address is reserved for use by a load balancer.
Target.InvalidState
- The target is in the stopped or terminated state.
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.
String description
A description of the target health that provides additional details. If the state is healthy
, a
description is not provided.
TargetDescription target
The description of the target.
String healthCheckPort
The port to use to connect with the target.
TargetHealth targetHealth
The health information for the target.
Copyright © 2017. All rights reserved.