Credentials#

UserPasswordCredentials#

class UserPasswordCredentials(user: str | dict | Secret, password: str | dict | Secret)[source]#

Bases: Credentials

Credentials class to store a user and password pair.

user#

The user.

Type:: Secret

password#

The password.

Type:: Secret

to_dict() → dict[source]#: Convert the UserPasswordCredentials object to a dictionary.

property password: Secret#

The password.

Type:: Secret

property user: Secret#

The user.

Type:: Secret

Azure Credentials#

class AzureAccountKeyCredentials(account_name: str | dict | Secret, account_key: str | dict | Secret)[source]#

Bases: AzureCredentials

Credentials class to store the credentials needed to access an Azure using account key credentials (account name and account key).

account_name#

The Azure account name.

Type:: Secret

account_key#

The Azure account key.

Type:: Secret

to_dict() → dict[source]#: Convert the AzureAccountNameKeyCredentials object to a dictionary

ACCOUNT_KEY_KEY = 'account_key'#

property account_key: Secret#

The Azure account key.

Type:: Secret

property account_name: Secret#

The Azure account name.

Type:: Secret

S3 Credentials#

class S3AccessKeyCredentials(aws_access_key_id: str | dict | Secret, aws_secret_access_key: str | dict | Secret)[source]#

Bases: S3Credentials

Credentials class to store the credentials needed to access an S3 bucket using access key credentials (access key id and secret access key).

aws_access_key_id#

The AWS access key id.

Type:: Secret

aws_secret_access_key#

The AWS secret access key.

Type:: Secret

to_dict() → dict[source]#: Convert the S3AccessKeyCredentials object to a dictionary

property aws_access_key_id: Secret#

The AWS access key id.

Type:: Secret

property aws_secret_access_key: Secret#

The AWS secret access key.

Type:: Secret

Secret#

class Secret[source]#

Bases: ABC

Secrets class to store the credentials needed to access different services.

Direct Secret#

class DirectSecret(secret_direct_value: str)[source]#

Bases: Secret

Secrets class representing a secret stored in plain text.

secret_direct_value#

The secret value.

Type:: str

to_dict() → dict[source]#: Convert the DirectSecret object to a dictionary.

secret_value() → str#: Get the secret value.

property secret_value: str#

Get the secret value pointed at by the secret. To be used only during execution in the backend.

Returns:: The secret value.
Return type:: str

Environment Secret#

class EnvironmentSecret(environment_variable_name: str)[source]#