Skip to content

Commit

Permalink
Touch ups to getting-started.html (#135)
Browse files Browse the repository at this point in the history
* Touch ups to getting-started.html

* Update getting-started.rst
  • Loading branch information
Elad Ben-Israel authored and RomainMuller committed Jun 19, 2018
1 parent 49f6aea commit 8f3a1ce
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions packages/aws-cdk-docs/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ For the examples in this section we'll use TypeScript.
The **cdk init** command creates a skeleton |cdk| program for you to work with
and displays some useful commands to help you get started.

Replace the contents of the file *index.ts* with the following code to create a class that
extends **Stack**, and include some construction logic.

.. note:: You can use an IDE, such as
`Microsoft Visual Code <https://code.visualstudio.com/>`_,
`Sublime Text <https://www.sublimetext.com/>`_ with the
Expand All @@ -58,6 +55,9 @@ extends **Stack**, and include some construction logic.
`Atom TypeScript <https://atom.io/packages/atom-typescript>`_ plugin,
to get auto-completion in your Typescript code.

Replace the contents of the file *index.ts* with the following code to create a class that
extends **Stack**, and include some construction logic.

.. code-block:: js
// You'll need this statement in every app
Expand Down Expand Up @@ -89,7 +89,7 @@ extends **Stack**, and include some construction logic.
});
// Subscribe the topic to the queue
topic.subscribeQueue('TopicToQueue', queue);
topic.subscribeQueue(queue);
}
}
Expand Down Expand Up @@ -198,6 +198,8 @@ should see information messages, such as feedback from CloudFormation logs.

Use the `AWS Command Line Interface <https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html>`_
``aws configure`` command to specify your default credentials and region.

Important: make sure that you explicitly specify a **region**.

You can also set environment variables for your default credentials and region.
Environment variables take precedence over settings in the credentials or config file.
Expand Down Expand Up @@ -234,8 +236,9 @@ You should see something like the following.
.. code-block:: sh
[~] 🛠 Updating MyQueueE6CA6235 (type: AWS::SQS::Queue)
└─ [+] .VisibilityTimeout:
└─ New value: 300
└─ [+] .VisibilityTimeout:
├ Old value: 300
└─ New value: 500
If the changes are acceptable, use **cdk deploy** to update your
infrastructure.

0 comments on commit 8f3a1ce

Please sign in to comment.