sagemaker.serve.ai_inference_recommender.secrets

sagemaker.serve.ai_inference_recommender.secrets#

Helper for creating AWS Secrets Manager secrets.

Classes

Secret(arn[, _created, _session])

A handle to a Secrets Manager secret.
class sagemaker.serve.ai_inference_recommender.secrets.Secret(arn: str, _created: bool = False, _session: Any | None = None)[source]#

Bases: object

A handle to a Secrets Manager secret.

Supports context-manager use. On context exit, only a secret this object created (via from_string()) is deleted; a secret you merely wrapped by ARN is left untouched.

arn: str#
delete(*, force_delete_without_recovery: bool = False, session: boto3.session.Session | None = None) → None[source]#

Delete the underlying Secrets Manager secret.

Parameters:

  • force_delete_without_recovery – If True, delete immediately with no recovery window. Defaults to False, which uses Secrets Manager’s recovery window so an accidental delete can be restored.

  • session – Optional boto3 session. Defaults to the session that created this secret, then to the ambient session.

classmethod from_string(value: str, *, name: str | None = None, session: boto3.session.Session | None = None) → Secret[source]#

Create a new Secrets Manager secret from a plaintext value.

Note: this helper creates the secret with default permissions only. If the consuming workload needs to read the secret at job runtime, you may need to attach a resource policy granting secretsmanager:GetSecretValue to the appropriate principal.

Parameters:

  • value – The plaintext secret value to store.

  • name – Optional secret name. Defaults to sagemaker-workload-<uuid>.

  • session – Optional boto3 session. Defaults to the ambient session.

Returns:

A Secret referencing the newly created secret.

Contents