Skip to content

Commit

Permalink
Fixed headings (#590)
Browse files Browse the repository at this point in the history
  • Loading branch information
Doug-AWS authored Aug 16, 2018
1 parent b6a5e89 commit 39a3362
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 9 deletions.
2 changes: 2 additions & 0 deletions docs/src/assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
either express or implied. See the License for the specific language governing permissions and
limitations under the License.
.. _assets:

######
Assets
######
Expand Down
28 changes: 20 additions & 8 deletions docs/src/aws-construct-lib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ are designed to allow developers to focus on their application-specific
architectures and reduces the boilerplate and glue logic needed when working
with AWS.

Least-Privilege IAM policies
----------------------------
.. _least_privilege:

Least-Privilege IAM Policies
============================

IAM policies are automatically defined based on intent. For example, when
subscribing an AWS SNS :py:class:`Topic <@aws-cdk/aws-sns.Topic>` to a AWS Lambda
Expand All @@ -42,8 +44,10 @@ method which accepts an AWS IAM :py:class:`Principal <@aws-cdk/aws-iam.IPrincipa
such as a :py:class:`User <@aws-cdk/aws-iam.User>` or a :py:class:`Role <@aws-cdk/aws-iam.Role>`,
and will modify their policy to allow the principal to read objects from the bucket.

Event-driven APIs
------------------
.. _event_driven_apis:

Event-Driven APIs
=================

Many of the AWS constructs include ``on*`` methods which can be used to react
to events emitted by the construct. For example, the AWS CodeCommit
Expand All @@ -59,8 +63,10 @@ interfaces such as :py:mod:`IEventRuleTarget <@aws-cdk/aws-events.IEventRuleTarg
For more information see the :doc:`refs/_aws-cdk_aws-cloudwatch` and :doc:`refs/_aws-cdk_aws-events`
documentation.

.. _security_groups:

Security Groups
---------------
===============

EC2 network entities such as the :py:mod:`Elastic Load Balancer <@aws-cdk/aws-ec2.ElasticLoadBalancer`
and :py:mod:`AutoScalingGroup <@aws-cdk/aws-ec2.AutoScalingGroup>` instances can connect to each other
Expand All @@ -69,8 +75,10 @@ based on definitions of security groups.
The AWS CDK provides a rich API for defining security group connections. For more information,
see **Allowing Connections** in the :doc:`@aws-cdk/aws-ec2 <refs/_aws-cdk_aws-ec2>` documentation.

.. _metrics:

Metrics
-------
=======

Many AWS resources emit AWS CloudWatch metrics as part of their normal operation. Metrics can
be used to setup :py:mod:`Alarms <@aws-cdk/aws-cloudwatch.Alarm>` or included in :py:mod:`Dashboards <@aws-cdk/aws-cloudwatch.Dashboard>`.
Expand All @@ -81,8 +89,10 @@ method reports the execution time of an AWS Lambda function.

For more information see the :doc:`refs/_aws-cdk_aws-cloudwatch` documentation.

.. _import:

Imports
-------
=======

If you need to reference a resource which is defined outside of your CDK app (e.g. a bucket, a VPC, etc),
you can use the ``Xxxx.import(...)`` static methods which are available on AWS Constructs. For example,
Expand All @@ -91,8 +101,10 @@ a :py:mod:`BucketRef <@aws-cdk/aws-s3.BucketRef>` object which can be used in mo
a bucket is required. This patterns allows treating resources defined outside your app as if they
were part of your app.

.. _cloudformation_layer:

AWS CloudFormation Layer
------------------------
========================

Every module in the AWS Construct Library includes a ``cloudformation`` namespace which contains
low-level constructs which represent the low-level AWS CloudFormation semantics of this service.
Expand Down
8 changes: 8 additions & 0 deletions docs/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Hello, |cdk|!

This topic walks you through creating and deploying your first |cdk| app.

.. _setup:

Setup
=====

.. _setup_prerequisites:

Prerequisites
-------------

Expand All @@ -30,6 +34,8 @@ used to setup the credentials and region for your AWS account,
which must be specified to use the toolkit.
See :ref:`credentials <credentials>` for information on using the AWS CLI to set your credentials.

.. _setup_install:

Install the command-line toolkit
--------------------------------

Expand Down Expand Up @@ -867,6 +873,8 @@ encryption for the bucket:
[2/2] UPDATE_COMPLETE [AWS::CloudFormation::Stack] hello-cdk
✅ Deployment of stack hello-cdk completed successfully
.. _whats_next:

What Next?
==========

Expand Down
4 changes: 4 additions & 0 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ on AWS.
`AWS Simple Monthly Calculator <http://calculator.s3.amazonaws.com/index.html>`_
to estimate charges for the use of various AWS resources.

.. _additional_docs:

Additional Documentation and Resources
======================================

Expand All @@ -66,6 +68,8 @@ In addition to this guide, the following are other resources available to |cdk|
* `Issues <https://github.com/awslabs/aws-cdk/issues>`_
* `License <https://github.com/awslabs/aws-cdk/blob/master/LICENSE>`_

.. _about_aws:

About Amazon Web Services
=========================

Expand Down
2 changes: 1 addition & 1 deletion docs/src/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.. _toolkit:

Command-line Toolkit (cdk)
--------------------------
==========================

``cdk`` (the |toolkit|) is the main tool you use to interact with your |*CDK App*|. It will execute
the CDK app you have written and compiled, interrogate the application
Expand Down

0 comments on commit 39a3362

Please sign in to comment.