Skip to content

Commit 812de5a

Browse files
committed
updated Neptune Readme
1 parent 20286a1 commit 812de5a

File tree

1 file changed

+123
-0
lines changed

1 file changed

+123
-0
lines changed

kotlin/services/neptune/README.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Neptune code examples for the SDK for Kotlin
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Kotlin to work with Amazon Neptune.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Neptune is a serverless graph database designed for superior scalability and availability._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `kotlin` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Get started
33+
34+
- [Hello Neptune](src/main/java/com/example/neptune/scenerio/HelloNeptune.kt#L9) (`DescribeDBClustersPaginator`)
35+
36+
37+
### Basics
38+
39+
Code examples that show you how to perform the essential operations within a service.
40+
41+
- [Learn the basics](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt)
42+
43+
44+
### Single actions
45+
46+
Code excerpts that show you how to call individual service functions.
47+
48+
- [CreateDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L482)
49+
- [CreateDBInstance](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L455)
50+
- [CreateDBSubnetGroup](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L508)
51+
- [DeleteDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L187)
52+
- [DeleteDBInstance](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L254)
53+
- [DeleteDBSubnetGroup](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L168)
54+
- [DescribeDBClusters](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L367)
55+
- [DescribeDBInstances](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L404)
56+
- [StartDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L331)
57+
- [StopDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L349)
58+
59+
60+
<!--custom.examples.start-->
61+
<!--custom.examples.end-->
62+
63+
## Run the examples
64+
65+
### Instructions
66+
67+
68+
<!--custom.instructions.start-->
69+
<!--custom.instructions.end-->
70+
71+
#### Hello Neptune
72+
73+
This example shows you how to get started using Neptune.
74+
75+
76+
#### Learn the basics
77+
78+
This example shows you how to do the following:
79+
80+
- Create an Amazon Neptune Subnet Group.
81+
- Create an Neptune Cluster.
82+
- Create an Neptune Instance.
83+
- Check the status of the Neptune Instance.
84+
- Show Neptune cluster details.
85+
- Stop the Neptune cluster.
86+
- Start the Neptune cluster.
87+
- Delete the Neptune Assets.
88+
89+
<!--custom.basic_prereqs.neptune_Scenario.start-->
90+
<!--custom.basic_prereqs.neptune_Scenario.end-->
91+
92+
93+
<!--custom.basics.neptune_Scenario.start-->
94+
<!--custom.basics.neptune_Scenario.end-->
95+
96+
97+
### Tests
98+
99+
⚠ Running tests might result in charges to your AWS account.
100+
101+
102+
To find instructions for running these tests, see the [README](../../README.md#Tests)
103+
in the `kotlin` folder.
104+
105+
106+
107+
<!--custom.tests.start-->
108+
<!--custom.tests.end-->
109+
110+
## Additional resources
111+
112+
- [Neptune User Guide](https://docs.aws.amazon.com/neptune/latest/userguide/intro.html)
113+
- [Neptune API Reference](https://docs.aws.amazon.com/neptune/latest/apiref/Welcome.html)
114+
- [SDK for Kotlin Neptune reference](https://sdk.amazonaws.com/kotlin/api/latest/dynamodb/index.html)
115+
116+
<!--custom.resources.start-->
117+
<!--custom.resources.end-->
118+
119+
---
120+
121+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
122+
123+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)