Table of Contents

Class CredentialRotationOptions

Namespace
Excalibur.Data.ElasticSearch.Security
Assembly
Excalibur.Data.ElasticSearch.dll

Configures automatic credential rotation and lifecycle management.

public sealed class CredentialRotationOptions
Inheritance
CredentialRotationOptions
Inherited Members

Properties

Enabled

Gets a value indicating whether automatic credential rotation is enabled.

public bool Enabled { get; init; }

Property Value

bool

True to enable automatic credential rotation, false for manual rotation only.

MaxRetries

Gets the number of times a failed scheduled rotation is retried before it is abandoned until the next interval.

public int MaxRetries { get; init; }

Property Value

int

The retry count. Defaults to 3. Zero makes a single attempt and does not retry.

Remarks

A scheduled rotation that makes one attempt leaves credentials un-rotated for a whole RotationInterval -- up to thirty days by default -- because one request happened to fail. The retries are attempted within the interval, so a transient failure costs seconds rather than a rotation period.

RetryDelay

Gets the base delay before the first retry of a failed scheduled rotation.

public TimeSpan RetryDelay { get; init; }

Property Value

TimeSpan

The base delay. Defaults to 30 seconds. Backoff is exponential with jitter.

RotationInterval

Gets the rotation interval for credentials.

public TimeSpan RotationInterval { get; init; }

Property Value

TimeSpan

The time interval between automatic credential rotations. Defaults to 30 days.

WarningThreshold

Gets the rotation warning threshold.

public TimeSpan WarningThreshold { get; init; }

Property Value

TimeSpan

The time before rotation to issue warnings. Defaults to 7 days.