listener#

Autogenerated using pop-create-idem

hub.exec.boto3.client.elbv2.add_listener_certificates hub.exec.boto3.client.elbv2.create_listener hub.exec.boto3.client.elbv2.delete_listener hub.exec.boto3.client.elbv2.describe_listener_certificates hub.exec.boto3.client.elbv2.describe_listeners hub.exec.boto3.client.elbv2.describe_rules hub.exec.boto3.client.elbv2.modify_listener hub.exec.boto3.client.elbv2.remove_listener_certificates hub.exec.boto3.client.elbv2.remove_tags hub.exec.boto3.client.elbv2.describe_tags hub.exec.boto3.client.elbv2.add_tags

async idem_aws.states.aws.elbv2.listener.present(hub, ctx, name: str, lb_arn: str, default_actions: List[Action], resource_id: str = None, protocol: str = None, port: int = None, ssl_policy: str = None, default_certificates: List[Certificate] = None, certificates: List[Certificate] = None, alpn_policy: List[str] = None, tags: Dict[str, str] = None) → Dict[str, Any][source]#

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.

Parameters:

  • name (str) – IDEM name of the state.

  • resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None. The Amazon Resource Name (ARN) of the ElasticLoadBalancingv2 listener.

  • lb_arn (str) – The Amazon Resource Name (ARN) of the load balancer.

  • protocol (str, Optional) – 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 can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. Defaults to None.

  • port (int, Optional) – The port on which the load balancer is listening. You cannot specify a port for a Gateway LoadBalancer. Defaults to None.

  • ssl_policy (str, Optional) – [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. Defaults to None.

  • default_certificates (list[dict[str, Any]], Optional) –

    [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. Defaults to None.

    • CertificateArn (str, Optional):

      The Amazon Resource Name (ARN) of the certificate.

  • certificates (list[dict[str, Any]], Optional) –

    The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault .

    • CertificateArn (str, Optional): The Amazon Resource Name (ARN) of the certificate.

  • default_actions (list[dict[str, Any]]) –

    The actions for the default rule. * Type (str):

    The type of action.

    • TargetGroupArn (str, Optional):

      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[str, Any], Optional):

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

      • Issuer (str):

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

      • AuthorizationEndpoint (str):

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

      • TokenEndpoint (str):

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

      • UserInfoEndpoint (str):

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

      • ClientId (str):

        The OAuth 2.0 client identifier.

      • ClientSecret (str, Optional):

        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 (str, Optional):

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

      • Scope (str, Optional):

        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 (int, Optional):

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

      • AuthenticationRequestExtraParams (Dict[str, str], Optional):

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

      • OnUnauthenticatedRequest (str, Optional):
        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 IdP authorization endpoint. This is the default value.

      • UseExistingClientSecret (bool, Optional):

        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[str, Any], Optional):

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

      • UserPoolArn (str):

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

      • UserPoolClientId (str):

        The ID of the Amazon Cognito user pool client.

      • UserPoolDomain (str):

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

      • SessionCookieName (str, Optional):

        Name of the cookie used to maintain session information. Defaults to AWSELBAuthSessionCookie.

      • Scope (str, Optional):

        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 (int, Optional):

        Maximum duration of the authentication session, in seconds. Defaults to 604800 seconds (7days).

      • AuthenticationRequesstrraParams (dict[str, str], Optional):

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

      • OnUnauthenticatedRequest (str, Optional):
        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 (int, Optional):

      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[str, Any], Optional):

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

      • Protocol (str, Optional):

        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 (str, Optional):

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

      • Host (str, Optional):

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

      • Path (str, Optional):

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

      • Query (str, Optional):

        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 (str):

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

    • FixedResponseConfig (dict[str, Any], Optional):

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

      • MessageBody (str, Optional): The message.

      • StatusCode (str): The HTTP response code (2XX, 4XX, or 5XX).

      • ContentType (str, Optional):

        The content type. Valid Values: str/plain | str/css | str/html | application/javascript | application/json

    • ForwardConfig (dict[str, Any], Optional):

      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[dict[str, Any]], Optional):
        One or more target groups. For Network Load Balancers, you can specify a single target group.

        • TargetGroupArn (str, Optional): The Amazon Resource Name (ARN) of the target group.

        • Weight (int, Optional): The weight. The range is 0 to 999.

      • TargetGroupStickinessConfig (dict[str, Any], Optional):
        The target group stickiness for the rule.

        • Enabled (bool, Optional): Indicates whether target group stickiness is enabled.

        • DurationSeconds (int, Optional): 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).

  • alpn_policy (list[str], Optional) – [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

  • tags (dict[str, str], Optional) –

    The tags to assign to the listener. Defaults to None.

    • Key (str): The key of the tag.

    • Value (str, Optional): The value of the tag.

Request Syntax:
[listener-name]:
aws.elbv2.listener.present:

  • name: “string”

  • lb_arn: “string”

  • default_actions: “list”

  • resource_id: “string”

  • protocol: “string”

  • port: “integer”

  • ssl_policy: “string”

  • default_certificates: “list”

  • certificates: “list”

  • alpn_policy: “list”

  • tags:

    • ‘string’: “string”

Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.elbv2.listener.present:
    - name: 'my-listener'
    - lb_arn: 'arn:aws:elasticloadbalancing:us-west-2:45678908712456908:loadbalancer/app/my-load-balancer/50ghtc66t95c0c9188'
    - default_actions:
        - TargetGroupArn: arn:aws:elasticloadbalancing:us-west-2:45678908712456908:targetgroup/my-targets/73e2d6bc24d8a067
          Type: Type
    - resource_id: 'arn:aws:elasticloadbalancing:us-west-2:45678908712456908:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2'
    - protocol: 'HTTPS'
    - port: 443
    - ssl_policy: 'ELBSecurityPolicy-2015-05'
    - default_certificates:
        - CertificateArn: arn:aws:iam::45678908712456908:server-certificate/default-cert
    - certificates:
        - CertificateArn: arn:aws:iam::45678908712456908:server-certificate/my-server-cert
    - alpn_policy:
        - HTTP2Only
        - HTTP2Preferred
    - tags:
        name: my-listener
async idem_aws.states.aws.elbv2.listener.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached.

Parameters:

  • name (str) – Idem name of the ElasticLoadBalancingv2 Listener.

  • resource_id (str, Optional) – The Amazon Resource Name (ARN) of the ElasticLoadBalancingv2 listener.

Request Syntax:
[listener-name]:
aws.elbv2.listener.absent:

  • name: “string”

  • resource_id: “string”

Returns:

Dict[str, Any]

Examples

test_listener_name:
    aws.elbv2.listener.absent:
      - name: test_listener_name
      - resource_id: arn:aws:elasticloadbalancing:ua-west-2:45678908712456908:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2
async idem_aws.states.aws.elbv2.listener.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

  1. Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

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

  3. Users must specify one of the 2 params: list of listener ARNs or a load balancer ARN. Else, describe operation fails with the following error.

    ‘ClientError: An error occurred (ValidationError) when calling the DescribeListeners operation: You must specify either listener ARNs or a load balancer ARN’

Returns:

Dict[str, Any]

Examples

$ idem describe aws.elbv2.listener