certwrangler.solvers.lexicon module

pydantic model certwrangler.solvers.lexicon.LexiconSolver

Bases: Solver

Solver powered by lexicon.

A full list of available providers and options is available at: https://dns-lexicon.readthedocs.io/en/latest/configuration_reference.html

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "LexiconSolver",
   "description": "Solver powered by lexicon.\n\nA full list of available providers and options is available at:\nhttps://dns-lexicon.readthedocs.io/en/latest/configuration_reference.html",
   "type": "object",
   "properties": {
      "driver": {
         "const": "lexicon",
         "title": "Driver",
         "type": "string"
      },
      "zones": {
         "description": "A list of DNS zones this solver should be used for.",
         "items": {
            "pattern": "^(?:(\\*\\.|[a-zA-Z0-9])(?:[a-zA-Z0-9-_]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z0-9][A-Za-z0-9-_]{0,61}[A-Za-z]$",
            "type": "string"
         },
         "title": "Zones",
         "type": "array"
      },
      "provider_name": {
         "description": "The name of the lexicon provider to use.",
         "title": "Provider Name",
         "type": "string"
      },
      "provider_options": {
         "additionalProperties": true,
         "description": "Provider-specific options.",
         "title": "Provider Options",
         "type": "object"
      }
   },
   "required": [
      "driver",
      "zones",
      "provider_name"
   ]
}

Fields:

• driver (Literal['lexicon'])

• provider_name (str)

• provider_options (Dict[str, Any])

Validators:

field driver: Literal['lexicon'] [Required]

field provider_name: str [Required]

The name of the lexicon provider to use.

field provider_options: Dict[str, Any] [Optional]

Provider-specific options.

create(name: str, domain: str, content: str) → None

Create a TXT record based on the lexicon config.

Raises:

SolverError – Raised on failures creating the DNS record.

delete(name: str, domain: str, content: str) → None

Delete a TXT record based on the lexicon config.

Raises:

SolverError – Raised on failures deleting the DNS record.

_build_config(action: str, name: str, domain: str, content: str) → Dict[str, Any]

Generate the needed lexicon config for the request based on the action and the provider_options.