feat(cli): CDK Migrate CLI command #27325

HBobertz · 2023-09-27T19:46:27Z

Added CDK migrate command. Here is what it looks like in md

`cdk migrate`

⚠️CAUTION⚠️

CDK migrate is currently experimental and may have breaking changes in the future.

Generates a CDK application using an existing CloudFormation template in JSON or YAML format.
Templates can be provided from either from a local file using --from-path or directly from a
deployed CloudFormation stack with --from-stack. The generated CDK application will
synthesize a CloudFormation template with identical resource configurations to the provided template.
The generated application will be initialized in the current working directory with a single stack where
the stack, app, and directory will all be named using the provided --stack-name. It will also
be within a generated subdirectory in your current working directory unless --output-path is specified.
If a directory already exists with the same name as --stack-name, it will be replaced with the new application.
All CDK supported languages are supported, language choice can be specified with --language.

Generate a typescript application from a local template.json file

$ # template.json is a valid cloudformation template in the local directory
$ cdk migrate --stack-name MyAwesomeApplication --language typescript --from-path MyTemplate.json

This command will generate a new directory named MyAwesomeApplication within your current working directory, and
then initialize a new CDK application within that directory which has the same resource configuration
as the provided template.json

This results in a CDK application with the following structure, where the lib directory contains a stack definition
with the same resource configuration as the provided template.json.

├── README.md
├── bin
│   └── my_awesome_application.ts
├── cdk.json
├── jest.config.js
├── lib
│   └── my_awesome_application-stack.ts
├── package.json
├── tsconfig.json

Generate a python application from a deployed stack

If you already had a CloudFormation stack deployed in your account and would like to migrate to using CDK instead of CloudFormation.
You can use the --from-stack option to generate the application. In this case the --stack-name must match the name of the deployed stack.

$ # generate a python application from MyDeployedStack in your account
$ cdk bootstrap migrate --stack-name MyDeployedStack --language python --from-stack

This will generate a Python CDK application which will synthesize the same configuration of resources as the deployed stack.

CDK Migrate Limitations

CDK Migrate does not currently support nested stacks, custom resources, or the Fn::ForEach intrinsic function.
CDK Migrate will only generate L1 constructs and does not currently support any higher level abstractions.
CDK Migrate successfully generating an application does not guarantee the application is immediately deployable.
It simply generates a CDK application which will synthesize a template that has identical resource configurations
to the provided template.
CDK Migrate does not interact with the CloudFormation service to verify the template
provided can deploy on its own. This means CDK Migrate will not verify that any resources in the provided
template are already managed in other CloudFormation templates, nor will it verify that the resources in the provided
template are available in the desired regions, which may impact ADC or Opt-In regions.
If the provided template has parameters without default values, those will need to be will need to be provided
before deploying the generated application.

In practice this is how CDK Migrate generated applications will operate in the following scenarios:

Situation	Result
Provided Template + stack-name is from a deployed stack in the account/region	The CDK application will deploy as a changeset to the existing stack
Provided Template has no overlap with resources already in the account/region	The CDK application will deploy a new stack successfully
Provided Template has overlap with Cloudformation managed resources already in the account/region	The CDK application will not be deployable unless those resources are removed
Provided Template has overlap with unmanaged resources already in the account/region	The CDK application will not be deployable until those resources are adopted with CDK Import

The provided template is already deployed to CloudFormation in the account/region

If the provided template came directly from a deployed CloudFormation stack, and that stack has not experienced any drift,
then the generated application will be immediately deployable, and will not cause any changes to the deployed resources.
Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the AWS Console or AWS CLI.

**The provided template is not deployed to CloudFormation in the account/region, and there is not overlap with existing resources in the account/region**

If the provided template represents a set of resources that have no overlap with resources already deployed in the account/region,
then the generated application will be immediately deployable. This could be because the stack has never been deployed, or
the application was generated from a stack deployed in another account/region.

In practice this means for any resource in the provided template, for example,

    "S3Bucket": {
      "Type": "AWS::S3::Bucket",
      "Properties": {
        "BucketName": "MyBucket",
        "AccessControl": "PublicRead",
      },
      "DeletionPolicy": "Retain"
    }

There must not exist a resource of that type with the same identifier in the desired region. In this example that identifer
would be "MyBucket"

The provided template is not deployed to CloudFormation in the account/region, and there is overlap with existing resources in the account/region

If the provided template represents a set of resources overlap with resources already deployed in the account/region,
then the generated application will not be immediately deployable. If those overlapped resources are already managed by
another CloudFormation stack in that account/region, then those resources will need to be manually removed from the provided
template. Otherwise, if the overlapped resources are not managed by another CloudFormation stack, then first run remove those
resources and deploy the template successfully, then re-add them and run cdk import to import them into your deployed stack.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

madeline-k · 2023-09-27T20:10:10Z

packages/aws-cdk/README.md

@@ -746,6 +746,32 @@ NOTICES
 If you don’t want to see a notice anymore, use "cdk acknowledge <id>". For example, "cdk acknowledge 16603".
 ```

+### `cdk migrate`
+
+⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.


Experimental means that it might have breaking changes in the future. Saying we make no guarantees about the commands output sounds like the command may or may not do what the documentation says, and that is not the case.

Reusing the exact phrasing from another experimental command:

Suggested change

⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.

⚠️**CAUTION**⚠️ This command is considered experimental, and might have breaking changes in the future.

This is what we currently output when a user runs our command. Should we change it in both places?

I would be in favor of that, yes

madeline-k · 2023-09-27T20:11:20Z

packages/aws-cdk/README.md

+
+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 
+Required Arguments:
+* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice


Absolute paths should also work.

Suggested change

* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice

* `--from-path <my_file_path>` - The file path to the JSON or YAML CloudFormation template

madeline-k · 2023-09-27T20:11:29Z

packages/aws-cdk/README.md

+
+⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.
+
+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 


Suggested change

Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages.

Generates a CDK application from an existing CloudFormation template in any of the CDK supported languages.

madeline-k · 2023-09-27T20:12:51Z

packages/aws-cdk/README.md

+* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice
+* `--stack-name <my_stack_name>` - Used to name both the CDK application and stack. 
+Optional Arguments:
+* `--output-path <my_output_path>` - file path to where the file should be generated. 


Suggested change

* `--output-path <my_output_path>` - file path to where the file should be generated.

* `--output-path <my_output_path>` - file path where the application will be generated

madeline-k · 2023-09-27T20:19:02Z

packages/aws-cdk/README.md

+Required Arguments:
+* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice
+* `--stack-name <my_stack_name>` - Used to name both the CDK application and stack. 
+Optional Arguments:


This is supposed to be a title - but will show inline and this will all be one paragraph.

madeline-k · 2023-09-27T20:19:24Z

packages/aws-cdk/README.md

+⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.
+
+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 
+Required Arguments:


In md, this will be inlined with the following lines, and not look like a title.

madeline-k · 2023-09-27T20:19:49Z

packages/aws-cdk/README.md

@@ -746,6 +746,32 @@ NOTICES
 If you don’t want to see a notice anymore, use "cdk acknowledge <id>". For example, "cdk acknowledge 16603".
 ```

+### `cdk migrate`


This section is under the "Notices" section. Can you move it up to the "Commands" section?

isn't CDK notices the command?

no. there is a section header for Notices with cdk notices and cdk acknowledge both under it. If you view this file as rendered markdown, it is clear that this command is not in the right section.

madeline-k · 2023-09-27T20:20:50Z

packages/aws-cdk/README.md

+$ cdk bootstrap migrate --from-path ./template.json --stack-name MyAwesome
+```
+
+In order for the generated stack to be immediatly deployable, that stack must either already exist in that region/account 


put a header above this that says "Limitations" like other commands have done (import)

Overall this section is pretty confusing, but I am struggling to come up with better phrasing here. I imagine customers will read this and ask, what does it mean to be immediately deployable? How do I know if there is any overlap between existing resources and resources defined in the input template?

An idea to improve clarity would be to separate this into describing the two use cases that work: 1. deploying to an environment with a deployed stack that matches the input template. 2. deploy to an environment with no deployed resources that overlap with your template definition.
Then finally, include the limitations section saying if you try to deploy a stack generated by CDK migrate to an environment that meets any of the following criteria, deployment will fail.

resources with the same physical ids already exist

a partially-matching stack already exists.

madeline-k · 2023-09-27T20:21:46Z

packages/aws-cdk/README.md

+⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.
+
+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 
+Required Arguments:


Can you add a paragraph above this that explains in more detail what the command is and how to use it? Think about how you would teach someone who is new to CDK how to use this command to get started with CDK.

comcalvi · 2023-09-27T20:14:41Z

packages/aws-cdk/README.md

@@ -746,6 +746,32 @@ NOTICES
 If you don’t want to see a notice anymore, use "cdk acknowledge <id>". For example, "cdk acknowledge 16603".
 ```

+### `cdk migrate`
+
+⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.


Suggested change

⚠️**CAUTION**⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.

⚠️ **CAUTION** ⚠️

CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.

comcalvi · 2023-09-27T20:15:48Z

packages/aws-cdk/README.md

+
+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 
+Required Arguments:
+* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice


Suggested change

* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice

* `--from-path <my_file_path>` - Takes the relative file path to the JSON or YAML CloudFormation template

comcalvi · 2023-09-27T20:17:01Z

packages/aws-cdk/README.md

+Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages. 
+Required Arguments:
+* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice
+* `--stack-name <my_stack_name>` - Used to name both the CDK application and stack. 


How is it used? Is it used verbatim? Is there a transformation that's applied? Is the CDK App name === the stack name?

At this point the CDK App name === the stack name. We want to change this later. I'll make this more explicit

comcalvi · 2023-09-27T20:18:41Z

packages/aws-cdk/README.md

+* `--output-path <my_output_path>` - file path to where the file should be generated. 
+  Default is the current working directory


file? What type of file? Initially I thought this was supposed to be the generated CDK app, which is a folder (or maybe a zip file), but now I'm thinking it means the stack.ts file. If so it should say something like:

* `--output-path <my_output_path>` - path where the generated CDK Stack will be located. Default is `./foo.ts`

unclear by me. Fixing

comcalvi · 2023-09-27T20:21:50Z

packages/aws-cdk/README.md

+* `--output-path <my_output_path>` - file path to where the file should be generated. 
+  Default is the current working directory
+* `--language <language>` - Which CDK supported language should be generated [typescript, python, csharp, java, go]
+  default is typesript


Suggested change

default is typesript

default is typescript

madeline-k · 2023-09-27T20:23:45Z

packages/aws-cdk/README.md

+$ cdk bootstrap migrate --from-path ./template.json --stack-name MyAwesome
+```
+
+In order for the generated stack to be immediatly deployable, that stack must either already exist in that region/account 


Suggested change

In order for the generated stack to be immediatly deployable, that stack must either already exist in that region/account

In order for the generated application to be immediately deployable, that stack must either already exist in that region/account

madeline-k · 2023-09-27T20:28:39Z

packages/aws-cdk/README.md

+$ cdk bootstrap migrate --from-path ./template.json --stack-name MyAwesome
+```
+
+In order for the generated stack to be immediatly deployable, that stack must either already exist in that region/account 


Overall this section is pretty confusing, but I am struggling to come up with better phrasing here. I imagine customers will read this and ask, what does it mean to be immediately deployable? How do I know if there is any overlap between existing resources and resources defined in the input template?

An idea to improve clarity would be to separate this into describing the two use cases that work: 1. deploying to an environment with a deployed stack that matches the input template. 2. deploy to an environment with no deployed resources that overlap with your template definition.
Then finally, include the limitations section saying if you try to deploy a stack generated by CDK migrate to an environment that meets any of the following criteria, deployment will fail.

resources with the same physical ids already exist

a partially-matching stack already exists.

madeline-k · 2023-09-28T21:07:14Z

packages/aws-cdk/README.md

+⚠️**CAUTION**⚠️ 
+
+CDK migrate is currently experimental and may have breaking changes in the future. 
+We make no guarantees about the outcome or stability of the Command nor it's output.


So we decided to keep this sentence? If we are, a couple typos:

Suggested change

We make no guarantees about the outcome or stability of the Command nor it's output.

We make no guarantees about the outcome or stability of the command nor its output.

I don't think we should keep

We make no guarantees about the outcome or stability of the Command nor it's output.

comcalvi

Take a look at the docs for cdk deploy: https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-deploy, this read in a similar way.

comcalvi · 2023-09-29T19:20:32Z

packages/aws-cdk/README.md

+⚠️**CAUTION**⚠️ 
+
+CDK migrate is currently experimental and may have breaking changes in the future. 
+We make no guarantees about the outcome or stability of the Command nor it's output.


I don't think we should keep

We make no guarantees about the outcome or stability of the Command nor it's output.

comcalvi · 2023-09-29T19:23:52Z

packages/aws-cdk/README.md

+⚠️**CAUTION**⚠️ 
+
+CDK migrate is currently experimental and may have breaking changes in the future. 


It's fine to open with this, but immediately below should be a paragraph explaining what this command does at a high level, including an example of simplest, minimal usage, eg only using required flags / options. It should explain where the output goes and what the output is. I should not have to guess if it's a full CDK directory or if it's a single stack file.

comcalvi · 2023-09-29T19:33:00Z

packages/aws-cdk/README.md

+CDK migrate is currently experimental and may have breaking changes in the future. 
+We make no guarantees about the outcome or stability of the Command nor it's output.
+
+Generates a CDK application from an existing CloudFormation template in any of the CDK supported languages. 


This is the first sentence of that opening paragraph. Comparing this to cdk deploy's entry in this file, notice how cdk deploy has a similar opening sentence, but then goes into a high level overview of the command before it gets into use cases.

Notice also how cdk deploy is organized into use cases, not flag entries. Notice also how the use cases are written in the format of:

problem statement

solution

example

details

A good example of this format is the deployment progress entry. It starts with:

By default, stack deployment events are displayed as a progress bar with the events for the resource currently being deployed.

This tells user that all the stack deployment history is obscured by default. This is a problem because users may want the full stack history (we could improve this slightly by explicitly stating that the deployment history is obscured). The doc then shows a solution:

Set the --progress flag to request the complete history which includes all CloudFormation events

and immediately follows with an example that shows how to use that solution:

$ cdk deploy --progress events

It then goes into details about flag usage.

comcalvi · 2023-09-29T19:40:24Z

packages/aws-cdk/README.md

+#### Required Arguments:
+
+(You must specify either `--from-path` or `--from-stack`)
+
+* `--stack-name <my_stack_name>` - The name for both the CDK application and stack. 
+* `--from-path <my_file_path>` - Takes the relative file path to the JSON or YAML CloudFormation template 
+* `--from-stack` - Retrieves a deployed cloudformation stack from your account with the same name as `--stack-name`.


Do not organize the flag usage like this.

By starting with the flags, you're starting from the solutions. But users are reading this doc with a problem in their head. If you think of the readme as a hash table, the keys are problems and the values are solutions. Users reading this doc want to be able to do (in their head):

const solutionToMyProblem = README[myUseCase]

When you organize this with flags (solutions) at the top level, that mental operation doesn't work, because the doc's keys are the solutions, and not the problems.

Yes, flags can be named in such a way that they are obviously what you want (eg, --disable-rollback), but this will never work for all flags. You have more expressiveness with a markdown heading than you do a CLI flag name, so well-named markdown headings will always be easier to parse than CLI flags.

evgenyka · 2023-10-03T16:42:00Z

Shall we call out that generated CDK app will have L1 constructs?

udaypant · 2023-10-03T17:56:38Z

packages/aws-cdk/README.md

+
+This will generate a python CDK application which will synthesize to the same configuration of resources as the deployed stack.
+
+#### **CDK Migrate Limitations**


Would be good to call out support for Custom Resources.

Added this and nested stacks

Oh, and ADC regions will depend on those resources existing in those regions. The app will still synth but may not deploy

comcalvi

This is in a much better state than it was, nice work! I only have minor comments.

packages/aws-cdk/README.md

comcalvi · 2023-10-03T20:42:52Z

packages/aws-cdk/README.md

+then the generated application will be immediately deployable. A common reason for this might be because the template came 
+from a stack deployed in another account/region.


A common reason for this might be

A common reason for what?

comcalvi · 2023-10-03T20:44:29Z

packages/aws-cdk/README.md

+    }
+```
+
+There must not exist a resource of that type with the same name aka "MyBucket"


Suggested change

There must not exist a resource of that type with the same name aka "MyBucket"

There must not exist a resource of that type with the same name, e.g. "MyBucket"

madeline-k

This is looking really great! I just have some comments on grammar/spelling and one content question.

packages/aws-cdk/README.md

madeline-k · 2023-10-03T20:46:35Z

packages/aws-cdk/README.md

+The generated application will be initialized in the current working directory with a single stack where 
+the stack, app, and directory will all be named using the provided `--stack-name`. The generated application will 
+be within a generated subdirectory in your current working directory unless `--output-path` is specified. 
+All CDK supported lanaguages are supported, language choice can be specified with `--language`.


Suggested change

All CDK supported lanaguages are supported, language choice can be specified with `--language`.

All CDK supported languages are supported, language choice can be specified with `--language`.

madeline-k · 2023-10-03T20:46:53Z

packages/aws-cdk/README.md

+$ cdk migrate --from-path ./template.json --stack-name MyAwesomeApplication
+```
+
+This command will generate a new direcotry named `MyAwesomeApplication` within your current working directory, and 


Suggested change

This command will generate a new direcotry named `MyAwesomeApplication` within your current working directory, and

This command will generate a new directory named `MyAwesomeApplication` within your current working directory, and

madeline-k · 2023-10-03T20:47:30Z

packages/aws-cdk/README.md

+then initialize a new CDK application within that directory which has the same resource configuration as the
+as the provided template.json


Suggested change

then initialize a new CDK application within that directory which has the same resource configuration as the

as the provided template.json

then initialize a new CDK application within that directory which has the same resource configuration

as the provided template.json

madeline-k · 2023-10-03T20:48:09Z

packages/aws-cdk/README.md

+├── bin
+│   └── my_awesome_application.ts
+├── cdk.json
+├── cdk.out


Should we remove cdk.out since it won't exist until after synth?

madeline-k · 2023-10-03T20:55:21Z

packages/aws-cdk/README.md

+
+If the provided template came directly from a deployed cloudformation stack, and that stack has not experienced any drift, 
+then the generated application will be immediately deployable, and will not cause any changes to the deployed resources.
+Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the console or CLI.


Suggested change

Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the console or CLI.

Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the AWS Console or AWS CLI.

madeline-k · 2023-10-03T20:55:38Z

packages/aws-cdk/README.md

+in other CloudFormation Templates. In practice this is how CDK Migrate generated applications will 
+operate in the following scenarios:
+
+##### **The provided template is already deployed to cloudformation in the account/region**


Suggested change

##### **The provided template is already deployed to cloudformation in the account/region**

##### **The provided template is already deployed to CloudFormation in the account/region**

madeline-k · 2023-10-03T20:56:12Z

packages/aws-cdk/README.md

+then the generated application will be immediately deployable, and will not cause any changes to the deployed resources.
+Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the console or CLI.
+
+##### **The provided template is not deployed to cloudformation in the account/region, and there *is not* overlap with with resources outside the template**


Suggested change

##### **The provided template is not deployed to cloudformation in the account/region, and there *is not* overlap with with resources outside the template**

##### **The provided template is not deployed to CloudFormation in the account/region, and there *is not* overlap with existing resources in the account/region**

madeline-k · 2023-10-03T20:57:46Z

packages/aws-cdk/README.md

+then the generated application will be immediately deployable. A common reason for this might be because the template came 
+from a stack deployed in another account/region.
+
+In practice this means for any resource in the provided template. i.e.


"i.e." means "that is", and "e.g." means "for example". I think it's better not to use those anyway.

Suggested change

In practice this means for any resource in the provided template. i.e.

In practice this means for any resource in the provided template, for example,

madeline-k · 2023-10-03T20:58:14Z

packages/aws-cdk/README.md

+
+There must not exist a resource of that type with the same name aka "MyBucket"
+
+##### **The provided template is not deployed to cloudformation in the account/region, and there *is* overlap with with resources outside the template**


Suggested change

##### **The provided template is not deployed to cloudformation in the account/region, and there *is* overlap with with resources outside the template**

##### **The provided template is not deployed to CloudFormation in the account/region, and there *is* overlap with existing resources in the account/region**

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

no longer needed

aws-cdk-automation · 2023-10-06T16:27:22Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 6cae5ff
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

add CDK migrate readme

5091192

github-actions bot added the p2 label Sep 27, 2023

aws-cdk-automation requested a review from a team September 27, 2023 19:46

mergify bot added the contribution/core This is a PR that came from AWS. label Sep 27, 2023

aws-cdk-automation previously requested changes Sep 27, 2023

View reviewed changes

HBobertz changed the title ~~Docs(core): add CDK Migrate Readme~~ docs(core): add CDK Migrate Readme Sep 27, 2023

madeline-k suggested changes Sep 27, 2023

View reviewed changes

comcalvi requested changes Sep 27, 2023

View reviewed changes

madeline-k suggested changes Sep 27, 2023

View reviewed changes

Hogan Bobertz added 2 commits September 27, 2023 16:32

modifications to cdk migrate readme

ab21a14

some fixes to readme, still WIP

9c9002c

madeline-k changed the title ~~docs(core): add CDK Migrate Readme~~ docs(cli): add CDK Migrate Readme Sep 27, 2023

Hogan Bobertz added 2 commits September 28, 2023 13:23

update readmea with more info

659fb6f

remove random whitespace

db94dc7

madeline-k reviewed Sep 29, 2023

View reviewed changes

comcalvi requested changes Sep 29, 2023

View reviewed changes

Hogan Bobertz and others added 6 commits October 2, 2023 12:35

added more intro to the cdk migrate command

f21ee4f

readme modifications

94d2f39

change some wording

681b88d

remove description of flags

50f4b6d

Merge branch 'main' into bobertzh/docs

64623c4

annotate code block with json

d8052cf

callout the L1s

c5c0d1a

udaypant reviewed Oct 3, 2023

View reviewed changes

updtae to readme

81ed49f

HBobertz marked this pull request as ready for review October 3, 2023 19:54

comcalvi requested changes Oct 3, 2023

View reviewed changes

madeline-k suggested changes Oct 3, 2023

View reviewed changes

aws-cdk-automation requested changes Oct 6, 2023

View reviewed changes

comcalvi approved these changes Oct 6, 2023

View reviewed changes

aws-cdk-automation requested changes Oct 6, 2023

View reviewed changes

aws-cdk-automation previously requested changes Oct 6, 2023

View reviewed changes

comcalvi added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Oct 6, 2023

Merge branch 'main' into bobertzh/docs

6cae5ff

madeline-k merged commit db051ea into main Oct 6, 2023
10 checks passed

madeline-k deleted the bobertzh/docs branch October 6, 2023 18:04

	⚠️CAUTION⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.
	⚠️CAUTION⚠️ This command is considered experimental, and might have breaking changes in the future.

	* `--from-path <my_file_path>` - Takes the relative filse path to the JSON or YAML template of your choice
	* `--from-path <my_file_path>` - The file path to the JSON or YAML CloudFormation template


		⚠️CAUTION⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.

		Generates a CDK application from an existing Cloudformation template in any of the CDK supported languages.

	* `--output-path <my_output_path>` - file path to where the file should be generated.
	* `--output-path <my_output_path>` - file path where the application will be generated

	⚠️CAUTION⚠️ CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.
	⚠️ CAUTION ⚠️
	CDK migrate is currently experimental. We make no guarantees about the outcome or stability of the Command or it's output.

		* `--output-path <my_output_path>` - file path to where the file should be generated.
		Default is the current working directory

	In order for the generated stack to be immediatly deployable, that stack must either already exist in that region/account
	In order for the generated application to be immediately deployable, that stack must either already exist in that region/account

	We make no guarantees about the outcome or stability of the Command nor it's output.
	We make no guarantees about the outcome or stability of the command nor its output.

		⚠️CAUTION⚠️

		CDK migrate is currently experimental and may have breaking changes in the future.


		This will generate a python CDK application which will synthesize to the same configuration of resources as the deployed stack.

		#### CDK Migrate Limitations

		then the generated application will be immediately deployable. A common reason for this might be because the template came
		from a stack deployed in another account/region.

	All CDK supported lanaguages are supported, language choice can be specified with `--language`.
	All CDK supported languages are supported, language choice can be specified with `--language`.

	This command will generate a new direcotry named `MyAwesomeApplication` within your current working directory, and
	This command will generate a new directory named `MyAwesomeApplication` within your current working directory, and

		then initialize a new CDK application within that directory which has the same resource configuration as the
		as the provided template.json

	Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the console or CLI.
	Drift might occur if a resource in your template was modified outside of CloudFormation, namely via the AWS Console or AWS CLI.

	##### The provided template is already deployed to cloudformation in the account/region
	##### The provided template is already deployed to CloudFormation in the account/region

	##### *The provided template is not deployed to cloudformation in the account/region, and there is not* overlap with with resources outside the template**
	##### *The provided template is not deployed to CloudFormation in the account/region, and there is not* overlap with existing resources in the account/region**

feat(cli): CDK Migrate CLI command #27325

feat(cli): CDK Migrate CLI command #27325

Conversation

HBobertz commented Sep 27, 2023 • edited

cdk migrate

Generate a typescript application from a local template.json file

Generate a python application from a deployed stack

CDK Migrate Limitations

The provided template is already deployed to CloudFormation in the account/region

The provided template is not deployed to CloudFormation in the account/region, and there is not overlap with existing resources in the account/region

The provided template is not deployed to CloudFormation in the account/region, and there is overlap with existing resources in the account/region

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

comcalvi Sep 29, 2023 • edited

Choose a reason for hiding this comment

comcalvi left a comment

Choose a reason for hiding this comment

comcalvi Sep 29, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evgenyka commented Oct 3, 2023

Choose a reason for hiding this comment

HBobertz Oct 3, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

comcalvi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

madeline-k left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

HBobertz commented Sep 27, 2023 •

edited

`cdk migrate`

**The provided template is not deployed to CloudFormation in the account/region, and there is not overlap with existing resources in the account/region**

comcalvi Sep 29, 2023 •

edited

comcalvi Sep 29, 2023 •

edited

HBobertz Oct 3, 2023 •

edited