| Overview |  |
create_secret_option() = {add_replica_regions, replica_regions()} | {client_request_token, binary()} | {description, binary()} | {force_overwrite_replica_secret, boolean()} | {kms_key_id, binary()} | {secret_binary, binary()} | {secret_string, binary()} | {tags, proplist()}
create_secret_options() = [create_secret_option()]
delete_secret_option() = {force_delete_without_recovery, boolean()} | {recovery_window_in_days, pos_integer()}
If none of these two options are specified then SM defaults to 30 day recovery window
delete_secret_options() = [delete_secret_option()]
get_secret_value_option() = {version_id | version_stage, binary()}
get_secret_value_options() = [get_secret_value_option()]
put_resource_policy_option() = {block_public_policy, boolean()}
put_resource_policy_options() = [put_resource_policy_option()]
put_secret_value_option() = {client_request_token, binary()} | {secret_binary, binary()} | {secret_string, binary()} | {version_stages, [binary()]}
put_secret_value_options() = [put_secret_value_option()]
replica_region() = [proplist()]
replica_regions() = [replica_region()]
sm_response() = {ok, proplists:proplist()} | {error, term()}
create_secret_binary(Name::binary(), ClientRequestToken::binary(), SecretBinary::binary()) -> sm_response()
Creates a new secret binary. The function internally base64-encodes the binary as it is expected by the AWS SecretManager API, so raw blob is expected to be passed as an attribute.
ClientRequestToken is used by AWS for secret versioning purposes. It is recommended to be a UUID type value, and is requred to be between 32 and 64 characters.
To store a text secret use CreateSecret - SecretString version of the function instead.
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html
create_secret_binary(Name::binary(), ClientRequestToken::binary(), SecretBinary::binary(), Opts::create_secret_options()) -> sm_response()
create_secret_binary(Name::binary(), ClientRequestToken::binary(), SecretBinary::binary(), Opts::create_secret_options(), Config::aws_config()) -> sm_response()
create_secret_string(Name::binary(), ClientRequestToken::binary(), SecretString::binary()) -> sm_response()
Creates a new secret string. The API expects SecretString is a text data to encrypt and store in the SecretManager. It is recommended a JSON structure of key/value pairs is used for the secret value.
ClientRequestToken is used by AWS for secret versioning purposes. It is recommended to be a UUID type value, and is requred to be between 32 and 64 characters.
To store a binary (which will be base64 encoded by the library, as it is expected by AWS SecretManager API), use CreateSecret - SecretBinary version of the function.
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html
create_secret_string(Name::binary(), ClientRequestToken::binary(), SecretString::binary(), Opts::create_secret_options()) -> sm_response()
create_secret_string(Name::binary(), ClientRequestToken::binary(), SecretString::binary(), Opts::create_secret_options(), Config::aws_config()) -> sm_response()
delete_resource_policy(SecretId::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteResourcePolicy.html
delete_resource_policy(SecretId::binary(), Config::aws_config()) -> sm_response()
delete_secret(SecretId::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html
delete_secret(SecretId::binary(), Opts::delete_secret_options()) -> sm_response()
delete_secret(SecretId::binary(), Opts::delete_secret_options(), Config::aws_config()) -> sm_response()
describe_secret(SecretId::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DescibeSecret.html
describe_secret(SecretId::binary(), Config::aws_config()) -> sm_response()
get_resource_policy(SecretId::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetResourcePolicy.html
get_resource_policy(SecretId::binary(), Config::aws_config()) -> sm_response()
get_secret_value(SecretId::binary(), Opts::get_secret_value_options()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html
get_secret_value(SecretId::binary(), Opts::get_secret_value_options(), Config::aws_config()) -> sm_response()
new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()
put_resource_policy(SecretId::binary(), ResourcePolicy::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_PutResourcePolicy.html
put_resource_policy(SecretId::binary(), ResourcePolicy::binary(), Opts::put_resource_policy_options()) -> sm_response()
put_resource_policy(SecretId::binary(), ResourcePolicy::binary(), Opts::put_resource_policy_options(), Config::aws_config()) -> sm_response()
put_secret_binary(SecretId::binary(), ClientRequestToken::binary(), SecretBinary::binary()) -> sm_response()
put_secret_binary(SecretId::binary(), ClientRequestToken::binary(), SecretBinary::binary(), Opts::put_secret_value_options()) -> sm_response()
put_secret_binary(SecretId::binary(), ClientRequestToken::binary(), SecretBinary::binary(), Opts::put_secret_value_options(), Config::aws_config()) -> sm_response()
put_secret_string(SecretId::binary(), ClientRequestToken::binary(), SecretString::binary()) -> sm_response()
SM API:
https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_PutSecretValue.html
put_secret_string(SecretId::binary(), ClientRequestToken::binary(), SecretString::binary(), Opts::put_secret_value_options()) -> sm_response()
put_secret_string(SecretId::binary(), ClientRequestToken::binary(), SecretString::binary(), Opts::put_secret_value_options(), Config::aws_config()) -> sm_response()
Generated by EDoc