How do I incorporate a preexisting usage plan into an API stage using AWS CDK?

Question

How do I incorporate a preexisting usage plan into an API stage using AWS CDK?

In the CDK documentation, it is mentioned that an external usage plan can be imported using the static function called fromUsagePlanId. However, this returns an IUsagePlan interface which does not contain the method addApiStage to attach my API and its stage.

Here is a snippet of my code:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';

export class CdkApiGwTemplateStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const api = new apigateway.RestApi(this,`${domain.toLowerCase()}-${subDomain.toLowerCase()}`,{
      restApiName: `${domain.toLowerCase()}-${subDomain.toLowerCase()}`,
      description: apiDescription,
      binaryMediaTypes: binaryMediaTypes,
      deployOptions: {
        accessLogDestination: new LogGroupLogDestination(logGroup),
        loggingLevel: cloudwatchLoggingLevel.toUpperCase() as MethodLoggingLevel,
        stageName: environment.toLowerCase(),
        variables: variables,
      },
     });

    const key = api.addApiKey('ApiKey', {
      apiKeyName: apikeyName,
      description: apiKeyDescription,
    });

    const plan = apigateway.UsagePlan.fromUsagePlanId(this, 'getExternalUsagePlan', usagePlanId);

    plan.addApiKey(key);

I have tried searching for a CloudFormation level 1 construct to achieve this, but without success. Is there a way to use the addApiStage method of the UsagePlan constructor with the IUsagePlan interface, or any other idea on how to add my API to an existing Usage Plan?

typescript amazon-web-services aws-api-gateway aws-cdk infrastructure-as-code

Answer 1

Answer №1

After struggling to find a suitable ad-hoc solution, I decided to create my own custom construct. This custom construct utilizes a lambda resource provider to manage the lifecycle of resources. Special thanks to Jeffb4 for sharing this useful repository: https://github.com/stelligent/cloudformation-custom-resources/blob/master/lambda/python/customresource.py

Here's how you can use it:

usage_plan_id = "usage_id_here"
bind_usage_plan = BindUsagePlanConstruct(
    self, "BindUsagePlan", usage_plan_id, self.rest_api
)  # self.rest_api is of type apigateway.RestApi
bind_usage_plan.node.add_dependency(self.rest_api)

The construct itself looks like this:

from os import path
from aws_cdk import CustomResource, aws_lambda, RemovalPolicy, Duration, aws_iam
from aws_cdk import aws_logs
from aws_cdk.custom_resources import Provider
from constructs import Construct


class BindUsagePlanConstruct(Construct):
    def __init__(
        self, scope: Construct, _id: str, usage_plan_id: str, rest_api
    ) -> None:
        super().__init__(scope, _id)
        self._scope = scope._scope
        event_handler = self._create_lambda_function()
        provider = Provider(
            scope=self,
            id=f"{_id}Provider",
            on_event_handler=event_handler,
            log_retention=aws_logs.RetentionDays.ONE_DAY,
        )
        CustomResource(
            scope=self,
            id=f"{_id}UsagePlanBind",
            service_token=provider.service_token,
            removal_policy=RemovalPolicy.DESTROY,
            resource_type="Custom::UsagePlanBind",
            properties={
                "usage_plan_id": usage_plan_id,
                "api_gw_id": f"{rest_api.rest_api_id}",
                "api_gw_stage": f"{rest_api.deployment_stage.stage_name}",
            },
        )

    def _create_lambda_function(self):
        with open(
            path.join(path.dirname(__file__), "bind_usage_plan_lambda.py")
        ) as file:
            code = file.read()
        return aws_lambda.Function(
            self,
            f"{id}EventHandler",
            runtime=aws_lambda.Runtime.PYTHON_3_12,
            handler="index.on_event",
            code=aws_lambda.Code.from_inline(code),
            timeout=Duration.minutes(15),
            initial_policy=[
                aws_iam.PolicyStatement(
                    actions=[
                        "apigateway:GET",
                        "apigateway:POST",
                        "apigateway:DELETE",
                        "apigateway:PATCH",
                    ],
                    resources=[
                        f"arn:aws:apigateway:{self._scope.region}::/usageplans/*",
                        f"arn:aws:apigateway:{self._scope.region}::/usageplans/*/apiStages/*:prod",
                        f"arn:aws:apigateway:{self._scope.region}::/restapis/*",
                    ],
                )
            ],
        )

Additionally, here is the lambda function code:

import logging
from hashlib import sha224

LOGGER = logging.getLogger()
LOGGER.setLevel(logging.INFO)
import boto3

client = boto3.client("apigateway")

# Functionality for different request types - Create, Update, Delete

# Support functions for handling assignment and unassignment of usage plans

Answer 2

After struggling to find a suitable ad-hoc solution, I decided to create my own custom construct. This custom construct utilizes a lambda resource provider to manage the lifecycle of resources. Special thanks to Jeffb4 for sharing this useful repository: https://github.com/stelligent/cloudformation-custom-resources/blob/master/lambda/python/customresource.py

Here's how you can use it:

usage_plan_id = "usage_id_here"
bind_usage_plan = BindUsagePlanConstruct(
    self, "BindUsagePlan", usage_plan_id, self.rest_api
)  # self.rest_api is of type apigateway.RestApi
bind_usage_plan.node.add_dependency(self.rest_api)

The construct itself looks like this:

from os import path
from aws_cdk import CustomResource, aws_lambda, RemovalPolicy, Duration, aws_iam
from aws_cdk import aws_logs
from aws_cdk.custom_resources import Provider
from constructs import Construct


class BindUsagePlanConstruct(Construct):
    def __init__(
        self, scope: Construct, _id: str, usage_plan_id: str, rest_api
    ) -> None:
        super().__init__(scope, _id)
        self._scope = scope._scope
        event_handler = self._create_lambda_function()
        provider = Provider(
            scope=self,
            id=f"{_id}Provider",
            on_event_handler=event_handler,
            log_retention=aws_logs.RetentionDays.ONE_DAY,
        )
        CustomResource(
            scope=self,
            id=f"{_id}UsagePlanBind",
            service_token=provider.service_token,
            removal_policy=RemovalPolicy.DESTROY,
            resource_type="Custom::UsagePlanBind",
            properties={
                "usage_plan_id": usage_plan_id,
                "api_gw_id": f"{rest_api.rest_api_id}",
                "api_gw_stage": f"{rest_api.deployment_stage.stage_name}",
            },
        )

    def _create_lambda_function(self):
        with open(
            path.join(path.dirname(__file__), "bind_usage_plan_lambda.py")
        ) as file:
            code = file.read()
        return aws_lambda.Function(
            self,
            f"{id}EventHandler",
            runtime=aws_lambda.Runtime.PYTHON_3_12,
            handler="index.on_event",
            code=aws_lambda.Code.from_inline(code),
            timeout=Duration.minutes(15),
            initial_policy=[
                aws_iam.PolicyStatement(
                    actions=[
                        "apigateway:GET",
                        "apigateway:POST",
                        "apigateway:DELETE",
                        "apigateway:PATCH",
                    ],
                    resources=[
                        f"arn:aws:apigateway:{self._scope.region}::/usageplans/*",
                        f"arn:aws:apigateway:{self._scope.region}::/usageplans/*/apiStages/*:prod",
                        f"arn:aws:apigateway:{self._scope.region}::/restapis/*",
                    ],
                )
            ],
        )

Additionally, here is the lambda function code:

import logging
from hashlib import sha224

LOGGER = logging.getLogger()
LOGGER.setLevel(logging.INFO)
import boto3

client = boto3.client("apigateway")

# Functionality for different request types - Create, Update, Delete

# Support functions for handling assignment and unassignment of usage plans

Answer 3

Answer №2

To achieve this goal, there are various methods you can utilize based on how the resources were initially created (whether through Click-ops or CloudFormation).

One option is to utilize the newly launched IaC Generator to automatically create CloudFormation and CDK from existing resources. For more information, visit this link and here.
Another alternative is to use CDK migrate to import CloudFormation resources into your CDK stacks. Refer to this guide for detailed instructions.

Answer 4

To achieve this goal, there are various methods you can utilize based on how the resources were initially created (whether through Click-ops or CloudFormation).

One option is to utilize the newly launched IaC Generator to automatically create CloudFormation and CDK from existing resources. For more information, visit this link and here.
Another alternative is to use CDK migrate to import CloudFormation resources into your CDK stacks. Refer to this guide for detailed instructions.

How do I incorporate a preexisting usage plan into an API stage using AWS CDK?

Answer №1

Answer №2

Similar questions

Do you find this unattractive? What are some ways to improve this unsightly JavaScript statement?

Inject an asynchronous callback into the constructor of a class by leveraging TypeScript and Node with Passport integration

Angular is patiently awaiting the completion of the subscription

Triggering ngSubmit function when button is clicked inside an Ionic alert

What prevents TypeScript from allowing an async function to return a combination of type T or Promise<T>?

Does Vetur have additional undefined types in the type inference of deconstructed props?

One effective way to transfer state to a child component using function-based React

What is preventing me from retrieving a value from a member function or method within a TypeScript class instance?

Execute an npm script using a gulp task

1. "The power of three vows in the world

Creating dynamic Angular child routes with variable initial segment

Issue: The function (0, react__WEBPACK_IMPORTED_MODULE_1__.useActionState) is not recognized as a valid function or its output is not iterable

Utilizing props in styled-components: A beginner's guide

Angular 2 form with ng2-bootstrap modal component reset functionality

Creating a digital collection using Vue, Typescript, and Webpack

Retrieving the computed value created from an axios get request in Vue

ability to reach the sub-element dictionaries in typescript

Mapping arrays from objects using Next.js and Typescript

What strategies can I use to address the issue of requiring a type before it has been defined?

Develop a child interface within Typescript