Skip to content

Commit

Permalink
fix: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mazyu36 committed May 15, 2024
1 parent d43f883 commit e903743
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions packages/@aws-cdk/aws-neptune-alpha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,12 @@ import * as neptune from '@aws-cdk/aws-neptune-alpha';

## Starting a Neptune Database

To set up a Neptune database, define a `DatabaseCluster`. You must always launch a database in a VPC.
To set up a Neptune database, define a `DatabaseCluster`. You must always launch a database in a VPC.

```ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
vpc,
instanceType: neptune.InstanceType.R5_LARGE,
copyTagsToSnapshot: true // whether to save the cluster tags when creating the snapshot.
});
```

Expand Down Expand Up @@ -127,9 +126,9 @@ const replica1 = new neptune.DatabaseInstance(this, 'Instance', {

## Automatic minor version upgrades

By setting `autoMinorVersionUpgrade` to true, Neptune will automatically update
the engine of the entire cluster to the latest minor version after a stabilization
window of 2 to 3 weeks.
By setting `autoMinorVersionUpgrade` to true, Neptune will automatically update
the engine of the entire cluster to the latest minor version after a stabilization
window of 2 to 3 weeks.

```ts
new neptune.DatabaseCluster(this, 'Cluster', {
Expand Down Expand Up @@ -185,9 +184,21 @@ instance.metric('SparqlRequestsPerSec') // instance-level SparqlErrors metric

For more details on the available metrics, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html

## Copy tags to snapshot

By setting `copyTagsToSnapshot` to true, all tags of the cluster are copied to the snapshots when they are created.

```ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
vpc,
instanceType: neptune.InstanceType.R5_LARGE,
copyTagsToSnapshot: true // whether to save the cluster tags when creating the snapshot.
});
```

## Neptune Serverless

You can configure a Neptune Serverless cluster using the dedicated instance type along with the
You can configure a Neptune Serverless cluster using the dedicated instance type along with the
`serverlessScalingConfiguration` property.

> Visit [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) for more details.
Expand Down

0 comments on commit e903743

Please sign in to comment.