Elastic Load Balancing

2021/09/27 - Elastic Load Balancing - 3 updated api methods

Changes  Update elbv2 client to latest version

CreateTargetGroup (updated) Link ¶
Changes (request, response)
Request 
{'TargetType': {'alb'}}
Response 
{'TargetGroups': {'TargetType': {'alb'}}}

Creates a target group.

For more information, see the following:

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

See also: AWS API Documentation

Request Syntax

client.create_target_group(
    Name='string',
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    ProtocolVersion='string',
    Port=123,
    VpcId='string',
    HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    HealthCheckPort='string',
    HealthCheckEnabled=True|False,
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string',
        'GrpcCode': 'string'
    },
    TargetType='instance'|'ip'|'lambda'|'alb',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name:

string

param Name:

[REQUIRED]

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

string

param 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 protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

type ProtocolVersion:

string

param ProtocolVersion:

[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.

type Port:

integer

param Port:

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.

type VpcId:

string

param VpcId:

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.

type HealthCheckProtocol:

string

param HealthCheckProtocol:

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

type HealthCheckPort:

string

param HealthCheckPort:

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

type HealthCheckEnabled:

boolean

param HealthCheckEnabled:

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

type HealthCheckPath:

string

param HealthCheckPath:

[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.

type HealthCheckIntervalSeconds:

integer

param HealthCheckIntervalSeconds:

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

type HealthCheckTimeoutSeconds:

integer

param HealthCheckTimeoutSeconds:

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

type HealthyThresholdCount:

integer

param HealthyThresholdCount:

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

type UnhealthyThresholdCount:

integer

param UnhealthyThresholdCount:

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

type Matcher:

dict

param Matcher:

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

  • HttpCode (string) --

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

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

  • GrpcCode (string) --

    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.

type TargetType:

string

param TargetType:

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.

type Tags:

list

param Tags:

The tags to assign to the target group.

  • (dict) --

    Information about a tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) --

      The value of the tag.

rtype:

dict

returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'HealthCheckPort': 'string',
            'HealthCheckEnabled': True|False,
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string',
                'GrpcCode': 'string'
            },
            'LoadBalancerArns': [
                'string',
            ],
            'TargetType': 'instance'|'ip'|'lambda'|'alb',
            'ProtocolVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • TargetGroups (list) --

      Information about the target group.

      • (dict) --

        Information about a target group.

        • TargetGroupArn (string) --

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

        • TargetGroupName (string) --

          The name of the target group.

        • Protocol (string) --

          The protocol to use for routing traffic to the targets.

        • Port (integer) --

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

        • VpcId (string) --

          The ID of the VPC for the targets.

        • HealthCheckProtocol (string) --

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

        • HealthCheckPort (string) --

          The port to use to connect with the target.

        • HealthCheckEnabled (boolean) --

          Indicates whether health checks are enabled.

        • HealthCheckIntervalSeconds (integer) --

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

        • HealthCheckTimeoutSeconds (integer) --

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

        • HealthyThresholdCount (integer) --

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

        • UnhealthyThresholdCount (integer) --

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

        • HealthCheckPath (string) --

          The destination for health checks on the targets.

        • Matcher (dict) --

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

          • HttpCode (string) --

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

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

          • GrpcCode (string) --

            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.

        • LoadBalancerArns (list) --

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

          • (string) --

        • TargetType (string) --

          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).

        • ProtocolVersion (string) --

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

DescribeTargetGroups (updated) Link ¶
Changes (response) 
{'TargetGroups': {'TargetType': {'alb'}}}

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

See also: AWS API Documentation

Request Syntax

client.describe_target_groups(
    LoadBalancerArn='string',
    TargetGroupArns=[
        'string',
    ],
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)
type LoadBalancerArn:

string

param LoadBalancerArn:

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

type TargetGroupArns:

list

param TargetGroupArns:

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

  • (string) --

type Names:

list

param Names:

The names of the target groups.

  • (string) --

type Marker:

string

param Marker:

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

type PageSize:

integer

param PageSize:

The maximum number of results to return with this call.

rtype:

dict

returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'HealthCheckPort': 'string',
            'HealthCheckEnabled': True|False,
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string',
                'GrpcCode': 'string'
            },
            'LoadBalancerArns': [
                'string',
            ],
            'TargetType': 'instance'|'ip'|'lambda'|'alb',
            'ProtocolVersion': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) --

    • TargetGroups (list) --

      Information about the target groups.

      • (dict) --

        Information about a target group.

        • TargetGroupArn (string) --

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

        • TargetGroupName (string) --

          The name of the target group.

        • Protocol (string) --

          The protocol to use for routing traffic to the targets.

        • Port (integer) --

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

        • VpcId (string) --

          The ID of the VPC for the targets.

        • HealthCheckProtocol (string) --

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

        • HealthCheckPort (string) --

          The port to use to connect with the target.

        • HealthCheckEnabled (boolean) --

          Indicates whether health checks are enabled.

        • HealthCheckIntervalSeconds (integer) --

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

        • HealthCheckTimeoutSeconds (integer) --

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

        • HealthyThresholdCount (integer) --

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

        • UnhealthyThresholdCount (integer) --

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

        • HealthCheckPath (string) --

          The destination for health checks on the targets.

        • Matcher (dict) --

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

          • HttpCode (string) --

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

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

          • GrpcCode (string) --

            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.

        • LoadBalancerArns (list) --

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

          • (string) --

        • TargetType (string) --

          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).

        • ProtocolVersion (string) --

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

    • NextMarker (string) --

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

ModifyTargetGroup (updated) Link ¶
Changes (response) 
{'TargetGroups': {'TargetType': {'alb'}}}

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

See also: AWS API Documentation

Request Syntax

client.modify_target_group(
    TargetGroupArn='string',
    HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    HealthCheckPort='string',
    HealthCheckPath='string',
    HealthCheckEnabled=True|False,
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string',
        'GrpcCode': 'string'
    }
)
type TargetGroupArn:

string

param TargetGroupArn:

[REQUIRED]

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

type HealthCheckProtocol:

string

param HealthCheckProtocol:

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

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

type HealthCheckPort:

string

param HealthCheckPort:

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

type HealthCheckPath:

string

param HealthCheckPath:

[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.

type HealthCheckEnabled:

boolean

param HealthCheckEnabled:

Indicates whether health checks are enabled.

type HealthCheckIntervalSeconds:

integer

param HealthCheckIntervalSeconds:

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

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

type HealthCheckTimeoutSeconds:

integer

param HealthCheckTimeoutSeconds:

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

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

type HealthyThresholdCount:

integer

param HealthyThresholdCount:

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

type UnhealthyThresholdCount:

integer

param UnhealthyThresholdCount:

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

type Matcher:

dict

param Matcher:

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

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

  • HttpCode (string) --

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

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

  • GrpcCode (string) --

    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.

rtype:

dict

returns:

Response Syntax

{
    'TargetGroups': [
        {
            'TargetGroupArn': 'string',
            'TargetGroupName': 'string',
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            'HealthCheckPort': 'string',
            'HealthCheckEnabled': True|False,
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string',
                'GrpcCode': 'string'
            },
            'LoadBalancerArns': [
                'string',
            ],
            'TargetType': 'instance'|'ip'|'lambda'|'alb',
            'ProtocolVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • TargetGroups (list) --

      Information about the modified target group.

      • (dict) --

        Information about a target group.

        • TargetGroupArn (string) --

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

        • TargetGroupName (string) --

          The name of the target group.

        • Protocol (string) --

          The protocol to use for routing traffic to the targets.

        • Port (integer) --

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

        • VpcId (string) --

          The ID of the VPC for the targets.

        • HealthCheckProtocol (string) --

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

        • HealthCheckPort (string) --

          The port to use to connect with the target.

        • HealthCheckEnabled (boolean) --

          Indicates whether health checks are enabled.

        • HealthCheckIntervalSeconds (integer) --

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

        • HealthCheckTimeoutSeconds (integer) --

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

        • HealthyThresholdCount (integer) --

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

        • UnhealthyThresholdCount (integer) --

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

        • HealthCheckPath (string) --

          The destination for health checks on the targets.

        • Matcher (dict) --

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

          • HttpCode (string) --

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

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

          • GrpcCode (string) --

            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.

        • LoadBalancerArns (list) --

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

          • (string) --

        • TargetType (string) --

          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).

        • ProtocolVersion (string) --

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