ExAws.SecretsManager v2.0.0 ExAws.SecretsManager View Source

Operations on AWS Secrets Manager

Link to this section Summary

Functions

Cancel rotating a secret

Create a new secret

Describe a secret

Get random password

List all versions of a secret

List all secrets

Puts a new encrypted value in a secret

Restore a deleted secret

Configure rotating a secret

Attach a tag to a secret

Remove tags from a secret

Update details of a secret

Modify the staging labels attached to a version of a secret

Link to this section Types

Link to this type delete_secret_opts() View Source
delete_secret_opts() :: [{:recovery_window_in_days, integer()}]
Link to this type get_secret_value_opts() View Source
get_secret_value_opts() :: [version_id: binary(), version_stage: binary()]
Link to this type list_secret_version_ids_opts() View Source
list_secret_version_ids_opts() :: [
  include_deprecated: boolean(),
  max_results: integer(),
  next_token: binary()
]
Link to this type list_secrets_opts() View Source
list_secrets_opts() :: [max_results: integer(), next_token: binary()]
Link to this type put_secret_value_opts() View Source
put_secret_value_opts() :: [
  client_request_token: binary(),
  secret_binary: binary(),
  secret_string: binary(),
  version_stages: [binary()]
]
Link to this type rotate_secret_opts() View Source
rotate_secret_opts() :: [
  client_request_token: binary(),
  rotation_lambda_arn: binary(),
  rotation_rules: rotation_rules()
]
Link to this type rotation_rules() View Source
rotation_rules() :: [{:automatically_after_days, integer()}]
Link to this type tag() View Source
tag() :: [key: binary(), value: binary()]
Link to this type update_secret_opts() View Source
update_secret_opts() :: [
  client_request_token: binary(),
  description: binary(),
  kms_key_id: binary(),
  secret_binary: binary(),
  secret_string: binary()
]
Link to this type update_secret_version_stage_opts() View Source
update_secret_version_stage_opts() :: [
  move_to_version_id: binary(),
  remove_from_version_id: binary(),
  version_stage: binary()
]

Link to this section Functions

Link to this function cancel_rotate_secret(secret_id) View Source
cancel_rotate_secret(secret_id :: binary()) :: ExAws.Operation.JSON.t()

Cancel rotating a secret

Link to this function create_secret(opts \\ []) View Source
create_secret(opts :: Keyword.t()) :: ExAws.Operation.JSON.t()

Create a new secret

Link to this function delete_secret(secret_id, opts \\ []) View Source
delete_secret(secret_id :: binary(), opts :: delete_secret_opts()) ::
  ExAws.Operation.JSON.t()

Delete a secret

Link to this function describe_secret(secret_id) View Source
describe_secret(secret_id :: binary()) :: ExAws.Operation.JSON.t()

Describe a secret

Link to this function get_random_password(opts \\ []) View Source
get_random_password(opts :: Keyword.t()) :: ExAws.Operation.JSON.t()

Get random password

Link to this function get_secret_value(secret_id, opts \\ []) View Source
get_secret_value(secret_id :: binary(), opts :: get_secret_value_opts()) ::
  ExAws.Operation.JSON.t()

Get value of secret

Link to this function list_secret_version_ids(secret_id, opts \\ []) View Source
list_secret_version_ids(
  secret_id :: binary(),
  opts :: list_secret_version_ids_opts()
) :: ExAws.Operation.JSON.t()

List all versions of a secret

Link to this function list_secrets(opts \\ []) View Source
list_secrets(opts :: list_secrets_opts()) :: ExAws.Operation.JSON.t()

List all secrets

Link to this function put_secret_value(secret_id, opts \\ []) View Source
put_secret_value(secret_id :: binary(), opts :: put_secret_value_opts()) ::
  ExAws.Operation.JSON.t()

Puts a new encrypted value in a secret

Link to this function restore_secret(secret_id) View Source
restore_secret(secret_id :: binary()) :: ExAws.Operation.JSON.t()

Restore a deleted secret

Link to this function rotate_secret(secret_id, opts \\ []) View Source
rotate_secret(secret_id :: binary(), opts :: rotate_secret_opts()) ::
  ExAws.Operation.JSON.t()

Configure rotating a secret

Link to this function tag_resource(secret_id, tags) View Source
tag_resource(secret_id :: binary(), tags :: [tag()]) ::
  ExAws.Operation.JSON.t()

Attach a tag to a secret

Link to this function untag_resource(secret_id, tag_keys) View Source
untag_resource(secret_id :: binary(), tag_keys :: [binary()]) ::
  ExAws.Operation.JSON.t()

Remove tags from a secret

Link to this function update_secret(secret_id, opts \\ []) View Source
update_secret(secret_id :: binary(), opts :: update_secret_opts()) ::
  ExAws.Operation.JSON.t()

Update details of a secret

Link to this function update_secret_version_stage(secret_id, opts \\ []) View Source
update_secret_version_stage(
  secret_id :: binary(),
  opts :: update_secret_version_stage_opts()
) :: ExAws.Operation.JSON.t()

Modify the staging labels attached to a version of a secret