-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #729 from aws/shovlia/docs-cdk-assume-role
docs: Update credentials documentation to discuss assuming CDK deployment roles, and document the --output parameter on the deployment-project command.
- Loading branch information
Showing
2 changed files
with
34 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,26 @@ | ||
# deployment-project generate command | ||
|
||
### Usage | ||
dotnet aws deployment-project - Generates and saves the deployment CDK project in the user provided location. | ||
|
||
`dotnet aws deployment-project` - Generates and saves the deployment CDK project in the user provided location. | ||
|
||
### Synopsis | ||
dotnet aws deployment-project generate [-d|--diagnostics] [-s|--silent] [--profile <PROFILE>] [--region <REGION>] [--project-path <PROJECT-PATH>] [--project-display-name <DISPLAY-NAME>] | ||
|
||
``` | ||
dotnet aws deployment-project generate [-o|--output <OUTPUT-PATH>] [-d|--diagnostics] [--project-path <PROJECT-PATH>] [--project-display-name <DISPLAY-NAME>] | ||
``` | ||
|
||
### Description | ||
Generates and saves the [deployment CDK project](../deployment-projects/index.md) in a user provided directory path without proceeding with a deployment. Allows user to customize the CDK project before deploying the application. | ||
Generates and saves the [deployment CDK project](../deployment-projects/index.md) in a user-provided directory without proceeding with a deployment. This allows the user to customize the CDK project before deploying the application. | ||
|
||
* The `--output` switch sets the directory where the deployment project will be saved. | ||
* The `--project-display-name` switch sets the name that will be shown when the .NET project is being deployed. | ||
* The `--output` switch sets the directory where the CDK deployment project will be saved. | ||
* The `--project-path` switch sets the path to the project to generate a deployment project for. | ||
* The `--project-display-name` switch sets the name of the deployment project that will be displayed in the list of available deployment options. | ||
|
||
### Examples | ||
|
||
This example creates a deployment project from the .NET project in the current directory. The deployment project will be saved to a sibling directory called CustomDeploymentProject. The name _"Team custom deployment project"_ will be displayed in the list of the available deployment options. | ||
|
||
dotnet aws deployment-project generate --output ../CustomDeploymentProject --project-display-name "Team custom deployment project" | ||
This example creates a deployment project from the .NET project in the current directory. The deployment project will be saved to a sibling directory called CustomDeploymentProject. The name _"Team custom deployment project"_ will be displayed in the list of the available deployment options. | ||
|
||
``` | ||
dotnet aws deployment-project generate --output ../CustomDeploymentProject --project-display-name "Team custom deployment project" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters