Credentials#

UserPasswordCredentials#

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

Bases: Credentials

Initialize the UserPasswordCredentials object.

Parameters:

  • user – The user.

  • password – The password

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

Initialize the AzureAccountNameKeyCredentials object.

Parameters:

  • account_name – The Azure account name.

  • account_key – The Azure account key.

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

Initialize the S3AccessKeyCredentials object.

Parameters:

  • aws_access_key_id – The AWS access key id.

  • aws_secret_access_key – The AWS secret access key.

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

Keep a secret in plain text.

Parameters:

secret_direct_value – 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]#

Bases: Secret

Get a secret from an Environment variable.

Parameters:

  • environment_variable_name – Name of the environment variable from which

  • value. (we will obtain the secret)

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

File Formats#