Skip to content

Kotlin Add the Neptune follow #7510

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.

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
wants to merge 32 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ba365fd
added Kotlin Neptune files
scmacdon Jun 26, 2025
a3d5415
added Kotlin Neptune files
scmacdon Jun 27, 2025
adac7ec
updated the metadata file
scmacdon Jun 27, 2025
1b6488b
updated the metadata file
scmacdon Jun 27, 2025
534fa22
updated the metadata file
scmacdon Jun 27, 2025
f012aae
updated the metadata file
scmacdon Jun 27, 2025
67098dd
add Hello Kotlin
scmacdon Jul 2, 2025
20286a1
updated Hello Kotlin
scmacdon Jul 2, 2025
812de5a
updated Neptune Readme
scmacdon Jul 2, 2025
7b01b0d
updated Neptune Readme
scmacdon Jul 2, 2025
873201f
fixed linter issues
scmacdon Jul 2, 2025
7042aa1
fixed linter issues
scmacdon Jul 2, 2025
337c66f
fixed linter issues
scmacdon Jul 2, 2025
8691276
updated client pattern
scmacdon Jul 2, 2025
ef609a1
updated client pattern
scmacdon Jul 3, 2025
40e40ec
rolled in review comments
scmacdon Jul 3, 2025
3279e6a
fixed linter issue
scmacdon Jul 3, 2025
6d486ba
fixed linter issue
scmacdon Jul 3, 2025
f32d7f0
fixed linter issue
scmacdon Jul 3, 2025
e2ee63f
fixed linter issue
scmacdon Jul 3, 2025
6bf6f06
fixed linter issue
scmacdon Jul 3, 2025
72223a8
fixed linter issue
scmacdon Jul 3, 2025
1ed8a39
fixed linter issue
scmacdon Jul 3, 2025
93ff6a0
fixed linter issue
scmacdon Jul 3, 2025
1aa9694
fixed linter issue
scmacdon Jul 3, 2025
1503f22
fixed linter issue
scmacdon Jul 3, 2025
827d701
fixed linter issue
scmacdon Jul 3, 2025
5b88cd0
fixed linter issue
scmacdon Jul 3, 2025
c154d33
fixed linter issue
scmacdon Jul 3, 2025
713e90a
fixed linter issue
scmacdon Jul 3, 2025
4ab636b
fixed linter issue
scmacdon Jul 3, 2025
7ee447e
fixed linter issue
scmacdon Jul 3, 2025
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
108 changes: 108 additions & 0 deletions .doc_gen/metadata/neptune_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ neptune_Hello:
synopsis: get started using &neptune;.
category: Hello
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.hello.main
Python:
versions:
- sdk_version: 3
Expand Down Expand Up @@ -131,6 +140,15 @@ neptune_ExecuteGremlinQuery:
neptune: {ExecuteGremlinQuery}
neptune_DeleteDBSubnetGroup:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.delete.subnet.group.main
Python:
versions:
- sdk_version: 3
Expand All @@ -152,6 +170,15 @@ neptune_DeleteDBSubnetGroup:
neptune: {DeleteDBSubnetGroup}
neptune_DeleteDBCluster:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.delete.cluster.main
Python:
versions:
- sdk_version: 3
Expand All @@ -173,6 +200,15 @@ neptune_DeleteDBCluster:
neptune: {DeleteDBCluster}
neptune_DeleteDBInstance:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.delete.instance.main
Python:
versions:
- sdk_version: 3
Expand All @@ -194,6 +230,15 @@ neptune_DeleteDBInstance:
neptune: {DeleteDBInstance}
neptune_StartDBCluster:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.start.cluster.main
Python:
versions:
- sdk_version: 3
Expand All @@ -215,6 +260,15 @@ neptune_StartDBCluster:
neptune: {StartDBCluster}
neptune_StopDBCluster:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.stop.cluster.main
Python:
versions:
- sdk_version: 3
Expand All @@ -236,6 +290,15 @@ neptune_StopDBCluster:
neptune: {StopDBCluster}
neptune_DescribeDBClusters:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.describe.cluster.main
Python:
versions:
- sdk_version: 3
Expand All @@ -257,6 +320,15 @@ neptune_DescribeDBClusters:
neptune: {DescribeDBClusters}
neptune_DescribeDBInstances:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.describe.dbinstance.main
Python:
versions:
- sdk_version: 3
Expand All @@ -278,6 +350,15 @@ neptune_DescribeDBInstances:
neptune: {DescribeDBInstances}
neptune_CreateDBInstance:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.create.dbinstance.main
Python:
versions:
- sdk_version: 3
Expand All @@ -299,6 +380,15 @@ neptune_CreateDBInstance:
neptune: {CreateDBInstance}
neptune_CreateDBCluster:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.create.cluster.main
Python:
versions:
- sdk_version: 3
Expand All @@ -320,6 +410,15 @@ neptune_CreateDBCluster:
neptune: {CreateDBCluster}
neptune_CreateDBSubnetGroup:
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.create.subnet.main
Python:
versions:
- sdk_version: 3
Expand Down Expand Up @@ -351,6 +450,15 @@ neptune_Scenario:
- Delete the &neptune; Assets.
category: Basics
languages:
Kotlin:
versions:
- sdk_version: 1
github: kotlin/services/neptune
sdkguide:
excerpts:
- description:
snippet_tags:
- neptune.kotlin.scenario.main
Python:
versions:
- sdk_version: 3
Expand Down
42 changes: 42 additions & 0 deletions kotlin/services/neptune/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/

### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/

### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

### VS Code ###
.vscode/

### Mac OS ###
.DS_Store
123 changes: 123 additions & 0 deletions kotlin/services/neptune/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Neptune code examples for the SDK for Kotlin

## Overview

Shows how to use the AWS SDK for Kotlin to work with Amazon Neptune.

<!--custom.overview.start-->
<!--custom.overview.end-->

_Neptune is a serverless graph database designed for superior scalability and availability._

## ⚠ Important

* 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/).
* Running the tests might result in charges to your AWS account.
* 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).
* 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).

<!--custom.important.start-->
<!--custom.important.end-->

## Code examples

### Prerequisites

For prerequisites, see the [README](../../README.md#Prerequisites) in the `kotlin` folder.


<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->

### Get started

- [Hello Neptune](src/main/java/com/example/neptune/HelloNeptune.kt#L9) (`DescribeDBClustersPaginator`)


### Basics

Code examples that show you how to perform the essential operations within a service.

- [Learn the basics](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt)


### Single actions

Code excerpts that show you how to call individual service functions.

- [CreateDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L546)
- [CreateDBInstance](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L510)
- [CreateDBSubnetGroup](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L583)
- [DeleteDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L204)
- [DeleteDBInstance](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L275)
- [DeleteDBSubnetGroup](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L179)
- [DescribeDBClusters](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L400)
- [DescribeDBInstances](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L447)
- [StartDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L344)
- [StopDBCluster](src/main/java/com/example/neptune/scenerio/NeptuneScenario.kt#L372)


<!--custom.examples.start-->
<!--custom.examples.end-->

## Run the examples

### Instructions


<!--custom.instructions.start-->
<!--custom.instructions.end-->

#### Hello Neptune

This example shows you how to get started using Neptune.


#### Learn the basics

This example shows you how to do the following:

- Create an Amazon Neptune Subnet Group.
- Create an Neptune Cluster.
- Create an Neptune Instance.
- Check the status of the Neptune Instance.
- Show Neptune cluster details.
- Stop the Neptune cluster.
- Start the Neptune cluster.
- Delete the Neptune Assets.

<!--custom.basic_prereqs.neptune_Scenario.start-->
<!--custom.basic_prereqs.neptune_Scenario.end-->


<!--custom.basics.neptune_Scenario.start-->
<!--custom.basics.neptune_Scenario.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `kotlin` folder.



<!--custom.tests.start-->
<!--custom.tests.end-->

## Additional resources

- [Neptune User Guide](https://docs.aws.amazon.com/neptune/latest/userguide/intro.html)
- [Neptune API Reference](https://docs.aws.amazon.com/neptune/latest/apiref/Welcome.html)
- [SDK for Kotlin Neptune reference](https://sdk.amazonaws.com/kotlin/api/latest/dynamodb/index.html)

<!--custom.resources.start-->
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
Loading
Loading