Struct CredentialProcessProvider

pub struct CredentialProcessProvider { /* private fields */ }

Available on crate feature credentials-process only.

External process credentials provider

This credentials provider runs a configured external process and parses its output to retrieve credentials.

The external process must exit with status 0 and output the following JSON format to stdout to provide credentials:

{
    "Version:" 1,
    "AccessKeyId": "access key id",
    "SecretAccessKey": "secret access key",
    "SessionToken": "session token",
    "Expiration": "time that the expiration will expire"
}

The Version must be set to 1. AccessKeyId and SecretAccessKey are always required. SessionToken must be set if a session token is associated with the AccessKeyId. The Expiration is optional, and must be given in the RFC 3339 date time format (e.g., 2022-05-26T12:34:56.789Z).

If the external process exits with a non-zero status, then the contents of stderr will be output as part of the credentials provider error message.

This credentials provider is included in the profile credentials provider, and can be configured using the credential_process attribute. For example:

[profile example]
credential_process = /path/to/my/process --some --arguments

Implementations

impl CredentialProcessProvider

pub fn new(command: String) -> Self

Create new CredentialProcessProvider with the command needed to execute the external process.

Trait Implementations

impl Debug for CredentialProcessProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ProvideCredentials for CredentialProcessProvider

fn provide_credentials<'a>(&'a self) -> ProvideCredentials<'a>

where Self: 'a,

Returns a future that provides credentials.

fn fallback_on_interrupt(&self) -> Option<Credentials>

Returns fallback credentials.