Module `onnmisc.aws.secrets_manager`

Expand source code

import boto3
from botocore.exceptions import ClientError


def create_secret(name, secret_string, description='', tags=(), sm_client=None) -> None:
    """Description:
        Creates/updates a Secrets Manager secret

    Args:
        name: Name of the secret
        secret_string: Secret string
        description: Description of the secret
        tags: AWS tags
        sm_client: Boto3 client

    Example:
        Example usage:

            >>> from onnmisc.aws.secrets_manager import create_secret
            >>> from onnmisc.aws.cfn import dict_to_cfn_tags
            >>>
            >>> dict_tags = {'Name': 'Conformity', 'Team': 'Security'}
            >>> tags = dict_to_cfn_tags(dict_tags)
            >>> create_secret('Conformity', 'aaaaabbbbbccccc', description='Conformity API key', tags=tags)

    Returns:
        None

    """
    try:
        sm_client = sm_client if sm_client else boto3.client('secretsmanager')
        sm_client.create_secret(
            Name=name,
            Description=description,
            SecretString=secret_string,
            Tags=tags,
        )

        return

    except ClientError as e:
        msg = e.response['Error']['Message']
        if 'already exists' not in msg:
            raise

    # Create new version if secret already exists
    sm_client.put_secret_value(
        SecretId=name,
        SecretString=secret_string,
        VersionStages=['AWSCURRENT'],
    )

Functions

def create_secret(name, secret_string, description='', tags=(), sm_client=None) ‑> NoneType

Description

Creates/updates a Secrets Manager secret

Args

name: Name of the secret
secret_string: Secret string
description: Description of the secret
tags: AWS tags
sm_client: Boto3 client

Example

Example usage:

>>> from onnmisc.aws.secrets_manager import create_secret
>>> from onnmisc.aws.cfn import dict_to_cfn_tags
>>>
>>> dict_tags = {'Name': 'Conformity', 'Team': 'Security'}
>>> tags = dict_to_cfn_tags(dict_tags)
>>> create_secret('Conformity', 'aaaaabbbbbccccc', description='Conformity API key', tags=tags)

Returns

None

Expand source code

def create_secret(name, secret_string, description='', tags=(), sm_client=None) -> None:
    """Description:
        Creates/updates a Secrets Manager secret

    Args:
        name: Name of the secret
        secret_string: Secret string
        description: Description of the secret
        tags: AWS tags
        sm_client: Boto3 client

    Example:
        Example usage:

            >>> from onnmisc.aws.secrets_manager import create_secret
            >>> from onnmisc.aws.cfn import dict_to_cfn_tags
            >>>
            >>> dict_tags = {'Name': 'Conformity', 'Team': 'Security'}
            >>> tags = dict_to_cfn_tags(dict_tags)
            >>> create_secret('Conformity', 'aaaaabbbbbccccc', description='Conformity API key', tags=tags)

    Returns:
        None

    """
    try:
        sm_client = sm_client if sm_client else boto3.client('secretsmanager')
        sm_client.create_secret(
            Name=name,
            Description=description,
            SecretString=secret_string,
            Tags=tags,
        )

        return

    except ClientError as e:
        msg = e.response['Error']['Message']
        if 'already exists' not in msg:
            raise

    # Create new version if secret already exists
    sm_client.put_secret_value(
        SecretId=name,
        SecretString=secret_string,
        VersionStages=['AWSCURRENT'],
    )