Elastic Load Balancing

{'Protocol': {'GENEVE'}}

{'Listeners': {'Protocol': {'GENEVE'}}}

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

For more information, see the following:

• Listeners for your Application Load Balancers

• Listeners for your Network Load Balancers

• Listeners for your Gateway Load Balancers

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.

See also: AWS API Documentation

Request Syntax

client.create_listener(
    LoadBalancerArn='string',
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    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',
                'UseExistingClientSecret': True|False
            },
            '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'
            },
            'ForwardConfig': {
                'TargetGroups': [
                    {
                        'TargetGroupArn': 'string',
                        'Weight': 123
                    },
                ],
                'TargetGroupStickinessConfig': {
                    'Enabled': True|False,
                    'DurationSeconds': 123
                }
            }
        },
    ],
    AlpnPolicy=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type LoadBalancerArn

string

param LoadBalancerArn

[REQUIRED]

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

type Protocol

string

param Protocol

The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You cannot specify a protocol for a Gateway Load Balancer.

type Port

integer

param Port

The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.

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 and Security policies in the Network Load Balancers Guide .

type Certificates

list

param Certificates

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

• (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 this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

type DefaultActions

list

param DefaultActions

[REQUIRED]

The actions for the default rule.

• (dict) --

  Information about an action.

  Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.

  • Type (string) -- [REQUIRED]

    The type of action.

  • TargetGroupArn (string) --

    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

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

      The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

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

    • UseExistingClientSecret (boolean) --

      Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

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

  • 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

  • ForwardConfig (dict) --

    Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .

    • TargetGroups (list) --

      One or more target groups. For Network Load Balancers, you can specify a single target group.

      • (dict) --

        Information about how traffic will be distributed between multiple target groups in a forward rule.

        • TargetGroupArn (string) --

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

        • Weight (integer) --

          The weight. The range is 0 to 999.

    • TargetGroupStickinessConfig (dict) --

      The target group stickiness for the rule.

      • Enabled (boolean) --

        Indicates whether target group stickiness is enabled.

      • DurationSeconds (integer) --

        The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

type AlpnPolicy

list

param AlpnPolicy

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN policies in the Network Load Balancers Guide .

• (string) --

type Tags

list

param Tags

The tags to assign to the listener.

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

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            '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',
                        'UseExistingClientSecret': True|False
                    },
                    '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'
                    },
                    'ForwardConfig': {
                        'TargetGroups': [
                            {
                                'TargetGroupArn': 'string',
                                'Weight': 123
                            },
                        ],
                        'TargetGroupStickinessConfig': {
                            'Enabled': True|False,
                            'DurationSeconds': 123
                        }
                    }
                },
            ],
            'AlpnPolicy': [
                '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) --

        [HTTPS or TLS listener] The default certificate for the listener.

        • (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 this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

      • SslPolicy (string) --

        [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.

          • Type (string) --

            The type of action.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

          • 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. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

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

            • UseExistingClientSecret (boolean) --

              Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

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

          • 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

          • ForwardConfig (dict) --

            Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .

            • TargetGroups (list) --

              One or more target groups. For Network Load Balancers, you can specify a single target group.

              • (dict) --

                Information about how traffic will be distributed between multiple target groups in a forward rule.

                • TargetGroupArn (string) --

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

                • Weight (integer) --

                  The weight. The range is 0 to 999.

            • TargetGroupStickinessConfig (dict) --

              The target group stickiness for the rule.

              • Enabled (boolean) --

                Indicates whether target group stickiness is enabled.

              • DurationSeconds (integer) --

                The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

      • AlpnPolicy (list) --

        [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

        • (string) --

{'Type': {'gateway'}}

{'LoadBalancers': {'Type': {'gateway'}}}

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

• Application Load Balancers

• Network Load Balancers

• Gateway Load Balancers

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

See also: AWS API Documentation

Request Syntax

client.create_load_balancer(
    Name='string',
    Subnets=[
        'string',
    ],
    SubnetMappings=[
        {
            'SubnetId': 'string',
            'AllocationId': 'string',
            'PrivateIPv4Address': 'string'
        },
    ],
    SecurityGroups=[
        'string',
    ],
    Scheme='internet-facing'|'internal',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Type='application'|'network'|'gateway',
    IpAddressType='ipv4'|'dualstack',
    CustomerOwnedIpv4Pool='string'
)

type Name

string

param Name

[REQUIRED]

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

type Subnets

list

param Subnets

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.

• (string) --

type SubnetMappings

list

param SubnetMappings

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.

• (dict) --

  Information about a subnet mapping.

  • SubnetId (string) --

    The ID of the subnet.

  • AllocationId (string) --

    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.

  • PrivateIPv4Address (string) --

    [Network Load Balancers] The private IPv4 address for an internal load balancer.

type SecurityGroups

list

param SecurityGroups

[Application Load Balancers] The IDs of the security groups for the load balancer.

• (string) --

type Scheme

string

param Scheme

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

You cannot specify a scheme for a Gateway Load Balancer.

type Tags

list

param Tags

The tags to assign to the load balancer.

• (dict) --

  Information about a tag.

  • Key (string) -- [REQUIRED]

    The key of the tag.

  • Value (string) --

    The value of the tag.

type Type

string

param Type

The type of load balancer. The default is application .

type IpAddressType

string

param IpAddressType

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4 .

type CustomerOwnedIpv4Pool

string

param CustomerOwnedIpv4Pool

[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

rtype

dict

returns

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerArn': 'string',
            'DNSName': 'string',
            'CanonicalHostedZoneId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LoadBalancerName': 'string',
            'Scheme': 'internet-facing'|'internal',
            'VpcId': 'string',
            'State': {
                'Code': 'active'|'provisioning'|'active_impaired'|'failed',
                'Reason': 'string'
            },
            'Type': 'application'|'network'|'gateway',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string',
                    'OutpostId': 'string',
                    'LoadBalancerAddresses': [
                        {
                            'IpAddress': 'string',
                            'AllocationId': 'string',
                            'PrivateIPv4Address': 'string'
                        },
                    ]
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • LoadBalancers (list) --

    Information about the load balancer.

    • (dict) --

      Information about a load balancer.

      • LoadBalancerArn (string) --

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

      • DNSName (string) --

        The public DNS name of the load balancer.

      • CanonicalHostedZoneId (string) --

        The ID of the Amazon Route 53 hosted zone associated with the load balancer.

      • CreatedTime (datetime) --

        The date and time the load balancer was created.

      • LoadBalancerName (string) --

        The name of the load balancer.

      • Scheme (string) --

        The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

        The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      • VpcId (string) --

        The ID of the VPC for the load balancer.

      • State (dict) --

        The state of the load balancer.

        • Code (string) --

          The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .

        • Reason (string) --

          A description of the state.

      • Type (string) --

        The type of load balancer.

      • AvailabilityZones (list) --

        The subnets for the load balancer.

        • (dict) --

          Information about an Availability Zone.

          • ZoneName (string) --

            The name of the Availability Zone.

          • SubnetId (string) --

            The ID of the subnet. You can specify one subnet per Availability Zone.

          • OutpostId (string) --

            [Application Load Balancers on Outposts] The ID of the Outpost.

          • LoadBalancerAddresses (list) --

            [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.

            • (dict) --

              Information about a static IP address for a load balancer.

              • IpAddress (string) --

                The static IP address.

              • AllocationId (string) --

                [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.

              • PrivateIPv4Address (string) --

                [Network Load Balancers] The private IPv4 address for an internal load balancer.

      • SecurityGroups (list) --

        The IDs of the security groups for the load balancer.

        • (string) --

      • IpAddressType (string) --

        The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

      • CustomerOwnedIpv4Pool (string) --

        [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

{'HealthCheckProtocol': {'GENEVE'}, 'Protocol': {'GENEVE'}}

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

Creates a target group.

For more information, see the following:

• Target groups for your Application Load Balancers

• Target groups for your Network Load Balancers

• Target groups for your Gateway Load Balancers

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',
    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 or ip , 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 /AWS.ALB/healthcheck.

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 and 30 seconds. If the target type is instance or ip , 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.

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',
            '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), or lambda (register a single Lambda function as a target).

      • ProtocolVersion (string) --

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

{'Listeners': {'Protocol': {'GENEVE'}}}

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway 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'|'UDP'|'TCP_UDP'|'GENEVE',
            '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',
                        'UseExistingClientSecret': True|False
                    },
                    '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'
                    },
                    'ForwardConfig': {
                        'TargetGroups': [
                            {
                                'TargetGroupArn': 'string',
                                'Weight': 123
                            },
                        ],
                        'TargetGroupStickinessConfig': {
                            'Enabled': True|False,
                            'DurationSeconds': 123
                        }
                    }
                },
            ],
            'AlpnPolicy': [
                '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) --

        [HTTPS or TLS listener] The default certificate for the listener.

        • (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 this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

      • SslPolicy (string) --

        [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.

          • Type (string) --

            The type of action.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

          • 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. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

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

            • UseExistingClientSecret (boolean) --

              Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

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

          • 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

          • ForwardConfig (dict) --

            Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .

            • TargetGroups (list) --

              One or more target groups. For Network Load Balancers, you can specify a single target group.

              • (dict) --

                Information about how traffic will be distributed between multiple target groups in a forward rule.

                • TargetGroupArn (string) --

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

                • Weight (integer) --

                  The weight. The range is 0 to 999.

            • TargetGroupStickinessConfig (dict) --

              The target group stickiness for the rule.

              • Enabled (boolean) --

                Indicates whether target group stickiness is enabled.

              • DurationSeconds (integer) --

                The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

      • AlpnPolicy (list) --

        [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

        • (string) --

  • NextMarker (string) --

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

{'LoadBalancers': {'Type': {'gateway'}}}

Describes the specified load balancers or all of your load balancers.

See also: AWS API Documentation

Request Syntax

client.describe_load_balancers(
    LoadBalancerArns=[
        'string',
    ],
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

type LoadBalancerArns

list

param LoadBalancerArns

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

• (string) --

type Names

list

param Names

The names of the load balancers.

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

{
    'LoadBalancers': [
        {
            'LoadBalancerArn': 'string',
            'DNSName': 'string',
            'CanonicalHostedZoneId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LoadBalancerName': 'string',
            'Scheme': 'internet-facing'|'internal',
            'VpcId': 'string',
            'State': {
                'Code': 'active'|'provisioning'|'active_impaired'|'failed',
                'Reason': 'string'
            },
            'Type': 'application'|'network'|'gateway',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string',
                    'OutpostId': 'string',
                    'LoadBalancerAddresses': [
                        {
                            'IpAddress': 'string',
                            'AllocationId': 'string',
                            'PrivateIPv4Address': 'string'
                        },
                    ]
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  • LoadBalancers (list) --

    Information about the load balancers.

    • (dict) --

      Information about a load balancer.

      • LoadBalancerArn (string) --

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

      • DNSName (string) --

        The public DNS name of the load balancer.

      • CanonicalHostedZoneId (string) --

        The ID of the Amazon Route 53 hosted zone associated with the load balancer.

      • CreatedTime (datetime) --

        The date and time the load balancer was created.

      • LoadBalancerName (string) --

        The name of the load balancer.

      • Scheme (string) --

        The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

        The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      • VpcId (string) --

        The ID of the VPC for the load balancer.

      • State (dict) --

        The state of the load balancer.

        • Code (string) --

          The state code. The initial state of the load balancer is provisioning . After the load balancer is fully set up and ready to route traffic, its state is active . If the load balancer could not be set up, its state is failed .

        • Reason (string) --

          A description of the state.

      • Type (string) --

        The type of load balancer.

      • AvailabilityZones (list) --

        The subnets for the load balancer.

        • (dict) --

          Information about an Availability Zone.

          • ZoneName (string) --

            The name of the Availability Zone.

          • SubnetId (string) --

            The ID of the subnet. You can specify one subnet per Availability Zone.

          • OutpostId (string) --

            [Application Load Balancers on Outposts] The ID of the Outpost.

          • LoadBalancerAddresses (list) --

            [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.

            • (dict) --

              Information about a static IP address for a load balancer.

              • IpAddress (string) --

                The static IP address.

              • AllocationId (string) --

                [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.

              • PrivateIPv4Address (string) --

                [Network Load Balancers] The private IPv4 address for an internal load balancer.

      • SecurityGroups (list) --

        The IDs of the security groups for the load balancer.

        • (string) --

      • IpAddressType (string) --

        The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

      • CustomerOwnedIpv4Pool (string) --

        [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

  • NextMarker (string) --

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

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

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',
            '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), or lambda (register a single Lambda function 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.

{'Protocol': {'GENEVE'}}

{'Listeners': {'Protocol': {'GENEVE'}}}

Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

See also: AWS API Documentation

Request Syntax

client.modify_listener(
    ListenerArn='string',
    Port=123,
    Protocol='HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
    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',
                'UseExistingClientSecret': True|False
            },
            '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'
            },
            'ForwardConfig': {
                'TargetGroups': [
                    {
                        'TargetGroupArn': 'string',
                        'Weight': 123
                    },
                ],
                'TargetGroupStickinessConfig': {
                    'Enabled': True|False,
                    'DurationSeconds': 123
                }
            }
        },
    ],
    AlpnPolicy=[
        '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. You cannot specify a port for a Gateway 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, TLS, UDP, and TCP_UDP protocols. You cannot specify a protocol for a Gateway Load Balancer.

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 or Security policies in the Network Load Balancers Guide .

type Certificates

list

param Certificates

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

• (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 this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

type DefaultActions

list

param DefaultActions

The actions for the default rule.

• (dict) --

  Information about an action.

  Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.

  • Type (string) -- [REQUIRED]

    The type of action.

  • TargetGroupArn (string) --

    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

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

      The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

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

    • UseExistingClientSecret (boolean) --

      Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

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

  • 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

  • ForwardConfig (dict) --

    Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .

    • TargetGroups (list) --

      One or more target groups. For Network Load Balancers, you can specify a single target group.

      • (dict) --

        Information about how traffic will be distributed between multiple target groups in a forward rule.

        • TargetGroupArn (string) --

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

        • Weight (integer) --

          The weight. The range is 0 to 999.

    • TargetGroupStickinessConfig (dict) --

      The target group stickiness for the rule.

      • Enabled (boolean) --

        Indicates whether target group stickiness is enabled.

      • DurationSeconds (integer) --

        The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

type AlpnPolicy

list

param AlpnPolicy

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN policies in the Network Load Balancers Guide .

• (string) --

rtype

dict

returns

Response Syntax

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'LoadBalancerArn': 'string',
            'Port': 123,
            'Protocol': 'HTTP'|'HTTPS'|'TCP'|'TLS'|'UDP'|'TCP_UDP'|'GENEVE',
            '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',
                        'UseExistingClientSecret': True|False
                    },
                    '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'
                    },
                    'ForwardConfig': {
                        'TargetGroups': [
                            {
                                'TargetGroupArn': 'string',
                                'Weight': 123
                            },
                        ],
                        'TargetGroupStickinessConfig': {
                            'Enabled': True|False,
                            'DurationSeconds': 123
                        }
                    }
                },
            ],
            'AlpnPolicy': [
                '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) --

        [HTTPS or TLS listener] The default certificate for the listener.

        • (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 this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

      • SslPolicy (string) --

        [HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.

      • DefaultActions (list) --

        The default actions for the listener.

        • (dict) --

          Information about an action.

          Each rule must include exactly one of the following types of actions: forward , fixed-response , or redirect , and it must be the last action to be performed.

          • Type (string) --

            The type of action.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

          • 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. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

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

            • UseExistingClientSecret (boolean) --

              Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

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

          • 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

          • ForwardConfig (dict) --

            Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward . If you specify both ForwardConfig and TargetGroupArn , you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn .

            • TargetGroups (list) --

              One or more target groups. For Network Load Balancers, you can specify a single target group.

              • (dict) --

                Information about how traffic will be distributed between multiple target groups in a forward rule.

                • TargetGroupArn (string) --

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

                • Weight (integer) --

                  The weight. The range is 0 to 999.

            • TargetGroupStickinessConfig (dict) --

              The target group stickiness for the rule.

              • Enabled (boolean) --

                Indicates whether target group stickiness is enabled.

              • DurationSeconds (integer) --

                The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).

      • AlpnPolicy (list) --

        [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

        • (string) --

{'HealthCheckProtocol': {'GENEVE'}}

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

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. The TCP protocol 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 /AWS.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',
            '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), or lambda (register a single Lambda function as a target).

      • ProtocolVersion (string) --

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