Metadata-Version: 2.1
Name: aws-cdk-secure-api
Version: 0.1.2
Summary: A CDK (v2) Construct Library for Secure REST APIs
Home-page: https://github.com/rnag/aws-cdk-secure-api
Author: Ritvik Nag
Author-email: rv.kvetch@gmail.com
License: MIT
Project-URL: Documentation, https://aws-cdk-secure-api.readthedocs.io
Project-URL: Source, https://github.com/rnag/aws-cdk-secure-api
Description: ==================
        aws-cdk-secure-api
        ==================
        
        
        .. image:: https://img.shields.io/pypi/v/aws-cdk-secure-api.svg
                :target: https://pypi.org/project/aws-cdk-secure-api
        
        .. image:: https://img.shields.io/pypi/pyversions/aws-cdk-secure-api.svg
                :target: https://pypi.org/project/aws-cdk-secure-api
        
        .. image:: https://github.com/rnag/aws-cdk-secure-api/actions/workflows/dev.yml/badge.svg
                :target: https://github.com/rnag/aws-cdk-secure-api/actions/workflows/dev.yml
        
        .. image:: https://readthedocs.org/projects/aws-cdk-secure-api/badge/?version=latest
                :target: https://aws-cdk-secure-api.readthedocs.io/en/latest/?version=latest
                :alt: Documentation Status
        
        
        .. image:: https://pyup.io/repos/github/rnag/aws-cdk-secure-api/shield.svg
             :target: https://pyup.io/repos/github/rnag/aws-cdk-secure-api/
             :alt: Updates
        
        
        An unofficial `AWS CDK v2`_ Construct Library for Secure REST APIs.
        
        * Documentation: https://aws-cdk-secure-api.readthedocs.io.
        
        .. _`AWS CDK v2`: https://aws.amazon.com/about-aws/whats-new/2021/12/aws-cloud-development-kit-cdk-generally-available/
        
        Secure Rest Api
        ---------------
        
        The ``SecureRestApi`` construct creates a (public) REST API secured behind an API key, which needs to be
        specified in the ``x-api-key`` header for all requests.
        
        Install
        -------
        
        .. code-block:: console
        
            pip install aws-cdk-secure-api
        
        Features
        --------
        
        * A CDK Construct which sets up a `RestApi`_ secured behind an API key.
        * An API key is `auto-generated`_ and stored in SSM Parameter Store (which is
          a free service) as needed.
        * Local cache for the API key, so that API calls are not needed in future
          CDK deployments.
        * Helper methods for ``SecureRestApi``, to make it easier to
          integrate a method for an AWS Lambda function for example.
        
        .. _`RestApi`: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html
        .. _`auto-generated`: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetRandomPassword.html
        
        Usage
        -----
        
        The ``SecureRestApi`` construct represents a Secure REST API in Amazon API Gateway.
        
            Use ``add_resource``, ``add_lambda_methods``, and ``add_methods`` to
            configure the API model, as shown below.
        
        .. code:: python3
        
            from aws_cdk_secure_api import Http, SecureRestApi
            from aws_cdk import (aws_apigateway as apigw, aws_lambda as lambda_)
        
            get_handler = lambda_.Function(self, 'lambda1', runtime=lambda_.Runtime.PYTHON_3_9, ...)
            put_handler = lambda_.Function(self, 'lambda2', runtime=lambda_.Runtime.PYTHON_3_9, ...)
        
            api = SecureRestApi(
                self, 'api',
                rest_api_name='My Secure Service',
                # optional: specify a deployment stage
                deploy_options=apigw.StageOptions(stage_name='dev')
            )
        
            api.add_lambda_methods(get_handler, 'GET')                # GET /
            api.add_lambda_methods(put_handler, Http.PUT, Http.POST)  # PUT /, POST /
        
        
        AWS Profile
        -----------
        
        Note that if you normally pass the ``--profile`` to the ``cdk`` tool, for example such as::
        
            cdk deploy --profile my-aws-profile
        
        The CDK construct won't be able to detect the AWS profile in this particular case.
        A few workarounds can be used for this:
        
        1. The environment variable ``AWS_PROFILE`` can be set before calling the ``cdk`` tool.
        2. The ``profile`` attribute can be passed in to the ``config`` parameter for ``SecureRestApi``.
        3. The ``profile`` context variable can be passed in to the ``cdk`` tool,
           as shown below::
        
               cdk deploy --profile my-profile -c profile=my-profile
        
        API Keys
        --------
        
        Here is the process that the CDK construct uses for generating
        or using an API key for a REST API.
        
        1. First, it tries to read the API key from local cache, which is located in your
           home directory, under ``~/.cdk/cache/apigw_api_keys.json``.
        2. If an API key is found, then it proceeds to use the cached key value, and *does not*
           perform the following steps.
        3. An API call is made to read the key from AWS SSM Parameter Store. The param
           name is ``/{STACK NAME}/api-key``, where ``{STACK NAME}`` is the name of the CDK stack.
        4. If the parameter does not exist, an random API key value is auto-generated, and a new
           SSM Parameter is created in the same AWS account and region that the CDK stack is deployed to.
        5. The API key value is then cached on the local drive, under the ``~/.cdk/cache`` folder.
        
        Stack Outputs
        -------------
        
        The following *stack outputs* will additionally be added to the CDK stack:
        
        * ``APIEndpoint`` - The base endpoint of the Secure REST API.
        
          * *Note:* this output will not show up if ``override_endpoint_name`` is disabled
            in the ``config`` parameter.
        
        * ``APIKey`` - The API key for the endpoint, which needs to be specified
          as a value in an HTTP request's ``x-api-key`` header.
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `rnag/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
        .. _`rnag/cookiecutter-pypackage`: https://github.com/rnag/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.1 (2022-06-24)
        ------------------
        
        **Bugfixes**
        
        * Remove ``typing.Literal`` usage, so code is compatible with Python 3.7
        * Add an import ``from __future__ import annotations`` to modules where it was missing.
        
        **Features and Improvements**
        
        * Update to use the string value of the ``name`` attribute for a ``Http`` Enum member,
          instead of the ``value`` attribute.
        
        0.1.0 (2022-06-24)
        ------------------
        
        * First release on PyPI.
        
Keywords: aws-cdk,secure,rest-api,api-gateway,api key,cdk
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst
