AwsSecretsManagerSettings

org.llm4s.llmconnect.auth.aws.AwsSecretsManagerSettings
See theAwsSecretsManagerSettings companion object
@Experimental
final case class AwsSecretsManagerSettings

Where AwsSecretsManagerApiKeyProvider reads an API key in AWS Secrets Manager (#2479): the secret secretId (its name or ARN) in region, either its whole SecretString or, with withField, one field of a SecretString that is a JSON object, as the console's key/value secrets are.

// the field apiKey of the key/value secret llm4s/openai, in eu-west-1
val settings = AwsSecretsManagerSettings("eu-west-1", AwsCredentials(accessKeyId, Secret(secretAccessKey)), "llm4s/openai")
 .withField("apiKey")
 .withRefreshInterval(1.minute)

Credentials that expire - an assumed role's, a pod identity's - are passed as a function, which is called again for every read from Secrets Manager: withCredentials(() => myCredentials()).

Value parameters

credentials

called once per read for the credentials that sign it; never printed by toString

endpoint

the Secrets Manager endpoint; https://secretsmanager.<region>.amazonaws.com by default, set for a VPC endpoint or a FIPS endpoint

field

the key of a JSON-object SecretString that holds the API key; none for the whole string

refreshInterval

how long a key read from Secrets Manager is used before it is read again

region

the AWS region, such as us-east-1; picks the endpoint and is part of the signature

requestTimeout

how long one read from Secrets Manager may take

secretId

the secret's name or ARN

versionStage

the version stage read: AWSCURRENT by default, the version rotation last promoted

Attributes

Companion
object
Source
AwsSecretsManagerSettings.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

The endpoint requests go to: endpoint, else the region's public one.

The endpoint requests go to: endpoint, else the region's public one.

Attributes

Source
AwsSecretsManagerSettings.scala

The secret's location, as secretId[#field]; holds nothing secret.

The secret's location, as secretId[#field]; holds nothing secret.

Attributes

Source
AwsSecretsManagerSettings.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
AwsSecretsManagerSettings.scala

Fixed credentials, used for every read.

Fixed credentials, used for every read.

Attributes

Source
AwsSecretsManagerSettings.scala

Credentials called for again on every read, for temporary ones that expire; a Left fails that read.

Credentials called for again on every read, for temporary ones that expire; a Left fails that read.

Attributes

Source
AwsSecretsManagerSettings.scala

The Secrets Manager endpoint, http(s)://host[:port], for a VPC or FIPS endpoint.

The Secrets Manager endpoint, http(s)://host[:port], for a VPC or FIPS endpoint.

Attributes

Source
AwsSecretsManagerSettings.scala

The Secrets Manager endpoint, or none for the region's public one.

The Secrets Manager endpoint, or none for the region's public one.

Attributes

Source
AwsSecretsManagerSettings.scala

The key of the JSON-object SecretString that holds the API key.

The key of the JSON-object SecretString that holds the API key.

Attributes

Source
AwsSecretsManagerSettings.scala

The key of the JSON-object SecretString that holds the API key, or none for the whole string.

The key of the JSON-object SecretString that holds the API key, or none for the whole string.

Attributes

Source
AwsSecretsManagerSettings.scala

How long a key read from Secrets Manager is used before it is read again.

How long a key read from Secrets Manager is used before it is read again.

Attributes

Source
AwsSecretsManagerSettings.scala

How long one read from Secrets Manager may take.

How long one read from Secrets Manager may take.

Attributes

Source
AwsSecretsManagerSettings.scala

The version stage read, such as AWSPENDING or a stage of your own.

The version stage read, such as AWSPENDING or a stage of your own.

Attributes

Source
AwsSecretsManagerSettings.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product