runway.cfngin.hooks.staticsite.auth_at_edge.callback_url_retriever module

Callback URL Retriever.

Dependency pre-hook responsible for ensuring correct callback urls are retrieved or a temporary one is used in it’s place.

pydantic model runway.cfngin.hooks.staticsite.auth_at_edge.callback_url_retriever.HookArgs

Bases: HookArgsBaseModel

Hook arguments.

Show JSON schema

{
   "title": "HookArgs",
   "description": "Hook arguments.",
   "type": "object",
   "properties": {
      "tags": {
         "additionalProperties": {
            "type": "string"
         },
         "default": {},
         "title": "Tags",
         "type": "object"
      },
      "stack_name": {
         "title": "Stack Name",
         "type": "string"
      },
      "user_pool_arn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "User Pool Arn"
      }
   },
   "required": [
      "stack_name"
   ]
}

field stack_name: str = PydanticUndefined

The name of the stack to check against.

field user_pool_arn: str | None = None

The ARN of the User Pool to check for a client.

runway.cfngin.hooks.staticsite.auth_at_edge.callback_url_retriever.get(context: runway.context.CfnginContext, *_args: Any, **kwargs: Any) → dict[str, Any]

Retrieve the callback URLs for User Pool Client Creation.

When the User Pool is created a Callback URL is required. During a post hook entitled client_updater these Callback URLs are updated to that of the Distribution. Before then we need to ensure that if a Client already exists that the URLs for that client are used to prevent any interruption of service during deploy.

Arguments parsed by HookArgs.

Parameters:

• context – The context instance.

• **kwargs – Arbitrary keyword arguments.