runway.cfngin.hooks.staticsite.auth_at_edge.user_pool_id_retriever module¶

Retrieve the ID of the Cognito User Pool.

pydantic model runway.cfngin.hooks.staticsite.auth_at_edge.user_pool_id_retriever.HookArgs[source]¶

Bases: HookArgsBaseModel

Hook arguments.

Show JSON schema

{
   "title": "HookArgs",
   "description": "Hook arguments.",
   "type": "object",
   "properties": {
      "tags": {
         "additionalProperties": {
            "type": "string"
         },
         "default": {},
         "title": "Tags",
         "type": "object"
      },
      "created_user_pool_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Created User Pool Id"
      },
      "user_pool_arn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "User Pool Arn"
      }
   }
}

field created_user_pool_id: str | None = None¶: The ID of the created Cognito User Pool.

field user_pool_arn: str | None = None¶: The ARN of the supplied User pool.

runway.cfngin.hooks.staticsite.auth_at_edge.user_pool_id_retriever.get(*__args: Any, **kwargs: Any) → dict[str, Any][source]¶

Retrieve the ID of the Cognito User Pool.

The User Pool can either be supplied via an ARN or by being generated. If the user has supplied an ARN that utilize that, otherwise retrieve the generated id. Used in multiple pre_hooks for Auth@Edge.

Arguments parsed by HookArgs.