Skip to content

Commit

Permalink
Update package references in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rico Huijbers committed Jun 12, 2018
1 parent 7583d7e commit bb79435
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions packages/aws-cdk-docs/src/_includes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
.. |xxxx| replace:: *xxxx*
.. |xxxx-scope| replace:: |at-aws-cdk| |xxxx|

.. |construct-class| replace:: :py:class:`aws-cdk.Construct`
.. |app-construct| replace:: :py:class:`aws-cdk.Stack`
.. |app-class| replace:: :py:class:`aws-cdk.App`
.. |construct-class| replace:: :py:class:`_aws-cdk_core.Construct`
.. |app-construct| replace:: :py:class:`_aws-cdk_core.Stack`
.. |app-class| replace:: :py:class:`_aws-cdk_core.App`
.. |this| replace:: **this**
.. |parent| replace:: **parent**
.. |stack| replace:: :py:class:`aws-cdk.Stack`
.. |stack| replace:: :py:class:`_aws-cdk_core.Stack`
.. |stack-class| replace:: |stack|
.. |stack-construct| replace:: |stack|
.. |storagelayer| replace:: *StorageLayer*
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-docs/src/cloudformation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
Using CloudFormation Resource Constructs
###################

CloudFormation Resource constructs are found in the :py:mod:`@aws-cdk/resources` package. They map directly onto |cfn|
CloudFormation Resource constructs are found in the :py:mod:`_aws-cdk_resources` package. They map directly onto |cfn|
resources.

.. important::
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-docs/src/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ the first time you call |cx-synth-code|.

The |cdk| currently supports the following context providers.

:py:class:`aws-cdk.AvailabilityZoneProvider`
:py:class:`_aws-cdk_core.AvailabilityZoneProvider`
Use this provider to get the list of all supported availability zones in this environment.
For example, the following code iterates over all of the AZs in the current environment.

Expand All @@ -395,7 +395,7 @@ The |cdk| currently supports the following context providers.
// do somethning for each zone!
}
:py:class:`aws-cdk.SSMParameterProvider`
:py:class:`_aws-cdk_core.SSMParameterProvider`
Use this provider to read values from the current Region's SSM parameter store.
For example, the follow code returns the value of the 'my-awesome-value' key:

Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-docs/src/creating-constructs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,12 @@ Validation happens in one of two places:

* In the constructor, to validate the properties that are passed in.
* If the Construct offers methods that mutate the state of the Construct,
in the Construct's :py:meth:`aws-cdk.Construct.validate` method. This
in the Construct's :py:meth:`_aws-cdk_core.Construct.validate` method. This
method is called by the framework after the Construct hierarchy has been set up,
and is expected to return a list of validation error messages.

Construct implementors should prefer throwing validation errors in the constructor,
falling back to overriding the :py:meth:`aws-cdk.Construct.validate` method
falling back to overriding the :py:meth:`_aws-cdk_core.Construct.validate` method
only if the Construct offers mutating members.

Example of implementing validate:
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-docs/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ You should see output similar to the following:
Ref: MyQueueE6CA6235
As you can see, the call to :py:meth:`aws-cdk-sns.TopicRef.subscribeQueue` on
the :py:class:`aws-cdk-sns.Topic` resulted in:
As you can see, the call to :py:meth:`_aws-cdk_sns.TopicRef.subscribeQueue` on
the :py:class:`_aws-cdk_sns.Topic` resulted in:

1. Creating an **AWS::SNS::Subscription** associated with the queue and the topic.
2. Adding a statement to the **AWS::SQS::QueuePolicy**, which allows the topic to send messages to the queue.
Expand Down
8 changes: 4 additions & 4 deletions packages/aws-cdk-docs/src/l1-vs-l2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ AWS CloudFormation Resource Constructs
mapping to an |cfn| resource,
as listed in the |cfn| topic `AWS Resource Types Reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html>`_.

All Resource constructs are found in the :py:mod:`aws-cdk-resources` package.
All Resource constructs are found in the :py:mod:`_aws-cdk_resources` package.

AWS Construct Library Constructs

Expand Down Expand Up @@ -57,7 +57,7 @@ Construct Library constructs vs CloudFormation Resource constructs
To illustrate the advantages that Construct Library constructs have over
CloudFormation Resource constructs, let's look at an example.

The :py:mod:`@aws-cdk/sns` Construct Library includes the `Topic` construct that
The :py:mod:`_aws-cdk_sns` Construct Library includes the `Topic` construct that
you can use to define an |SNS| topic:

.. code-block:: js
Expand All @@ -67,7 +67,7 @@ you can use to define an |SNS| topic:
Library constructs encapsulate the
details of working with these AWS resources. For example, to subscribe a queue to a topic,
call the :py:meth:`@aws-cdk/sns.Topic.subscribeQueue` method with a queue object as the second argument:
call the :py:meth:`_aws-cdk_sns.Topic.subscribeQueue` method with a queue object as the second argument:

.. code-block:: js
Expand All @@ -84,7 +84,7 @@ This method:

2. Adds a queue policy with permissions for the topic to send messages to the queue.

To achieve a similar result using :py:mod:`aws-cdk-resources`, you have to explicitly define the
To achieve a similar result using :py:mod:`_aws-cdk_resources`, you have to explicitly define the
subscription and queue policy, since there is no **subscribeToQueue** method in the **TopicResource** class:

.. code-block:: js
Expand Down
10 changes: 5 additions & 5 deletions packages/aws-cdk-docs/src/welcome.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,20 @@ The |cdk| uses the following terms.

construct
The building block of an |cdk| app or library. In code, they are instances of
the :py:class:`aws-cdk.Construct` class or a class that extends the
:py:class:`aws-cdk.Construct` class.
the :py:class:`_aws-cdk_core.Construct` class or a class that extends the
:py:class:`_aws-cdk_core.Construct` class.

app
An executable program that the |cdk| uses to synthesize artifacts
that can contain multiple stacks and be deployed into multiple AWS environments.
Apps extend the :py:class:`aws-cdk.App` class.
Apps extend the :py:class:`_aws-cdk_core.App` class.

environment
An AWS deployment target for |cdk| stacks, defined by a specific AWS account and region.

stack
An |cdk| construct that can be deployed into an environment.
Stacks extend the :py:class:`aws-cdk.Stack` class.
Stacks extend the :py:class:`_aws-cdk_core.Stack` class.

applet
A reusable |cdk| construct that can be instantiated and deployed through a
Expand All @@ -76,7 +76,7 @@ CloudFormation Resource construct
The lowest-level construct, which map directly to an |CFN| resource,
as described in the
`AWS Resource Types Reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html>`_.
These constructs are available in the :py:mod:`aws-cdk-resources` package
These constructs are available in the :py:mod:`_aws-cdk_resources` package
as the |CFN| name with a **Resource** suffix within the AWS service namespace,
such as **sqs.QueueResource** representing an |SQS| queue.

Expand Down

0 comments on commit bb79435

Please sign in to comment.