Package: aws-secretsmanager-caching
AWS Secrets Manager Python caching clientThe AWS Secrets Manager Python caching client enables in-process caching of secrets for Python applications.Getting StartedRequired PrerequisitesTo use this client you must have:Python 3.6 or newer.  Use of Python versions 3.5 or older are not supported.An Amazon Web Services (AWS) account to access secrets stored in AWS Secrets Manager.To create an AWS account, go toSign In or Create an AWS Accountand then chooseI am a new user.Follow the instructions to create an AWS account.To create a secret in AWS Secrets Manager, go toCreating Secretsand follow the instructions on that page.This library makes use of botocore, the low-level core functionality of the boto3 SDK.  For more information on boto3 and botocore, please review theAWS SDK for PythonandBotocoredocumentation.DependenciesThis library requires the following standard dependencies:botocoresetuptools_scmFor development and testing purposes, this library requires the following additional dependencies:pytestpytest-covpytest-sugarcodecovpylintsphinxPlease review therequirements.txtanddev-requirements.txtfile for specific version requirements.InstallationInstalling the latest release viapip:$pipinstallaws-secretsmanager-cachingInstalling the latest development release:$gitclonehttps://github.com/aws/aws-secretsmanager-caching-python.git
$cdaws-secretsmanager-caching-python
$pythonsetup.pyinstallDevelopmentGetting StartedAssuming that you have Python and virtualenv installed, set up your environment and install the required dependencies like this instead of thepip install aws_secretsmanager_cachingdefined above:$gitclonehttps://github.com/aws/aws-secretsmanager-caching-python.git
$cdaws-secretsmanager-caching-python
$virtualenvvenv
...
$.venv/bin/activate
$pipinstall-rrequirements.txt-rdev-requirements.txt
$pipinstall-e.Running TestsYou can run tests in all supported Python versions using tox. By default, it will run all of the unit and integration tests, but you can also specify your own arguments to past topytest.$tox# runs integ/unit tests, flake8 tests and pylint tests$tox--test/unit/test_decorators.py# runs specific test file$tox-epy37--test/integ/# runs specific test directoryDocumentationYou can locally-generate the Sphinx-based documentation via:$tox-edocsWhich will subsequently be viewable atfile://${CLONE_DIR}/.tox/docs_out/index.htmlUsageUsing the client consists of the following steps:Instantiate the client while optionally passing in aSecretCacheConfig()object to theconfigparameter.  You can also pass in an existingbotocore.client.BaseClientclient to the client parameter.Request the secret from the client instance.importbotocoreimportbotocore.sessionfromaws_secretsmanager_cachingimportSecretCache,SecretCacheConfigclient=botocore.session.get_session().create_client('secretsmanager')cache_config=SecretCacheConfig()# See below for defaultscache=SecretCache(config=cache_config,client=client)secret=cache.get_secret_string('mysecret')Cache ConfigurationYou can configure the cache config object with the following parameters:max_cache_size- The maximum number of secrets to cache.  The default value is1024.exception_retry_delay_base- The number of seconds to wait after an exception is encountered and before retrying the request.  The default value is1.exception_retry_growth_factor- The growth factor to use for calculating the wait time between retries of failed requests.  The default value is2.exception_retry_delay_max- The maximum amount of time in seconds to wait between failed requests.  The default value is3600.default_version_stage- The default version stage to request.  The default value is'AWSCURRENT'secret_refresh_interval- The number of seconds to wait between refreshing cached secret information.  The default value is3600.0.secret_cache_hook- An implementation of the SecretCacheHook abstract class.  The default value isNone.DecoratorsThe library also includes several decorator functions to wrap existing function calls with SecretString-based secrets:@InjectedKeywordedSecretString- This decorator expects the secret id and cache as the first and second arguments, with subsequent arguments mapping a parameter key from the function that is being wrapped to a key in the secret.  The secret being retrieved from the cache must contain a SecretString and that string must be JSON-based.@InjectSecretString- This decorator also expects the secret id and cache as the first and second arguments.  However, this decorator simply returns the result of the cache lookup directly to the first argument of the wrapped function.  The secret does not need to be JSON-based but it must contain a SecretString.fromaws_secretsmanager_cachingimportSecretCachefromaws_secretsmanager_cachingimportInjectKeywordedSecretString,InjectSecretStringcache=SecretCache()@InjectKeywordedSecretString(secret_id='mysecret',cache=cache,func_username='username',func_password='password')deffunction_to_be_decorated(func_username,func_password):print('Something cool is being done with the func_username and func_password arguments here')...@InjectSecretString('mysimplesecret',cache)deffunction_to_be_decorated(arg1,arg2,arg3):# arg1 contains the cache lookup result of the 'mysimplesecret' secret.# arg2 and arg3, in this example, must still be passed when calling function_to_be_decorated().Getting HelpWe use GitHub issues for tracking bugs and caching library feature requests and have limited bandwidth to address them. Please use these community resources for getting help:Ask a question onStack Overflowand tag it withaws-secrets-manager.Open a support ticket withAWS Supportif it turns out that you may have found a bug, pleaseopen an issue.LicenseThis library is licensed under the Apache 2.0 License.