Skip to main content
  1. Docs
  2. Secrets & Configuration
  3. Providers
  4. Rotators
  5. passphrase

passphrase

    The passphrase rotator enables you to rotate any user-defined key in your ESC environment by generating memorable passphrases.

    If you want to generate random passwords use the password rotator

    Example

    The passphrase rotator can be configured for any user-defined key.

    values:
      mypassphrase:
        fn::rotate::passphrase:
          inputs:
            separator: "%"
            capitalize: true
            length: 4
    

    This configuration will generate passphrases like Mouth%Purebred%Headstone%Plausibly.

    When you open the environment, you should see output similar to the following:

    {
      "mypassphrase": {
        "current": "[secret]",
        "previous": "[secret]"
      }
    }
    

    Schema reference

    Reference schemas last updated on 2026-07-11, synced automatically from the Pulumi Cloud ESC API.

    Inputs

    Options for generating memorable passphrases.

    • capitalize boolean optional
      Whether or not to capitalize each word.
    • length number optional
      The number of words in the generated passphrase.
    • separator string optional
      The character to use to separate words.

    State

    • current string optional
      The most recently generated passphrase.
    • previous string optional
      The prior generated passphrase.

    Outputs

    • current string optional
      The most recently generated passphrase.
    • previous string optional
      The prior generated passphrase.

    Troubleshooting

    SymptomLikely causeResolution
    Rotation fails with an invalid input errorlength is outside 3–15, or separator is not a single character.Set length within range and separator to a single character, then rotate again.
    The generated passphrase is shorter or longer than expectedlength counts words, not characters.Adjust length to the desired number of words; the character count varies with the words chosen.