Skip to content

docs: document --use-docker and --no-docker options in cfn submit #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cv-dote wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −0
Open

docs: document --use-docker and --no-docker options in cfn submit #1120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc_source/resource-type-cli-submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ The user registering the extension must be able to access the schema handler pac
[--role-arn <value>]
[--no-role]
[--set-default]
[--use-docker]
[--no-docker]
```

## Options<a name="resource-type-cli-submit-options"></a>
Expand Down Expand Up @@ -67,6 +69,18 @@ You can't specify both `--role-arn` and `--no-role` arguments\.

Upon successful registration of the type version, sets the current type version as the default version\.

`--use-docker`

Use docker for platform\-independent packaging\. This is highly recommended unless you are experienced with cross\-platform packaging\. This overrides the `use_docker` setting in your project's `.rpdk-config` file\.

You can't specify both `--use-docker` and `--no-docker` arguments\.

`--no-docker`

Skip docker when packaging the project\. Generally not recommended unless you are experienced with cross\-platform packaging\. This overrides the `use_docker` setting in your project's `.rpdk-config` file\.

You can't specify both `--use-docker` and `--no-docker` arguments\.

## Output<a name="resource-type-cli-submit-output"></a>

Extension registration is an asynchronous operation\. You can use the supplied registration token to track the progress of your extension registration request using the [DescribeTypeRegistration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeTypeRegistration.html) action of the CloudFormation API\.