diff --git a/packages/@aws-cdk/aws-neptune-alpha/README.md b/packages/@aws-cdk/aws-neptune-alpha/README.md index 9b7d247624de2..0b08391aa4a5a 100644 --- a/packages/@aws-cdk/aws-neptune-alpha/README.md +++ b/packages/@aws-cdk/aws-neptune-alpha/README.md @@ -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. }); ``` @@ -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', { @@ -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.