fn::rotate
The fn::rotate built-in function invokes a rotator to rotate secrets.
Some of a rotator’s inputs may only be evaluated when the environment containing the fn::rotate invocation is rotated. This can be combined with the environments built-in value to fetch managing credentials from other environments that may require additional permissions beyond those given to typical users of an environment. The exact inputs that are rotation-only depend on the rotator; see Managing credentials and rotate-only inputs for more information.
Declaration
fn::rotate:
provider: name
inputs: inputs
state: state
Short form
In addition to the long form syntax, fn::rotate can be invoked using the short form fn::rotate::name:
fn::rotate::name:
inputs: inputs
state: state
Parameters
| Property | Type | Description |
|---|---|---|
provider | string | The name of the rotator to use. In the short form, the name is part of the function key (fn::rotate::name) and this key is omitted. |
inputs | any | The inputs to the rotator. The exact type is rotator-dependent. |
state | any | The persistent state for the rotator. This value is managed by the rotator and should not be modified. |
Returns
The return value of fn::rotate is dependent on the rotator being invoked.