@aws-cdk/aws-neptune-alpha 2.9.0-alpha.0 → 2.13.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +34 -18
- package/.jsii.tabl.json +71 -69
- package/.warnings.jsii.js +3 -3
- package/README.md +9 -9
- package/lib/cluster.d.ts +68 -207
- package/lib/cluster.js +25 -66
- package/lib/endpoint.d.ts +4 -15
- package/lib/endpoint.js +3 -8
- package/lib/instance.d.ts +49 -141
- package/lib/instance.js +30 -81
- package/lib/parameter-group.d.ts +16 -49
- package/lib/parameter-group.js +7 -19
- package/lib/subnet-group.d.ts +12 -34
- package/lib/subnet-group.js +4 -10
- package/package.json +15 -8
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.13.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -1523,6 +1523,19 @@
|
|
|
1523
1523
|
}
|
|
1524
1524
|
}
|
|
1525
1525
|
},
|
|
1526
|
+
"aws-cdk-lib.aws_kafkaconnect": {
|
|
1527
|
+
"targets": {
|
|
1528
|
+
"dotnet": {
|
|
1529
|
+
"namespace": "Amazon.CDK.AWS.KafkaConnect"
|
|
1530
|
+
},
|
|
1531
|
+
"java": {
|
|
1532
|
+
"package": "software.amazon.awscdk.services.kafkaconnect"
|
|
1533
|
+
},
|
|
1534
|
+
"python": {
|
|
1535
|
+
"module": "aws_cdk.aws_kafkaconnect"
|
|
1536
|
+
}
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1526
1539
|
"aws-cdk-lib.aws_kendra": {
|
|
1527
1540
|
"targets": {
|
|
1528
1541
|
"dotnet": {
|
|
@@ -2907,7 +2920,7 @@
|
|
|
2907
2920
|
"stability": "experimental"
|
|
2908
2921
|
},
|
|
2909
2922
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
2910
|
-
"jsiiVersion": "1.
|
|
2923
|
+
"jsiiVersion": "1.54.0 (build b1b977a)",
|
|
2911
2924
|
"keywords": [
|
|
2912
2925
|
"aws",
|
|
2913
2926
|
"cdk",
|
|
@@ -2920,12 +2933,15 @@
|
|
|
2920
2933
|
"compiledWithDeprecationWarnings": true,
|
|
2921
2934
|
"pacmak": {
|
|
2922
2935
|
"hasDefaultInterfaces": true
|
|
2936
|
+
},
|
|
2937
|
+
"rosetta": {
|
|
2938
|
+
"strict": true
|
|
2923
2939
|
}
|
|
2924
2940
|
}
|
|
2925
2941
|
},
|
|
2926
2942
|
"name": "@aws-cdk/aws-neptune-alpha",
|
|
2927
2943
|
"readme": {
|
|
2928
|
-
"markdown": "# Amazon Neptune Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAmazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Neptune is a purpose-built, high-performance graph database engine. This engine is optimized for storing billions of relationships and querying the graph with milliseconds latency. Neptune supports the popular graph query languages Apache TinkerPop Gremlin and W3C’s SPARQL, enabling you to build queries that efficiently navigate highly connected datasets.\n\nThe `@aws-cdk/aws-neptune` package contains primitives for setting up Neptune database clusters and instances.\n\n```ts nofixture\nimport * as neptune from '@aws-cdk/aws-neptune-alpha';\n```\n\n## Starting a Neptune Database\n\nTo set up a Neptune database, define a `DatabaseCluster`. You must always launch a database in a VPC.\n\n```ts\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE
|
|
2944
|
+
"markdown": "# Amazon Neptune Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAmazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Neptune is a purpose-built, high-performance graph database engine. This engine is optimized for storing billions of relationships and querying the graph with milliseconds latency. Neptune supports the popular graph query languages Apache TinkerPop Gremlin and W3C’s SPARQL, enabling you to build queries that efficiently navigate highly connected datasets.\n\nThe `@aws-cdk/aws-neptune` package contains primitives for setting up Neptune database clusters and instances.\n\n```ts nofixture\nimport * as neptune from '@aws-cdk/aws-neptune-alpha';\n```\n\n## Starting a Neptune Database\n\nTo set up a Neptune database, define a `DatabaseCluster`. You must always launch a database in a VPC.\n\n```ts\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n});\n```\n\nBy default only writer instance is provisioned with this construct.\n\n## Connecting\n\nTo control who can access the cluster, use the `.connections` attribute. Neptune databases have a default port, so\nyou don't need to specify the port:\n\n```ts fixture=with-cluster\ncluster.connections.allowDefaultPortFromAnyIpv4('Open to the world');\n```\n\nThe endpoints to access your database cluster will be available as the `.clusterEndpoint` and `.clusterReadEndpoint`\nattributes:\n\n```ts fixture=with-cluster\nconst writeAddress = cluster.clusterEndpoint.socketAddress; // \"HOSTNAME:PORT\"\n```\n\n## IAM Authentication\n\nYou can also authenticate to a database cluster using AWS Identity and Access Management (IAM) database authentication;\nSee <https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html> for more information and a list of supported\nversions and limitations.\n\nThe following example shows enabling IAM authentication for a database cluster and granting connection access to an IAM role.\n\n```ts\nconst cluster = new neptune.DatabaseCluster(this, 'Cluster', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n iamAuthentication: true, // Optional - will be automatically set if you call grantConnect().\n});\nconst role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });\ncluster.grantConnect(role); // Grant the role connection access to the DB.\n```\n\n## Customizing parameters\n\nNeptune allows configuring database behavior by supplying custom parameter groups. For more details, refer to the\nfollowing link: <https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html>\n\n```ts\nconst clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000',\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n clusterParameterGroup: clusterParams,\n parameterGroup: dbParams,\n});\n```\n\n## Adding replicas\n\n`DatabaseCluster` allows launching replicas along with the writer instance. This can be specified using the `instanceCount`\nattribute.\n\n```ts\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2,\n});\n```\n\nAdditionally it is also possible to add replicas using `DatabaseInstance` for an existing cluster.\n\n```ts fixture=with-cluster\nconst replica1 = new neptune.DatabaseInstance(this, 'Instance', {\n cluster,\n instanceType: neptune.InstanceType.R5_LARGE,\n});\n```\n\n## Automatic minor version upgrades\n\nBy setting `autoMinorVersionUpgrade` to true, Neptune will automatically update\nthe engine of the entire cluster to the latest minor version after a stabilization\nwindow of 2 to 3 weeks.\n\n```ts\nnew neptune.DatabaseCluster(this, 'Cluster', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n autoMinorVersionUpgrade: true,\n});\n```\n"
|
|
2929
2945
|
},
|
|
2930
2946
|
"repository": {
|
|
2931
2947
|
"directory": "packages/individual-packages/aws-neptune",
|
|
@@ -2971,7 +2987,7 @@
|
|
|
2971
2987
|
"exampleMetadata": "infused",
|
|
2972
2988
|
"resource": "AWS::Neptune::DBClusterParameterGroup"
|
|
2973
2989
|
},
|
|
2974
|
-
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000'
|
|
2990
|
+
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000',\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n clusterParameterGroup: clusterParams,\n parameterGroup: dbParams,\n});",
|
|
2975
2991
|
"stability": "experimental",
|
|
2976
2992
|
"summary": "A cluster parameter group."
|
|
2977
2993
|
},
|
|
@@ -3080,7 +3096,7 @@
|
|
|
3080
3096
|
"custom": {
|
|
3081
3097
|
"exampleMetadata": "infused"
|
|
3082
3098
|
},
|
|
3083
|
-
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000'
|
|
3099
|
+
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000',\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n clusterParameterGroup: clusterParams,\n parameterGroup: dbParams,\n});",
|
|
3084
3100
|
"stability": "experimental",
|
|
3085
3101
|
"summary": "Marker class for cluster parameter group."
|
|
3086
3102
|
},
|
|
@@ -3160,7 +3176,7 @@
|
|
|
3160
3176
|
"exampleMetadata": "infused",
|
|
3161
3177
|
"resource": "AWS::Neptune::DBCluster"
|
|
3162
3178
|
},
|
|
3163
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2
|
|
3179
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2,\n});",
|
|
3164
3180
|
"stability": "experimental",
|
|
3165
3181
|
"summary": "Create a clustered database with a given number of instances."
|
|
3166
3182
|
},
|
|
@@ -3232,7 +3248,7 @@
|
|
|
3232
3248
|
"line": 396
|
|
3233
3249
|
},
|
|
3234
3250
|
"name": "clusterEndpoint",
|
|
3235
|
-
"overrides": "@aws-cdk/aws-neptune-alpha.
|
|
3251
|
+
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
3236
3252
|
"type": {
|
|
3237
3253
|
"fqn": "@aws-cdk/aws-neptune-alpha.Endpoint"
|
|
3238
3254
|
}
|
|
@@ -3248,7 +3264,7 @@
|
|
|
3248
3264
|
"line": 395
|
|
3249
3265
|
},
|
|
3250
3266
|
"name": "clusterIdentifier",
|
|
3251
|
-
"overrides": "@aws-cdk/aws-neptune-alpha.
|
|
3267
|
+
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
3252
3268
|
"type": {
|
|
3253
3269
|
"primitive": "string"
|
|
3254
3270
|
}
|
|
@@ -3264,7 +3280,7 @@
|
|
|
3264
3280
|
"line": 397
|
|
3265
3281
|
},
|
|
3266
3282
|
"name": "clusterReadEndpoint",
|
|
3267
|
-
"overrides": "@aws-cdk/aws-neptune-alpha.
|
|
3283
|
+
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
3268
3284
|
"type": {
|
|
3269
3285
|
"fqn": "@aws-cdk/aws-neptune-alpha.Endpoint"
|
|
3270
3286
|
}
|
|
@@ -3284,7 +3300,7 @@
|
|
|
3284
3300
|
"line": 405
|
|
3285
3301
|
},
|
|
3286
3302
|
"name": "clusterResourceIdentifier",
|
|
3287
|
-
"overrides": "@aws-cdk/aws-neptune-alpha.
|
|
3303
|
+
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
3288
3304
|
"type": {
|
|
3289
3305
|
"primitive": "string"
|
|
3290
3306
|
}
|
|
@@ -3300,7 +3316,7 @@
|
|
|
3300
3316
|
"line": 398
|
|
3301
3317
|
},
|
|
3302
3318
|
"name": "connections",
|
|
3303
|
-
"overrides": "aws-cdk-
|
|
3319
|
+
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
3304
3320
|
"type": {
|
|
3305
3321
|
"fqn": "aws-cdk-lib.aws_ec2.Connections"
|
|
3306
3322
|
}
|
|
@@ -3755,7 +3771,7 @@
|
|
|
3755
3771
|
"custom": {
|
|
3756
3772
|
"exampleMetadata": "infused"
|
|
3757
3773
|
},
|
|
3758
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2
|
|
3774
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2,\n});",
|
|
3759
3775
|
"stability": "experimental",
|
|
3760
3776
|
"summary": "Properties for a new database cluster."
|
|
3761
3777
|
},
|
|
@@ -4185,7 +4201,7 @@
|
|
|
4185
4201
|
"exampleMetadata": "fixture=with-cluster infused",
|
|
4186
4202
|
"resource": "AWS::Neptune::DBInstance"
|
|
4187
4203
|
},
|
|
4188
|
-
"example": "const replica1 = new neptune.DatabaseInstance(this, 'Instance', {\n cluster,\n instanceType: neptune.InstanceType.R5_LARGE
|
|
4204
|
+
"example": "const replica1 = new neptune.DatabaseInstance(this, 'Instance', {\n cluster,\n instanceType: neptune.InstanceType.R5_LARGE,\n});",
|
|
4189
4205
|
"stability": "experimental",
|
|
4190
4206
|
"summary": "A database instance."
|
|
4191
4207
|
},
|
|
@@ -4439,7 +4455,7 @@
|
|
|
4439
4455
|
"custom": {
|
|
4440
4456
|
"exampleMetadata": "fixture=with-cluster infused"
|
|
4441
4457
|
},
|
|
4442
|
-
"example": "const replica1 = new neptune.DatabaseInstance(this, 'Instance', {\n cluster,\n instanceType: neptune.InstanceType.R5_LARGE
|
|
4458
|
+
"example": "const replica1 = new neptune.DatabaseInstance(this, 'Instance', {\n cluster,\n instanceType: neptune.InstanceType.R5_LARGE,\n});",
|
|
4443
4459
|
"stability": "experimental",
|
|
4444
4460
|
"summary": "Construction properties for a DatabaseInstanceNew."
|
|
4445
4461
|
},
|
|
@@ -5204,7 +5220,7 @@
|
|
|
5204
5220
|
"custom": {
|
|
5205
5221
|
"exampleMetadata": "infused"
|
|
5206
5222
|
},
|
|
5207
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2
|
|
5223
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n instances: 2,\n});",
|
|
5208
5224
|
"stability": "experimental",
|
|
5209
5225
|
"summary": "Possible Instances Types to use in Neptune cluster used for defining {@link DatabaseInstanceProps.instanceType}."
|
|
5210
5226
|
},
|
|
@@ -5611,7 +5627,7 @@
|
|
|
5611
5627
|
"exampleMetadata": "infused",
|
|
5612
5628
|
"resource": "AWS::Neptune::DBParameterGroup"
|
|
5613
5629
|
},
|
|
5614
|
-
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000'
|
|
5630
|
+
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000',\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n clusterParameterGroup: clusterParams,\n parameterGroup: dbParams,\n});",
|
|
5615
5631
|
"stability": "experimental",
|
|
5616
5632
|
"summary": "DB parameter group."
|
|
5617
5633
|
},
|
|
@@ -5720,7 +5736,7 @@
|
|
|
5720
5736
|
"custom": {
|
|
5721
5737
|
"exampleMetadata": "infused"
|
|
5722
5738
|
},
|
|
5723
|
-
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000'
|
|
5739
|
+
"example": "const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst dbParams = new neptune.ParameterGroup(this, 'DbParams', {\n description: 'Db parameter group',\n parameters: {\n neptune_query_timeout: '120000',\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n clusterParameterGroup: clusterParams,\n parameterGroup: dbParams,\n});",
|
|
5724
5740
|
"stability": "experimental",
|
|
5725
5741
|
"summary": "Marker class for cluster parameter group."
|
|
5726
5742
|
},
|
|
@@ -6013,6 +6029,6 @@
|
|
|
6013
6029
|
"symbolId": "lib/subnet-group:SubnetGroupProps"
|
|
6014
6030
|
}
|
|
6015
6031
|
},
|
|
6016
|
-
"version": "2.
|
|
6032
|
+
"version": "2.13.0-alpha.0",
|
|
6017
6033
|
"fingerprint": "**********"
|
|
6018
6034
|
}
|