Boto3を使ってAWS Secrets Managerの特定のシークレットを更新する方法

課題： Pythonのboto3ライブラリを使用して、AWS Secrets Manager（シークレットマネージャー）の特定の場所に保存されているシークレットキーを更新します。

問題を解決するための手順・アルゴリズム

• ステップ1： boto3とbotocoreの例外クラスをインポートし、例外処理に備えます。

• ステップ2： 必須パラメータはsecret_stored_location（シークレットの保存場所）とsecret_key_pair（シークレットのキーと値のペア）です。注意点として、secret_key_pairは辞書型ではなく文字列（string）として渡す必要があります。

• ステップ3： boto3ライブラリを使ってAWSセッションを作成します。デフォルトプロファイルにregion_nameが設定されていない場合は、セッション作成時に明示的にregion_nameを指定してください。

• ステップ4： secretmanager用のAWSクライアントを作成します。

• ステップ5： update_secretを呼び出し、secret_stored_locationをSecretIdに、secret_key_pairをSecretStringとして渡します。

• ステップ6： 更新されたシークレットのメタデータが返却されます。

• ステップ7： シークレットの更新中に何らかの問題が発生した場合に備え、汎用的な例外処理を実装しておきます。

サンプルコード

AWS Secrets Manager内のシークレットを更新するには、以下のコードを使用します。

import boto3
from botocore.exceptions import ClientError

def update_secret_details(secret_stored_location, secret_key_pair):
    session = boto3.session.Session()
    s3_client = session.client('secretmanager')
    try:
        response = s3_client.update_secret(SecretId=secret_stored_location, SecretString=secret_key_pair)
        return response
    except ClientError as e:
        raise Exception("boto3 client error in update_secret_details: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in update_secret_details: " + e.__str__())

a = update_secret_details('/secrets/aws', '{"user_test1":"test"}')
print(a)

出力結果

{'ARN': 'arn:aws:secretsmanager:us-east-1:***************:secret:/secrets/aws-wr1Aj6', 'Name': '/secrets/aws', 'VersionId': 'f5308bed-7c23-4d47-a32b-8f2a5f044e53', 'ResponseMetadata': {'RequestId': 'b32fe48d**************ab', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Sat, 03 Apr 2021 09:40:48 GMT', 'content-type': 'application/x-amz-json-1.1', 'content-length': '197', 'connection': 'keep-alive', 'x-amzn-requestid': *********************************}, 'RetryAttempts': 0}}