roboto.domain.secrets.record

Module Contents

AwsSecretRetrievalLocation

class roboto.domain.secrets.record.AwsSecretRetrievalLocation(/, **data)#

Bases: pydantic.BaseModel

Information required to retrieve a secret from AWS Secrets Manager.

Parameters

data Any

Attributes

AwsSecretRetrievalLocation.arn

arn str #

ARN of the secret.

AwsSecretRetrievalLocation.store_type

store_type Literal[SecretStoreType] #

Type of secret store. Referenced here explicitly to make deserialization work better.

AwsSecretsManagerAccessCreds

class roboto.domain.secrets.record.AwsSecretsManagerAccessCreds(/, **data)#

Bases: pydantic.BaseModel

Context required to update a secret in AWS Secrets Manager.

Parameters

data Any

Attributes

AwsSecretsManagerAccessCreds.access_key_id

access_key_id str #

AWS access key ID.

AwsSecretsManagerAccessCreds.region

region str #

AWS region.

AwsSecretsManagerAccessCreds.secret_access_key

secret_access_key str #

AWS secret access key.

AwsSecretsManagerAccessCreds.session_token

session_token str #

AWS session token.

AwsSecretsManagerAccessCreds.store_type

store_type Literal[SecretStoreType] #

Type of secret store. Referenced here explicitly to make deserialization work better.

CreateSecretRequest

class roboto.domain.secrets.record.CreateSecretRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for the Create Secret

Parameters

data Any

Attributes

CreateSecretRequest.name

name str #

Name of the secret.

GetSecretAccessCredsResponse

class roboto.domain.secrets.record.GetSecretAccessCredsResponse(/, **data)#

Bases: pydantic.BaseModel

Response payload for the Update Secret

Parameters

data Any

Attributes

GetSecretAccessCredsResponse.creds

creds SecretAccessCreds = None #

Creds required to update the secret in its underlying data store.

GetSecretAccessCredsResponse.record

record SecretRecord #

The secret whose value is going to be updated.

SecretAccessCreds

roboto.domain.secrets.record.SecretAccessCreds#

Union type for all possible secret update contexts.

SecretRecord

class roboto.domain.secrets.record.SecretRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a secret.

Parameters

data Any

Attributes

SecretRecord.created

created datetime.datetime #

Timestamp when the secret was created.

SecretRecord.created_by

created_by str #

RobotoPrincipal which created the secret.

SecretRecord.last_used

last_used datetime.datetime | None = None #

Timestamp when the secret was last used in an action, or None if the secret has never been used.

SecretRecord.location

location SecretRetrievalLocation = None #

Information required to dereference the secret in its specific secret store. This is used in combination with temporary hyper-downscoped access creds to update or retrieve the secret’s value.

SecretRecord.modified

modified datetime.datetime #

Timestamp when the secret was last modified.

SecretRecord.modified_by

modified_by str #

RobotoPrincipal which last modified the secret.

SecretRecord.name

name str #

Name of the secret. Secret names must be unique within an organization.

SecretRecord.org_id

org_id str #

Organization ID that owns the secret.

SecretRecord.store_type

store_type SecretStoreType #

Type of secret store.

SecretRetrievalLocation

roboto.domain.secrets.record.SecretRetrievalLocation#

Union type for all possible secret retrieval locations.

SecretStoreType

class roboto.domain.secrets.record.SecretStoreType#

Bases: roboto.compat.StrEnum

Type of secret store.

Attributes

SecretStoreType.AWS

AWS = 'aws' #

AWS Secrets Manager.