aws_credentials/types

Types

Error types that can occur when fetching credentials

pub type CredentialError {
  NoCredentials
  ServiceNotStarted
  FetchError(reason: String)
}

Constructors

  • NoCredentials

    No credentials could be found in any provider

  • ServiceNotStarted

    The credentials service is not started

  • FetchError(reason: String)

    An error occurred while fetching credentials

AWS Credentials containing access keys and optional session token

pub type Credentials {
  Credentials(
    credential_provider: String,
    access_key_id: String,
    secret_access_key: String,
    token: option.Option(String),
    region: option.Option(String),
  )
}

Constructors

  • Credentials(
      credential_provider: String,
      access_key_id: String,
      secret_access_key: String,
      token: option.Option(String),
      region: option.Option(String),
    )

    Arguments

    credential_provider

    The credential provider that supplied these credentials

    access_key_id

    AWS access key ID

    secret_access_key

    AWS secret access key

    token

    Optional session token for temporary credentials

    region

    Optional AWS region

Options that can be passed to force refresh

pub opaque type RefreshOptions

Values

pub fn get_options(
  options: RefreshOptions,
) -> List(#(String, String))

Get the options list (for internal use)

pub fn new_refresh_options() -> RefreshOptions

Create empty refresh options

pub fn with_option(
  options: RefreshOptions,
  key: String,
  value: String,
) -> RefreshOptions

Add an option to refresh options

Search Document