RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/cdk/latest/guide/ref-cli-cmd.html below:

AWS CDKÂ CLI command reference

This section contains command reference information for the AWS Cloud Development Kit (AWS CDK) Command Line Interface (CLI). The CDK CLI is also referred to as the CDK Toolkit.

Usage

$ cdk <command> <arguments> <options>

Commands

acknowledge ack: Acknowledge a notice by issue number and hide it from displaying again.

bootstrap: Prepare an AWS environment for CDK deployments by deploying the CDK bootstrap stack, named CDKToolkit, into the AWS environment.

context: Manage cached context values for your CDK application.

deploy: Deploy one or more CDK stacks into your AWS environment.

destroy: Delete one or more CDK stacks from your AWS environment.

diff: Perform a diff to see infrastructure changes between CDK stacks.

docs doc: Open CDK documentation in your browser.

doctor: Inspect and display useful information about your local CDK project and development environment.

drift: Detect configuration drift for resources that you define, manage, and deploy using CDK.

import: Use AWS CloudFormation resource imports to import existing AWS resources into a CDK stack.

init: Create a new CDK project from a template.

list, ls: List all CDK stacks and their dependencies from a CDK app.

metadata: Display metadata associated with a CDK stack.

migrate: Migrate AWS resources, AWS CloudFormation stacks, and AWS CloudFormation templates into a new CDK project.

notices: Display notices for your CDK application.

synthesize, synth: Synthesize a CDK app to produce a cloud assembly, including an AWS CloudFormation template for each stack.

watch: Continuously watch a local CDK project for changes to perform deployments and hotswaps.

Global options

The following options are compatible with all CDK CLI commands.

--app, -a <STRING>

Provide the command for running your app or cloud assembly directory.

Required: Yes

--asset-metadata <BOOLEAN>

Include aws:asset:* AWS CloudFormation metadata for resources that use assets.

Required: No

Default value: true

--build <STRING>

Command for running a pre-synthesis build.

Required: No

--ca-bundle-path <STRING>

Path to a CA certificate to use when validating HTTPS requests.

If this option is not provided, the CDK CLI will read from the AWS_CA_BUNDLE environment variable.

Required: Yes

--ci <BOOLEAN>

Indicate that CDK CLI commands are being run in a continuous integration (CI) environment.

This option modifies the behavior of the CDK CLI to better suit automated operations that are typical in CI pipelines.

When you provide this option, logs are sent to stdout instead of stderr.

Required: No

Default value: false

--context, -c <ARRAY>: Add contextual string parameters as key-value pairs.

--debug <BOOLEAN>

Enable detailed debugging information. This option produces a verbose output that includes a lot more detail about what the CDK CLI is doing behind the scenes.

Required: No

Default value: false

--ec2creds, -i <BOOLEAN>

Force the CDK CLI to try and fetch Amazon EC2 instance credentials.

By default, the CDK CLI guesses the Amazon EC2 instance status.

Required: No

Default value: false

--help, -h <BOOLEAN>

Show command reference information for the CDK CLI.

Required: No

Default value: false

--ignore-errors <BOOLEAN>

Ignore synthesis errors, which will likely produce an output that is not valid.

Required: No

Default value: false

--json, -j <BOOLEAN>

Use JSON instead of YAML for AWS CloudFormation templates that are printed to standard output (stdout).

Required: No

Default value: false

--lookups <BOOLEAN>

Perform context lookups.

Synthesis will fail if this value is false and context lookups need to be performed.

Required: No

Default value: true

--no-color <BOOLEAN>

Remove color and other styling from the console output.

Required: No

Default value: false

--notices <BOOLEAN>

Show relevant notices.

Required: No

Default value: false

--output, -o <STRING>

Specify the directory to output the synthesized cloud assembly to.

Required: Yes

Default value: cdk.out

--path-metadata <BOOLEAN>

Include aws::cdk::path AWS CloudFormation metadata for each resource.

Required: No

Default value: true

--plugin, -p <ARRAY>

Name or path of a node package that extends CDK features. This option can be provided multiple times in a single command.

You can configure this option in the projectâs cdk.json file or at ~/.cdk.json on your local development machine:

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

Required: No

--profile <STRING>

Specify the name of the AWS profile, containing your AWS environment information, to use with the CDK CLI.

Required: Yes

--proxy <STRING>

Use the indicated proxy.

If this option is not provided, the CDK CLI will read from the HTTPS_PROXY environment variable.

Required: Yes

Default value: Read from HTTPS_PROXY environment variable.

--role-arn, -r <STRING>

The ARN of the IAM role that the CDK CLI will assume when interacting with AWS CloudFormation.

Required: No

--staging <BOOLEAN>

Copy assets to the output directory.

Specify false to prevent the copying of assets to the output directory. This allows the AWS SAM CLI to reference the original source files when performing local debugging.

Required: No

Default value: true

--strict <BOOLEAN>

Do not construct stacks that contain warnings.

Required: No

Default value: false

--trace <BOOLEAN>

Print trace for stack warnings.

Required: No

Default value: false

--verbose, -v <COUNT>

Show debug logs. You can specify this option multiple times to increase verbosity.

Required: No

--version <BOOLEAN>

Show the CDK CLI version number.

Required: No

Default value: false

--version-reporting <BOOLEAN>

Include the AWS::CDK::Metadata resource in synthesized AWS CloudFormation templates.

Required: No

Default value: true

Providing and configuring options

You can pass options through command-line arguments. For most options, you can configure them in a cdk.json configuration file. When you use multiple configuration sources, the CDK CLI adheres to the following precedence:

Command-line values â Any option provided at the command-line overrides options configured in cdk.json files.
Project configuration file â The cdk.json file in your CDK projectâs directory.
User configuration file â The cdk.json file located at ~/.cdk.json on your local machine.

Passing options at the command line

Passing boolean values

For options that accept a boolean value, you can specify them in the following ways:

Use true and false values â Provide the boolean value with the command. The following is an example:
```
$ cdk deploy --watch=true
$ cdk deploy --watch=false
```
Provide the optionâs counterpart â Modify the option name by adding no to specify a false value. The following is an example:
```
$ cdk deploy --watch
$ cdk deploy --no-watch
```
For options that default to true or false, you donât have to provide the option unless you want to change from the default.

AWS CDKÂ CLI reference

cdk ack

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4