StaticSecret

pydantic model phalanx.models.secrets.StaticSecret

Value of a static secret provided in a YAML file.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "StaticSecret",
   "description": "Value of a static secret provided in a YAML file.",
   "type": "object",
   "properties": {
      "description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Intended for human writers and ignored by tools",
         "title": "Description of secret"
      },
      "warning": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Any warnings humans need to know about when filling out this secret",
         "title": "Warning for humans"
      },
      "value": {
         "anyOf": [
            {
               "format": "password",
               "type": "string",
               "writeOnly": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Value of the secret, or `None` if it's not known",
         "title": "Value of secret"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

Fields:

• description (phalanx.yaml.YAMLFoldedString | None)

• value (pydantic.types.SecretStr | None)

• warning (phalanx.yaml.YAMLFoldedString | None)

field description: YAMLFoldedString | None = None

Intended for human writers and ignored by tools

field value: SecretStr | None = None

Value of the secret, or None if it’s not known

field warning: YAMLFoldedString | None = None

Any warnings humans need to know about when filling out this secret