Elastic Load Balancing

{'Protocol': {'TLS'}}

{'Listeners': {'Protocol': {'TLS'}}}

Creates a listener for the specified Application Load Balancer or Network Load Balancer.

To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.

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

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.

See also: AWS API Documentation

Request Syntax

client.create_listener(
    LoadBalancerArn='string',
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS',
    Port=123,
    SslPolicy='string',
    Certificates=[
        {
            'CertificateArn': 'string',
            'IsDefault': True|False
        },
    ],
    DefaultActions=[
        {
            'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
            'TargetGroupArn': 'string',
            'AuthenticateOidcConfig': {
                'Issuer': 'string',
                'AuthorizationEndpoint': 'string',
                'TokenEndpoint': 'string',
                'UserInfoEndpoint': 'string',
                'ClientId': 'string',
                'ClientSecret': 'string',
                'SessionCookieName': 'string',
                'Scope': 'string',
                'SessionTimeout': 123,
                'AuthenticationRequestExtraParams': {
                    'string': 'string'
                },
                'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
            },
            'AuthenticateCognitoConfig': {
                'UserPoolArn': 'string',
                'UserPoolClientId': 'string',
                'UserPoolDomain': 'string',
                'SessionCookieName': 'string',
                'Scope': 'string',
                'SessionTimeout': 123,
                'AuthenticationRequestExtraParams': {
                    'string': 'string'
                },
                'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
            },
            'Order': 123,
            'RedirectConfig': {
                'Protocol': 'string',
                'Port': 'string',
                'Host': 'string',
                'Path': 'string',
                'Query': 'string',
                'StatusCode': 'HTTP_301'|'HTTP_302'
            },
            'FixedResponseConfig': {
                'MessageBody': 'string',
                'StatusCode': 'string',
                'ContentType': 'string'
            }
        },
    ]
)

type LoadBalancerArn:

string

param LoadBalancerArn:

[REQUIRED]

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

type Protocol:

string

param Protocol:

[REQUIRED]

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 and TLS.

type Port:

integer

param Port:

[REQUIRED]

The port on which the load balancer is listening.

type SslPolicy:

string

param SslPolicy:

[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

type Certificates:

list

param Certificates:

[HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

• (dict) --

  Information about an SSL server certificate.

  • CertificateArn (string) --

    The Amazon Resource Name (ARN) of the certificate.

  • IsDefault (boolean) --

    Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter.

type DefaultActions:

list

param DefaultActions:

[REQUIRED]

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

• (dict) --

  Information about an action.

  • Type (string) -- [REQUIRED]

    The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

  • TargetGroupArn (string) --

    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

  • AuthenticateOidcConfig (dict) --

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

    • Issuer (string) -- [REQUIRED]

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

    • AuthorizationEndpoint (string) -- [REQUIRED]

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

    • TokenEndpoint (string) -- [REQUIRED]

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

    • UserInfoEndpoint (string) -- [REQUIRED]

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

    • ClientId (string) -- [REQUIRED]

      The OAuth 2.0 client identifier.

    • ClientSecret (string) -- [REQUIRED]

      The OAuth 2.0 client secret.

    • SessionCookieName (string) --

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

    • Scope (string) --

      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.

    • SessionTimeout (integer) --

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

    • AuthenticationRequestExtraParams (dict) --

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

      • (string) --

        • (string) --

    • OnUnauthenticatedRequest (string) --

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

      • deny - Return an HTTP 401 Unauthorized error.

      • allow - Allow the request to be forwarded to the target.

      • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

  • AuthenticateCognitoConfig (dict) --

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

    • UserPoolArn (string) -- [REQUIRED]

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

    • UserPoolClientId (string) -- [REQUIRED]

      The ID of the Amazon Cognito user pool client.

    • UserPoolDomain (string) -- [REQUIRED]

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

    • SessionCookieName (string) --

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

    • Scope (string) --

      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.

    • SessionTimeout (integer) --

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

    • AuthenticationRequestExtraParams (dict) --

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

      • (string) --

        • (string) --

    • OnUnauthenticatedRequest (string) --

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

      • deny - Return an HTTP 401 Unauthorized error.

      • allow - Allow the request to be forwarded to the target.

      • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

  • Order (integer) --

    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. The final action to be performed must be a forward or a fixed-response action.

  • RedirectConfig (dict) --

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

    • Protocol (string) --

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

    • Port (string) --

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

    • Host (string) --

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

    • Path (string) --

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

    • Query (string) --

      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.

    • StatusCode (string) -- [REQUIRED]

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

  • FixedResponseConfig (dict) --

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

    • MessageBody (string) --

      The message.

    • StatusCode (string) -- [REQUIRED]

      The HTTP response code (2XX, 4XX, or 5XX).

    • ContentType (string) --

      The content type.

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

rtype:

dict

returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS',
            'Certificates': [
                {
                    'CertificateArn': 'string',
                    'IsDefault': True|False
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
                    'TargetGroupArn': 'string',
                    'AuthenticateOidcConfig': {
                        'Issuer': 'string',
                        'AuthorizationEndpoint': 'string',
                        'TokenEndpoint': 'string',
                        'UserInfoEndpoint': 'string',
                        'ClientId': 'string',
                        'ClientSecret': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'AuthenticateCognitoConfig': {
                        'UserPoolArn': 'string',
                        'UserPoolClientId': 'string',
                        'UserPoolDomain': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'Order': 123,
                    'RedirectConfig': {
                        'Protocol': 'string',
                        'Port': 'string',
                        'Host': 'string',
                        'Path': 'string',
                        'Query': 'string',
                        'StatusCode': 'HTTP_301'|'HTTP_302'
                    },
                    'FixedResponseConfig': {
                        'MessageBody': 'string',
                        'StatusCode': 'string',
                        'ContentType': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • Listeners (list) --

    Information about the listener.

    • (dict) --

      Information about a listener.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • LoadBalancerArn (string) --

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

      • Port (integer) --

        The port on which the load balancer is listening.

      • Protocol (string) --

        The protocol for connections from clients to the load balancer.

      • Certificates (list) --

        The SSL server certificate. You must provide a certificate if the protocol is HTTPS or TLS.

        • (dict) --

          Information about an SSL server certificate.

          • CertificateArn (string) --

            The Amazon Resource Name (ARN) of the certificate.

          • IsDefault (boolean) --

            Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter.

      • SslPolicy (string) --

        The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          • Type (string) --

            The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

          • AuthenticateOidcConfig (dict) --

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

            • Issuer (string) --

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

            • AuthorizationEndpoint (string) --

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

            • TokenEndpoint (string) --

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

            • UserInfoEndpoint (string) --

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

            • ClientId (string) --

              The OAuth 2.0 client identifier.

            • ClientSecret (string) --

              The OAuth 2.0 client secret.

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • AuthenticateCognitoConfig (dict) --

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

            • UserPoolArn (string) --

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

            • UserPoolClientId (string) --

              The ID of the Amazon Cognito user pool client.

            • UserPoolDomain (string) --

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

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • Order (integer) --

            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. The final action to be performed must be a forward or a fixed-response action.

          • RedirectConfig (dict) --

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

            • Protocol (string) --

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

            • Port (string) --

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

            • Host (string) --

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

            • Path (string) --

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

            • Query (string) --

              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.

            • StatusCode (string) --

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

          • FixedResponseConfig (dict) --

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

            • MessageBody (string) --

              The message.

            • StatusCode (string) --

              The HTTP response code (2XX, 4XX, or 5XX).

            • ContentType (string) --

              The content type.

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

{'HealthCheckProtocol': {'TLS'}, 'Protocol': {'TLS'}}

{'TargetGroups': {'HealthCheckProtocol': {'TLS'}, 'Protocol': {'TLS'}}}

Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

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.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

See also: AWS API Documentation

Request Syntax

client.create_target_group(
    Name='string',
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS',
    Port=123,
    VpcId='string',
    HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS',
    HealthCheckPort='string',
    HealthCheckEnabled=True|False,
    HealthCheckPath='string',
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': 'string'
    },
    TargetType='instance'|'ip'|'lambda'
)

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 and TLS. If the target is a Lambda function, this parameter does not apply.

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.

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.

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, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks.

type HealthCheckPort:

string

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

type HealthCheckEnabled:

boolean

param HealthCheckEnabled:

Indicates whether health checks are enabled. If the target type is instance or ip, the default is true. If the target type is lambda, the default is false.

type HealthCheckPath:

string

param HealthCheckPath:

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

type HealthCheckIntervalSeconds:

integer

param HealthCheckIntervalSeconds:

The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. If the target type is instance or ip, the default is 30 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 Application Load Balancers, the range is 2–120 seconds and the default is 5 seconds if the target type is instance or ip and 30 seconds if the target type is lambda. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

type HealthyThresholdCount:

integer

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

type UnhealthyThresholdCount:

integer

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

type Matcher:

dict

param Matcher:

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

• HttpCode (string) -- [REQUIRED]

  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–399.

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 - Targets are specified by instance ID. This is the default value.

• ip - Targets are specified 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 - The target groups contains a single Lambda function.

rtype:

dict

returns:

Response Syntax

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

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.

      • VpcId (string) --

        The ID of the VPC for the targets.

      • HealthCheckProtocol (string) --

        The protocol to use to connect with the target.

      • 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 the health check request.

      • Matcher (dict) --

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

        • HttpCode (string) --

          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–399.

      • 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 (targets are specified by instance ID) or ip (targets are specified by IP address).

{'Listeners': {'Protocol': {'TLS'}}}

Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.

See also: AWS API Documentation

Request Syntax

client.describe_listeners(
    LoadBalancerArn='string',
    ListenerArns=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

type LoadBalancerArn:

string

param LoadBalancerArn:

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

type ListenerArns:

list

param ListenerArns:

The Amazon Resource Names (ARN) of the listeners.

• (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

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS',
            'Certificates': [
                {
                    'CertificateArn': 'string',
                    'IsDefault': True|False
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
                    'TargetGroupArn': 'string',
                    'AuthenticateOidcConfig': {
                        'Issuer': 'string',
                        'AuthorizationEndpoint': 'string',
                        'TokenEndpoint': 'string',
                        'UserInfoEndpoint': 'string',
                        'ClientId': 'string',
                        'ClientSecret': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'AuthenticateCognitoConfig': {
                        'UserPoolArn': 'string',
                        'UserPoolClientId': 'string',
                        'UserPoolDomain': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'Order': 123,
                    'RedirectConfig': {
                        'Protocol': 'string',
                        'Port': 'string',
                        'Host': 'string',
                        'Path': 'string',
                        'Query': 'string',
                        'StatusCode': 'HTTP_301'|'HTTP_302'
                    },
                    'FixedResponseConfig': {
                        'MessageBody': 'string',
                        'StatusCode': 'string',
                        'ContentType': 'string'
                    }
                },
            ]
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  • Listeners (list) --

    Information about the listeners.

    • (dict) --

      Information about a listener.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • LoadBalancerArn (string) --

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

      • Port (integer) --

        The port on which the load balancer is listening.

      • Protocol (string) --

        The protocol for connections from clients to the load balancer.

      • Certificates (list) --

        The SSL server certificate. You must provide a certificate if the protocol is HTTPS or TLS.

        • (dict) --

          Information about an SSL server certificate.

          • CertificateArn (string) --

            The Amazon Resource Name (ARN) of the certificate.

          • IsDefault (boolean) --

            Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter.

      • SslPolicy (string) --

        The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          • Type (string) --

            The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

          • AuthenticateOidcConfig (dict) --

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

            • Issuer (string) --

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

            • AuthorizationEndpoint (string) --

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

            • TokenEndpoint (string) --

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

            • UserInfoEndpoint (string) --

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

            • ClientId (string) --

              The OAuth 2.0 client identifier.

            • ClientSecret (string) --

              The OAuth 2.0 client secret.

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • AuthenticateCognitoConfig (dict) --

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

            • UserPoolArn (string) --

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

            • UserPoolClientId (string) --

              The ID of the Amazon Cognito user pool client.

            • UserPoolDomain (string) --

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

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • Order (integer) --

            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. The final action to be performed must be a forward or a fixed-response action.

          • RedirectConfig (dict) --

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

            • Protocol (string) --

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

            • Port (string) --

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

            • Host (string) --

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

            • Path (string) --

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

            • Query (string) --

              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.

            • StatusCode (string) --

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

          • FixedResponseConfig (dict) --

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

            • MessageBody (string) --

              The message.

            • StatusCode (string) --

              The HTTP response code (2XX, 4XX, or 5XX).

            • ContentType (string) --

              The content type.

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

  • NextMarker (string) --

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

{'TargetGroups': {'HealthCheckProtocol': {'TLS'}, 'Protocol': {'TLS'}}}

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.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

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',
            'Port': 123,
            'VpcId': 'string',
            'HealthCheckProtocol': 'HTTP'|'HTTPS'|'TCP'|'TLS',
            'HealthCheckPort': 'string',
            'HealthCheckEnabled': True|False,
            'HealthCheckIntervalSeconds': 123,
            'HealthCheckTimeoutSeconds': 123,
            'HealthyThresholdCount': 123,
            'UnhealthyThresholdCount': 123,
            'HealthCheckPath': 'string',
            'Matcher': {
                'HttpCode': 'string'
            },
            'LoadBalancerArns': [
                'string',
            ],
            'TargetType': 'instance'|'ip'|'lambda'
        },
    ],
    '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.

      • VpcId (string) --

        The ID of the VPC for the targets.

      • HealthCheckProtocol (string) --

        The protocol to use to connect with the target.

      • 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 the health check request.

      • Matcher (dict) --

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

        • HttpCode (string) --

          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–399.

      • 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 (targets are specified by instance ID) or ip (targets are specified by IP address).

  • NextMarker (string) --

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

{'Protocol': {'TLS'}}

{'Listeners': {'Protocol': {'TLS'}}}

Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and server certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and server certificate properties.

See also: AWS API Documentation

Request Syntax

client.modify_listener(
    ListenerArn='string',
    Port=123,
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS',
    SslPolicy='string',
    Certificates=[
        {
            'CertificateArn': 'string',
            'IsDefault': True|False
        },
    ],
    DefaultActions=[
        {
            'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
            'TargetGroupArn': 'string',
            'AuthenticateOidcConfig': {
                'Issuer': 'string',
                'AuthorizationEndpoint': 'string',
                'TokenEndpoint': 'string',
                'UserInfoEndpoint': 'string',
                'ClientId': 'string',
                'ClientSecret': 'string',
                'SessionCookieName': 'string',
                'Scope': 'string',
                'SessionTimeout': 123,
                'AuthenticationRequestExtraParams': {
                    'string': 'string'
                },
                'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
            },
            'AuthenticateCognitoConfig': {
                'UserPoolArn': 'string',
                'UserPoolClientId': 'string',
                'UserPoolDomain': 'string',
                'SessionCookieName': 'string',
                'Scope': 'string',
                'SessionTimeout': 123,
                'AuthenticationRequestExtraParams': {
                    'string': 'string'
                },
                'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
            },
            'Order': 123,
            'RedirectConfig': {
                'Protocol': 'string',
                'Port': 'string',
                'Host': 'string',
                'Path': 'string',
                'Query': 'string',
                'StatusCode': 'HTTP_301'|'HTTP_302'
            },
            'FixedResponseConfig': {
                'MessageBody': 'string',
                'StatusCode': 'string',
                'ContentType': 'string'
            }
        },
    ]
)

type ListenerArn:

string

param ListenerArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the listener.

type Port:

integer

param Port:

The port for connections from clients to the load balancer.

type Protocol:

string

param Protocol:

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 and TLS protocols.

type SslPolicy:

string

param SslPolicy:

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

type Certificates:

list

param Certificates:

[HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

• (dict) --

  Information about an SSL server certificate.

  • CertificateArn (string) --

    The Amazon Resource Name (ARN) of the certificate.

  • IsDefault (boolean) --

    Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter.

type DefaultActions:

list

param DefaultActions:

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

• (dict) --

  Information about an action.

  • Type (string) -- [REQUIRED]

    The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

  • TargetGroupArn (string) --

    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

  • AuthenticateOidcConfig (dict) --

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

    • Issuer (string) -- [REQUIRED]

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

    • AuthorizationEndpoint (string) -- [REQUIRED]

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

    • TokenEndpoint (string) -- [REQUIRED]

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

    • UserInfoEndpoint (string) -- [REQUIRED]

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

    • ClientId (string) -- [REQUIRED]

      The OAuth 2.0 client identifier.

    • ClientSecret (string) -- [REQUIRED]

      The OAuth 2.0 client secret.

    • SessionCookieName (string) --

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

    • Scope (string) --

      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.

    • SessionTimeout (integer) --

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

    • AuthenticationRequestExtraParams (dict) --

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

      • (string) --

        • (string) --

    • OnUnauthenticatedRequest (string) --

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

      • deny - Return an HTTP 401 Unauthorized error.

      • allow - Allow the request to be forwarded to the target.

      • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

  • AuthenticateCognitoConfig (dict) --

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

    • UserPoolArn (string) -- [REQUIRED]

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

    • UserPoolClientId (string) -- [REQUIRED]

      The ID of the Amazon Cognito user pool client.

    • UserPoolDomain (string) -- [REQUIRED]

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

    • SessionCookieName (string) --

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

    • Scope (string) --

      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.

    • SessionTimeout (integer) --

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

    • AuthenticationRequestExtraParams (dict) --

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

      • (string) --

        • (string) --

    • OnUnauthenticatedRequest (string) --

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

      • deny - Return an HTTP 401 Unauthorized error.

      • allow - Allow the request to be forwarded to the target.

      • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

  • Order (integer) --

    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. The final action to be performed must be a forward or a fixed-response action.

  • RedirectConfig (dict) --

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

    • Protocol (string) --

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

    • Port (string) --

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

    • Host (string) --

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

    • Path (string) --

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

    • Query (string) --

      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.

    • StatusCode (string) -- [REQUIRED]

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

  • FixedResponseConfig (dict) --

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

    • MessageBody (string) --

      The message.

    • StatusCode (string) -- [REQUIRED]

      The HTTP response code (2XX, 4XX, or 5XX).

    • ContentType (string) --

      The content type.

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

rtype:

dict

returns:

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS',
            'Certificates': [
                {
                    'CertificateArn': 'string',
                    'IsDefault': True|False
                },
            ],
            'SslPolicy': 'string',
            'DefaultActions': [
                {
                    'Type': 'forward'|'authenticate-oidc'|'authenticate-cognito'|'redirect'|'fixed-response',
                    'TargetGroupArn': 'string',
                    'AuthenticateOidcConfig': {
                        'Issuer': 'string',
                        'AuthorizationEndpoint': 'string',
                        'TokenEndpoint': 'string',
                        'UserInfoEndpoint': 'string',
                        'ClientId': 'string',
                        'ClientSecret': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'AuthenticateCognitoConfig': {
                        'UserPoolArn': 'string',
                        'UserPoolClientId': 'string',
                        'UserPoolDomain': 'string',
                        'SessionCookieName': 'string',
                        'Scope': 'string',
                        'SessionTimeout': 123,
                        'AuthenticationRequestExtraParams': {
                            'string': 'string'
                        },
                        'OnUnauthenticatedRequest': 'deny'|'allow'|'authenticate'
                    },
                    'Order': 123,
                    'RedirectConfig': {
                        'Protocol': 'string',
                        'Port': 'string',
                        'Host': 'string',
                        'Path': 'string',
                        'Query': 'string',
                        'StatusCode': 'HTTP_301'|'HTTP_302'
                    },
                    'FixedResponseConfig': {
                        'MessageBody': 'string',
                        'StatusCode': 'string',
                        'ContentType': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • Listeners (list) --

    Information about the modified listener.

    • (dict) --

      Information about a listener.

      • ListenerArn (string) --

        The Amazon Resource Name (ARN) of the listener.

      • LoadBalancerArn (string) --

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

      • Port (integer) --

        The port on which the load balancer is listening.

      • Protocol (string) --

        The protocol for connections from clients to the load balancer.

      • Certificates (list) --

        The SSL server certificate. You must provide a certificate if the protocol is HTTPS or TLS.

        • (dict) --

          Information about an SSL server certificate.

          • CertificateArn (string) --

            The Amazon Resource Name (ARN) of the certificate.

          • IsDefault (boolean) --

            Indicates whether the certificate is the default certificate. Do not set IsDefault when specifying a certificate as an input parameter.

      • SslPolicy (string) --

        The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          • Type (string) --

            The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

          • AuthenticateOidcConfig (dict) --

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

            • Issuer (string) --

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

            • AuthorizationEndpoint (string) --

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

            • TokenEndpoint (string) --

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

            • UserInfoEndpoint (string) --

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

            • ClientId (string) --

              The OAuth 2.0 client identifier.

            • ClientSecret (string) --

              The OAuth 2.0 client secret.

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • AuthenticateCognitoConfig (dict) --

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

            • UserPoolArn (string) --

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

            • UserPoolClientId (string) --

              The ID of the Amazon Cognito user pool client.

            • UserPoolDomain (string) --

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

            • SessionCookieName (string) --

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

            • Scope (string) --

              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.

            • SessionTimeout (integer) --

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

            • AuthenticationRequestExtraParams (dict) --

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

              • (string) --

                • (string) --

            • OnUnauthenticatedRequest (string) --

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

              • deny - Return an HTTP 401 Unauthorized error.

              • allow - Allow the request to be forwarded to the target.

              • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

          • Order (integer) --

            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. The final action to be performed must be a forward or a fixed-response action.

          • RedirectConfig (dict) --

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

            • Protocol (string) --

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

            • Port (string) --

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

            • Host (string) --

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

            • Path (string) --

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

            • Query (string) --

              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.

            • StatusCode (string) --

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

          • FixedResponseConfig (dict) --

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

            • MessageBody (string) --

              The message.

            • StatusCode (string) --

              The HTTP response code (2XX, 4XX, or 5XX).

            • ContentType (string) --

              The content type.

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

{'HealthCheckProtocol': {'TLS'}}

{'TargetGroups': {'HealthCheckProtocol': {'TLS'}, 'Protocol': {'TLS'}}}

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

To monitor the health of the targets, use DescribeTargetHealth.

See also: AWS API Documentation

Request Syntax

client.modify_target_group(
    TargetGroupArn='string',
    HealthCheckProtocol='HTTP'|'HTTPS'|'TCP'|'TLS',
    HealthCheckPort='string',
    HealthCheckPath='string',
    HealthCheckEnabled=True|False,
    HealthCheckIntervalSeconds=123,
    HealthCheckTimeoutSeconds=123,
    HealthyThresholdCount=123,
    UnhealthyThresholdCount=123,
    Matcher={
        'HttpCode': '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. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks.

If the protocol of the target group is TCP, 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 ping path that is the destination for the health check request.

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 Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.

If the protocol of the target group is TCP, 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.

If the protocol of the target group is TCP, 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 Network Load Balancers, this value must be the same as the healthy threshold count.

type Matcher:

dict

param Matcher:

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

If the protocol of the target group is TCP, you can't modify this setting.

• HttpCode (string) -- [REQUIRED]

  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–399.

rtype:

dict

returns:

Response Syntax

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

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.

      • VpcId (string) --

        The ID of the VPC for the targets.

      • HealthCheckProtocol (string) --

        The protocol to use to connect with the target.

      • 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 the health check request.

      • Matcher (dict) --

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

        • HttpCode (string) --

          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–399.

      • 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 (targets are specified by instance ID) or ip (targets are specified by IP address).