Question 18845 in Amazon Web Sevices Question posted in
The official Amazon Web Services documentation can be found here.

How to export already created (via web console) services to CDK locally and be able to deploy/update them? – Amazon Web Sevices

Current situation:

I have an AWS API Gateway referencing some AWS Lambdas, and some Lambdas querying a DynamoDB instance.

All of the above are created and handled manually via the AWS web console. There’s no cloudformation template for that.

^ I want to be able to have that locally too using CDK:

I want to apply some healthy developer procedures and create a CDK file system locally, for testing, manage deployment, manage versioning via GitHub or whatever AWS has to offer in that field (didn’t get to that part yet).

I noticed that there is 0% information on how to do that. Most tutorials follow a situation where:

  1. i am creating a cdk from scratch locally
  2. or already have a cloudformation structure.

Please help me figure our the best proper way to do that.
Some things that came up but didn’t actually do:

  • Do i just init a cdk and name services the same as my current services to "take over them"?
  • or will they get re-written ( = total disaster).
  • Is there a way to export a code sample for each service i currently have and connect them with each other?
Tags:

2

Answers


  1. 0

    You must import existing resource’s to CDK.

    https://link.medium.com/1RbcEdal4wb

    Login or Signup to reply.
  2. 0

    TL;DR Use cdk import for supported resources. Re-create the RestApi from an exported OpenApi Definition.

    cdk import

    The CDK has experimental import functionality to bring existing console-created resources under CDK management. The cdk import CLI command piggybacks off the related CloudFormation resource import operation.

    Not all resources support the import operation. The AWS::Lambda::Function and AWS::DynamoDB::Table resources are supported. You must also consider secondary resources, such as the Lambda’s execution role (AWS::IAM::Role is supported for importing).

    Resource importing starts with manually configuring a CDK stack that matches the existing cloud-side configuration. To guide your work, say, on recreating a dynamodb.Table in CDK, consider running the DescribeTable API to get a dump of the current configuration. Because of the manual work involved, it’s wise to focus your importing energies on stateful resources and consider simply destroying and recreating stateless resources.

    Once the app is complete, run the cdk import command. After that, the imported resources can be modified like any other CDK resource.

    CDK RestApi from an exported OpenApi Definition

    AWS::ApiGateway::RestApi is not on the list of supported resources for import1. A Plan B for your Api Gateway is to export your API as an OpenAPI defnition2. Then pass the JSON as the API definition to CDK RestApi construct with the ApiDefinition.fromAsset method. This will create a new API, not import it per se.

    1. Although the RestApi resource itself is not supported for importing, many related AWS::ApiGateway resources are, such as Resource, Stage, Model and Method.
    2. See the AWS How do I migrate API Gateway REST APIs between AWS accounts or Regions? for a non-CDK use case.
    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search