@aws-cdk/aws-neptune-alpha 2.88.0-alpha.0 → 2.89.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 +193 -104
- package/.jsii.tabl.json.gz +0 -0
- package/.warnings.jsii.js +5 -1
- package/README.md +18 -0
- package/lib/cluster.d.ts +18 -0
- package/lib/cluster.js +25 -5
- package/lib/endpoint.js +1 -1
- package/lib/instance.d.ts +4 -0
- package/lib/instance.js +8 -4
- package/lib/parameter-group.js +3 -3
- package/lib/subnet-group.js +1 -1
- package/package.json +7 -7
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.89.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -3492,7 +3492,7 @@
|
|
|
3492
3492
|
"stability": "experimental"
|
|
3493
3493
|
},
|
|
3494
3494
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
3495
|
-
"jsiiVersion": "5.1.
|
|
3495
|
+
"jsiiVersion": "5.1.9 (build fa65a10)",
|
|
3496
3496
|
"keywords": [
|
|
3497
3497
|
"aws",
|
|
3498
3498
|
"cdk",
|
|
@@ -3513,7 +3513,7 @@
|
|
|
3513
3513
|
},
|
|
3514
3514
|
"name": "@aws-cdk/aws-neptune-alpha",
|
|
3515
3515
|
"readme": {
|
|
3516
|
-
"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() or grant().\n});\nconst role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });\n// Use one of the following statements to grant the role the necessary permissions\ncluster.grantConnect(role); // Grant the role neptune-db:* access to the DB\ncluster.grant(role, 'neptune-db:ReadDataViaQuery', 'neptune-db:WriteDataViaQuery'); // Grant the role the specified actions 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\nNote: if you want to use Neptune engine `1.2.0.0` or later, you need to specify the corresponding `engineVersion` prop to `neptune.DatabaseCluster` and `family` prop of `ParameterGroupFamily.NEPTUNE_1_2` to `neptune.ClusterParameterGroup` and `neptune.ParameterGroup`.\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\n## Logging\n\nNeptune supports various methods for monitoring performance and usage. One of those methods is logging\n\n1. Neptune provides logs e.g. audit logs which can be viewed or downloaded via the AWS Console. Audit logs can be enabled using the `neptune_enable_audit_log` parameter in `ClusterParameterGroup` or `ParameterGroup`\n2. Neptune provides the ability to export those logs to CloudWatch Logs\n\n```ts\n// Cluster parameter group with the neptune_enable_audit_log param set to 1\nconst clusterParameterGroup = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n // Audit logs are enabled via the clusterParameterGroup\n clusterParameterGroup,\n // Optionally configuring audit logs to be exported to CloudWatch Logs\n cloudwatchLogsExports: [neptune.LogType.AUDIT],\n // Optionally set a retention period on exported CloudWatch Logs\n cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,\n});\n```\n\nFor more information on monitoring, refer to https://docs.aws.amazon.com/neptune/latest/userguide/monitoring.html.\nFor more information on audit logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html.\nFor more information on exporting logs to CloudWatch Logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html.\n\n## Metrics\n\nBoth `DatabaseCluster` and `DatabaseInstance` provide a `metric()` method to help with cluster-level and instance-level monitoring.\n\n```ts\ndeclare const cluster: neptune.DatabaseCluster;\ndeclare const instance: neptune.DatabaseInstance;\n\ncluster.metric('SparqlRequestsPerSec'); // cluster-level SparqlErrors metric\ninstance.metric('SparqlRequestsPerSec') // instance-level SparqlErrors metric\n```\n\nFor more details on the available metrics, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html\n"
|
|
3516
|
+
"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() or grant().\n});\nconst role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });\n// Use one of the following statements to grant the role the necessary permissions\ncluster.grantConnect(role); // Grant the role neptune-db:* access to the DB\ncluster.grant(role, 'neptune-db:ReadDataViaQuery', 'neptune-db:WriteDataViaQuery'); // Grant the role the specified actions 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\nNote: if you want to use Neptune engine `1.2.0.0` or later, you need to specify the corresponding `engineVersion` prop to `neptune.DatabaseCluster` and `family` prop of `ParameterGroupFamily.NEPTUNE_1_2` to `neptune.ClusterParameterGroup` and `neptune.ParameterGroup`.\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\n## Logging\n\nNeptune supports various methods for monitoring performance and usage. One of those methods is logging\n\n1. Neptune provides logs e.g. audit logs which can be viewed or downloaded via the AWS Console. Audit logs can be enabled using the `neptune_enable_audit_log` parameter in `ClusterParameterGroup` or `ParameterGroup`\n2. Neptune provides the ability to export those logs to CloudWatch Logs\n\n```ts\n// Cluster parameter group with the neptune_enable_audit_log param set to 1\nconst clusterParameterGroup = new neptune.ClusterParameterGroup(this, 'ClusterParams', {\n description: 'Cluster parameter group',\n parameters: {\n neptune_enable_audit_log: '1'\n },\n});\n\nconst cluster = new neptune.DatabaseCluster(this, 'Database', {\n vpc,\n instanceType: neptune.InstanceType.R5_LARGE,\n // Audit logs are enabled via the clusterParameterGroup\n clusterParameterGroup,\n // Optionally configuring audit logs to be exported to CloudWatch Logs\n cloudwatchLogsExports: [neptune.LogType.AUDIT],\n // Optionally set a retention period on exported CloudWatch Logs\n cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,\n});\n```\n\nFor more information on monitoring, refer to https://docs.aws.amazon.com/neptune/latest/userguide/monitoring.html.\nFor more information on audit logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html.\nFor more information on exporting logs to CloudWatch Logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html.\n\n## Metrics\n\nBoth `DatabaseCluster` and `DatabaseInstance` provide a `metric()` method to help with cluster-level and instance-level monitoring.\n\n```ts\ndeclare const cluster: neptune.DatabaseCluster;\ndeclare const instance: neptune.DatabaseInstance;\n\ncluster.metric('SparqlRequestsPerSec'); // cluster-level SparqlErrors metric\ninstance.metric('SparqlRequestsPerSec') // instance-level SparqlErrors metric\n```\n\nFor more details on the available metrics, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html\n\n## Neptune Serverless\n\nYou can configure a Neptune Serverless cluster using the dedicated instance type along with the\n`serverlessScalingConfiguration` property.\n\n> Visit [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) for more details.\n\n```ts\nconst cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {\n vpc,\n instanceType: neptune.InstanceType.SERVERLESS,\n serverlessScalingConfiguration: {\n minCapacity: 1,\n maxCapacity: 5,\n },\n});\n```\n"
|
|
3517
3517
|
},
|
|
3518
3518
|
"repository": {
|
|
3519
3519
|
"directory": "packages/@aws-cdk/aws-neptune-alpha",
|
|
@@ -3768,7 +3768,7 @@
|
|
|
3768
3768
|
},
|
|
3769
3769
|
"stability": "experimental",
|
|
3770
3770
|
"summary": "Create a clustered database with a given number of instances.",
|
|
3771
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, '
|
|
3771
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {\n vpc,\n instanceType: neptune.InstanceType.SERVERLESS,\n serverlessScalingConfiguration: {\n minCapacity: 1,\n maxCapacity: 5,\n },\n});"
|
|
3772
3772
|
},
|
|
3773
3773
|
"fqn": "@aws-cdk/aws-neptune-alpha.DatabaseCluster",
|
|
3774
3774
|
"initializer": {
|
|
@@ -3777,7 +3777,7 @@
|
|
|
3777
3777
|
},
|
|
3778
3778
|
"locationInModule": {
|
|
3779
3779
|
"filename": "lib/cluster.ts",
|
|
3780
|
-
"line":
|
|
3780
|
+
"line": 549
|
|
3781
3781
|
},
|
|
3782
3782
|
"parameters": [
|
|
3783
3783
|
{
|
|
@@ -3806,7 +3806,7 @@
|
|
|
3806
3806
|
"kind": "class",
|
|
3807
3807
|
"locationInModule": {
|
|
3808
3808
|
"filename": "lib/cluster.ts",
|
|
3809
|
-
"line":
|
|
3809
|
+
"line": 502
|
|
3810
3810
|
},
|
|
3811
3811
|
"name": "DatabaseCluster",
|
|
3812
3812
|
"properties": [
|
|
@@ -3819,7 +3819,7 @@
|
|
|
3819
3819
|
"immutable": true,
|
|
3820
3820
|
"locationInModule": {
|
|
3821
3821
|
"filename": "lib/cluster.ts",
|
|
3822
|
-
"line":
|
|
3822
|
+
"line": 508
|
|
3823
3823
|
},
|
|
3824
3824
|
"name": "DEFAULT_NUM_INSTANCES",
|
|
3825
3825
|
"static": true,
|
|
@@ -3835,7 +3835,7 @@
|
|
|
3835
3835
|
"immutable": true,
|
|
3836
3836
|
"locationInModule": {
|
|
3837
3837
|
"filename": "lib/cluster.ts",
|
|
3838
|
-
"line":
|
|
3838
|
+
"line": 511
|
|
3839
3839
|
},
|
|
3840
3840
|
"name": "clusterEndpoint",
|
|
3841
3841
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
@@ -3851,7 +3851,7 @@
|
|
|
3851
3851
|
"immutable": true,
|
|
3852
3852
|
"locationInModule": {
|
|
3853
3853
|
"filename": "lib/cluster.ts",
|
|
3854
|
-
"line":
|
|
3854
|
+
"line": 510
|
|
3855
3855
|
},
|
|
3856
3856
|
"name": "clusterIdentifier",
|
|
3857
3857
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
@@ -3867,7 +3867,7 @@
|
|
|
3867
3867
|
"immutable": true,
|
|
3868
3868
|
"locationInModule": {
|
|
3869
3869
|
"filename": "lib/cluster.ts",
|
|
3870
|
-
"line":
|
|
3870
|
+
"line": 512
|
|
3871
3871
|
},
|
|
3872
3872
|
"name": "clusterReadEndpoint",
|
|
3873
3873
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
@@ -3887,7 +3887,7 @@
|
|
|
3887
3887
|
"immutable": true,
|
|
3888
3888
|
"locationInModule": {
|
|
3889
3889
|
"filename": "lib/cluster.ts",
|
|
3890
|
-
"line":
|
|
3890
|
+
"line": 520
|
|
3891
3891
|
},
|
|
3892
3892
|
"name": "clusterResourceIdentifier",
|
|
3893
3893
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
@@ -3903,7 +3903,7 @@
|
|
|
3903
3903
|
"immutable": true,
|
|
3904
3904
|
"locationInModule": {
|
|
3905
3905
|
"filename": "lib/cluster.ts",
|
|
3906
|
-
"line":
|
|
3906
|
+
"line": 513
|
|
3907
3907
|
},
|
|
3908
3908
|
"name": "connections",
|
|
3909
3909
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseClusterBase",
|
|
@@ -3919,7 +3919,7 @@
|
|
|
3919
3919
|
"immutable": true,
|
|
3920
3920
|
"locationInModule": {
|
|
3921
3921
|
"filename": "lib/cluster.ts",
|
|
3922
|
-
"line":
|
|
3922
|
+
"line": 545
|
|
3923
3923
|
},
|
|
3924
3924
|
"name": "instanceEndpoints",
|
|
3925
3925
|
"type": {
|
|
@@ -3939,7 +3939,7 @@
|
|
|
3939
3939
|
"immutable": true,
|
|
3940
3940
|
"locationInModule": {
|
|
3941
3941
|
"filename": "lib/cluster.ts",
|
|
3942
|
-
"line":
|
|
3942
|
+
"line": 540
|
|
3943
3943
|
},
|
|
3944
3944
|
"name": "instanceIdentifiers",
|
|
3945
3945
|
"type": {
|
|
@@ -3959,7 +3959,7 @@
|
|
|
3959
3959
|
"immutable": true,
|
|
3960
3960
|
"locationInModule": {
|
|
3961
3961
|
"filename": "lib/cluster.ts",
|
|
3962
|
-
"line":
|
|
3962
|
+
"line": 535
|
|
3963
3963
|
},
|
|
3964
3964
|
"name": "subnetGroup",
|
|
3965
3965
|
"type": {
|
|
@@ -3974,7 +3974,7 @@
|
|
|
3974
3974
|
"immutable": true,
|
|
3975
3975
|
"locationInModule": {
|
|
3976
3976
|
"filename": "lib/cluster.ts",
|
|
3977
|
-
"line":
|
|
3977
|
+
"line": 525
|
|
3978
3978
|
},
|
|
3979
3979
|
"name": "vpc",
|
|
3980
3980
|
"type": {
|
|
@@ -3989,7 +3989,7 @@
|
|
|
3989
3989
|
"immutable": true,
|
|
3990
3990
|
"locationInModule": {
|
|
3991
3991
|
"filename": "lib/cluster.ts",
|
|
3992
|
-
"line":
|
|
3992
|
+
"line": 530
|
|
3993
3993
|
},
|
|
3994
3994
|
"name": "vpcSubnets",
|
|
3995
3995
|
"type": {
|
|
@@ -4002,7 +4002,7 @@
|
|
|
4002
4002
|
},
|
|
4003
4003
|
"locationInModule": {
|
|
4004
4004
|
"filename": "lib/cluster.ts",
|
|
4005
|
-
"line":
|
|
4005
|
+
"line": 547
|
|
4006
4006
|
},
|
|
4007
4007
|
"name": "enableIamAuthentication",
|
|
4008
4008
|
"optional": true,
|
|
@@ -4030,7 +4030,7 @@
|
|
|
4030
4030
|
"kind": "interface",
|
|
4031
4031
|
"locationInModule": {
|
|
4032
4032
|
"filename": "lib/cluster.ts",
|
|
4033
|
-
"line":
|
|
4033
|
+
"line": 375
|
|
4034
4034
|
},
|
|
4035
4035
|
"name": "DatabaseClusterAttributes",
|
|
4036
4036
|
"properties": [
|
|
@@ -4043,7 +4043,7 @@
|
|
|
4043
4043
|
"immutable": true,
|
|
4044
4044
|
"locationInModule": {
|
|
4045
4045
|
"filename": "lib/cluster.ts",
|
|
4046
|
-
"line":
|
|
4046
|
+
"line": 399
|
|
4047
4047
|
},
|
|
4048
4048
|
"name": "clusterEndpointAddress",
|
|
4049
4049
|
"type": {
|
|
@@ -4059,7 +4059,7 @@
|
|
|
4059
4059
|
"immutable": true,
|
|
4060
4060
|
"locationInModule": {
|
|
4061
4061
|
"filename": "lib/cluster.ts",
|
|
4062
|
-
"line":
|
|
4062
|
+
"line": 389
|
|
4063
4063
|
},
|
|
4064
4064
|
"name": "clusterIdentifier",
|
|
4065
4065
|
"type": {
|
|
@@ -4075,7 +4075,7 @@
|
|
|
4075
4075
|
"immutable": true,
|
|
4076
4076
|
"locationInModule": {
|
|
4077
4077
|
"filename": "lib/cluster.ts",
|
|
4078
|
-
"line":
|
|
4078
|
+
"line": 394
|
|
4079
4079
|
},
|
|
4080
4080
|
"name": "clusterResourceIdentifier",
|
|
4081
4081
|
"type": {
|
|
@@ -4091,7 +4091,7 @@
|
|
|
4091
4091
|
"immutable": true,
|
|
4092
4092
|
"locationInModule": {
|
|
4093
4093
|
"filename": "lib/cluster.ts",
|
|
4094
|
-
"line":
|
|
4094
|
+
"line": 379
|
|
4095
4095
|
},
|
|
4096
4096
|
"name": "port",
|
|
4097
4097
|
"type": {
|
|
@@ -4107,7 +4107,7 @@
|
|
|
4107
4107
|
"immutable": true,
|
|
4108
4108
|
"locationInModule": {
|
|
4109
4109
|
"filename": "lib/cluster.ts",
|
|
4110
|
-
"line":
|
|
4110
|
+
"line": 404
|
|
4111
4111
|
},
|
|
4112
4112
|
"name": "readerEndpointAddress",
|
|
4113
4113
|
"type": {
|
|
@@ -4123,7 +4123,7 @@
|
|
|
4123
4123
|
"immutable": true,
|
|
4124
4124
|
"locationInModule": {
|
|
4125
4125
|
"filename": "lib/cluster.ts",
|
|
4126
|
-
"line":
|
|
4126
|
+
"line": 384
|
|
4127
4127
|
},
|
|
4128
4128
|
"name": "securityGroup",
|
|
4129
4129
|
"type": {
|
|
@@ -4182,7 +4182,7 @@
|
|
|
4182
4182
|
"kind": "class",
|
|
4183
4183
|
"locationInModule": {
|
|
4184
4184
|
"filename": "lib/cluster.ts",
|
|
4185
|
-
"line":
|
|
4185
|
+
"line": 410
|
|
4186
4186
|
},
|
|
4187
4187
|
"methods": [
|
|
4188
4188
|
{
|
|
@@ -4192,7 +4192,7 @@
|
|
|
4192
4192
|
},
|
|
4193
4193
|
"locationInModule": {
|
|
4194
4194
|
"filename": "lib/cluster.ts",
|
|
4195
|
-
"line":
|
|
4195
|
+
"line": 415
|
|
4196
4196
|
},
|
|
4197
4197
|
"name": "fromDatabaseClusterAttributes",
|
|
4198
4198
|
"parameters": [
|
|
@@ -4229,7 +4229,7 @@
|
|
|
4229
4229
|
},
|
|
4230
4230
|
"locationInModule": {
|
|
4231
4231
|
"filename": "lib/cluster.ts",
|
|
4232
|
-
"line":
|
|
4232
|
+
"line": 459
|
|
4233
4233
|
},
|
|
4234
4234
|
"name": "grant",
|
|
4235
4235
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4262,7 +4262,7 @@
|
|
|
4262
4262
|
},
|
|
4263
4263
|
"locationInModule": {
|
|
4264
4264
|
"filename": "lib/cluster.ts",
|
|
4265
|
-
"line":
|
|
4265
|
+
"line": 481
|
|
4266
4266
|
},
|
|
4267
4267
|
"name": "grantConnect",
|
|
4268
4268
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4287,7 +4287,7 @@
|
|
|
4287
4287
|
},
|
|
4288
4288
|
"locationInModule": {
|
|
4289
4289
|
"filename": "lib/cluster.ts",
|
|
4290
|
-
"line":
|
|
4290
|
+
"line": 485
|
|
4291
4291
|
},
|
|
4292
4292
|
"name": "metric",
|
|
4293
4293
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4324,7 +4324,7 @@
|
|
|
4324
4324
|
"immutable": true,
|
|
4325
4325
|
"locationInModule": {
|
|
4326
4326
|
"filename": "lib/cluster.ts",
|
|
4327
|
-
"line":
|
|
4327
|
+
"line": 445
|
|
4328
4328
|
},
|
|
4329
4329
|
"name": "clusterEndpoint",
|
|
4330
4330
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4341,7 +4341,7 @@
|
|
|
4341
4341
|
"immutable": true,
|
|
4342
4342
|
"locationInModule": {
|
|
4343
4343
|
"filename": "lib/cluster.ts",
|
|
4344
|
-
"line":
|
|
4344
|
+
"line": 435
|
|
4345
4345
|
},
|
|
4346
4346
|
"name": "clusterIdentifier",
|
|
4347
4347
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4358,7 +4358,7 @@
|
|
|
4358
4358
|
"immutable": true,
|
|
4359
4359
|
"locationInModule": {
|
|
4360
4360
|
"filename": "lib/cluster.ts",
|
|
4361
|
-
"line":
|
|
4361
|
+
"line": 450
|
|
4362
4362
|
},
|
|
4363
4363
|
"name": "clusterReadEndpoint",
|
|
4364
4364
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4375,7 +4375,7 @@
|
|
|
4375
4375
|
"immutable": true,
|
|
4376
4376
|
"locationInModule": {
|
|
4377
4377
|
"filename": "lib/cluster.ts",
|
|
4378
|
-
"line":
|
|
4378
|
+
"line": 440
|
|
4379
4379
|
},
|
|
4380
4380
|
"name": "clusterResourceIdentifier",
|
|
4381
4381
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseCluster",
|
|
@@ -4392,7 +4392,7 @@
|
|
|
4392
4392
|
"immutable": true,
|
|
4393
4393
|
"locationInModule": {
|
|
4394
4394
|
"filename": "lib/cluster.ts",
|
|
4395
|
-
"line":
|
|
4395
|
+
"line": 455
|
|
4396
4396
|
},
|
|
4397
4397
|
"name": "connections",
|
|
4398
4398
|
"overrides": "aws-cdk-lib.aws_ec2.IConnectable",
|
|
@@ -4407,7 +4407,7 @@
|
|
|
4407
4407
|
},
|
|
4408
4408
|
"locationInModule": {
|
|
4409
4409
|
"filename": "lib/cluster.ts",
|
|
4410
|
-
"line":
|
|
4410
|
+
"line": 457
|
|
4411
4411
|
},
|
|
4412
4412
|
"name": "enableIamAuthentication",
|
|
4413
4413
|
"optional": true,
|
|
@@ -4425,7 +4425,7 @@
|
|
|
4425
4425
|
"docs": {
|
|
4426
4426
|
"stability": "experimental",
|
|
4427
4427
|
"summary": "Properties for a new database cluster.",
|
|
4428
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, '
|
|
4428
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {\n vpc,\n instanceType: neptune.InstanceType.SERVERLESS,\n serverlessScalingConfiguration: {\n minCapacity: 1,\n maxCapacity: 5,\n },\n});",
|
|
4429
4429
|
"custom": {
|
|
4430
4430
|
"exampleMetadata": "infused"
|
|
4431
4431
|
}
|
|
@@ -4434,7 +4434,7 @@
|
|
|
4434
4434
|
"kind": "interface",
|
|
4435
4435
|
"locationInModule": {
|
|
4436
4436
|
"filename": "lib/cluster.ts",
|
|
4437
|
-
"line":
|
|
4437
|
+
"line": 122
|
|
4438
4438
|
},
|
|
4439
4439
|
"name": "DatabaseClusterProps",
|
|
4440
4440
|
"properties": [
|
|
@@ -4447,7 +4447,7 @@
|
|
|
4447
4447
|
"immutable": true,
|
|
4448
4448
|
"locationInModule": {
|
|
4449
4449
|
"filename": "lib/cluster.ts",
|
|
4450
|
-
"line":
|
|
4450
|
+
"line": 197
|
|
4451
4451
|
},
|
|
4452
4452
|
"name": "instanceType",
|
|
4453
4453
|
"type": {
|
|
@@ -4464,7 +4464,7 @@
|
|
|
4464
4464
|
"immutable": true,
|
|
4465
4465
|
"locationInModule": {
|
|
4466
4466
|
"filename": "lib/cluster.ts",
|
|
4467
|
-
"line":
|
|
4467
|
+
"line": 251
|
|
4468
4468
|
},
|
|
4469
4469
|
"name": "vpc",
|
|
4470
4470
|
"type": {
|
|
@@ -4481,7 +4481,7 @@
|
|
|
4481
4481
|
"immutable": true,
|
|
4482
4482
|
"locationInModule": {
|
|
4483
4483
|
"filename": "lib/cluster.ts",
|
|
4484
|
-
"line":
|
|
4484
|
+
"line": 204
|
|
4485
4485
|
},
|
|
4486
4486
|
"name": "associatedRoles",
|
|
4487
4487
|
"optional": true,
|
|
@@ -4504,7 +4504,7 @@
|
|
|
4504
4504
|
"immutable": true,
|
|
4505
4505
|
"locationInModule": {
|
|
4506
4506
|
"filename": "lib/cluster.ts",
|
|
4507
|
-
"line":
|
|
4507
|
+
"line": 283
|
|
4508
4508
|
},
|
|
4509
4509
|
"name": "autoMinorVersionUpgrade",
|
|
4510
4510
|
"optional": true,
|
|
@@ -4522,7 +4522,7 @@
|
|
|
4522
4522
|
"immutable": true,
|
|
4523
4523
|
"locationInModule": {
|
|
4524
4524
|
"filename": "lib/cluster.ts",
|
|
4525
|
-
"line":
|
|
4525
|
+
"line": 135
|
|
4526
4526
|
},
|
|
4527
4527
|
"name": "backupRetention",
|
|
4528
4528
|
"optional": true,
|
|
@@ -4541,7 +4541,7 @@
|
|
|
4541
4541
|
"immutable": true,
|
|
4542
4542
|
"locationInModule": {
|
|
4543
4543
|
"filename": "lib/cluster.ts",
|
|
4544
|
-
"line":
|
|
4544
|
+
"line": 294
|
|
4545
4545
|
},
|
|
4546
4546
|
"name": "cloudwatchLogsExports",
|
|
4547
4547
|
"optional": true,
|
|
@@ -4565,7 +4565,7 @@
|
|
|
4565
4565
|
"immutable": true,
|
|
4566
4566
|
"locationInModule": {
|
|
4567
4567
|
"filename": "lib/cluster.ts",
|
|
4568
|
-
"line":
|
|
4568
|
+
"line": 303
|
|
4569
4569
|
},
|
|
4570
4570
|
"name": "cloudwatchLogsRetention",
|
|
4571
4571
|
"optional": true,
|
|
@@ -4583,7 +4583,7 @@
|
|
|
4583
4583
|
"immutable": true,
|
|
4584
4584
|
"locationInModule": {
|
|
4585
4585
|
"filename": "lib/cluster.ts",
|
|
4586
|
-
"line":
|
|
4586
|
+
"line": 311
|
|
4587
4587
|
},
|
|
4588
4588
|
"name": "cloudwatchLogsRetentionRole",
|
|
4589
4589
|
"optional": true,
|
|
@@ -4601,7 +4601,7 @@
|
|
|
4601
4601
|
"immutable": true,
|
|
4602
4602
|
"locationInModule": {
|
|
4603
4603
|
"filename": "lib/cluster.ts",
|
|
4604
|
-
"line":
|
|
4604
|
+
"line": 230
|
|
4605
4605
|
},
|
|
4606
4606
|
"name": "clusterParameterGroup",
|
|
4607
4607
|
"optional": true,
|
|
@@ -4619,7 +4619,7 @@
|
|
|
4619
4619
|
"immutable": true,
|
|
4620
4620
|
"locationInModule": {
|
|
4621
4621
|
"filename": "lib/cluster.ts",
|
|
4622
|
-
"line":
|
|
4622
|
+
"line": 175
|
|
4623
4623
|
},
|
|
4624
4624
|
"name": "dbClusterName",
|
|
4625
4625
|
"optional": true,
|
|
@@ -4637,7 +4637,7 @@
|
|
|
4637
4637
|
"immutable": true,
|
|
4638
4638
|
"locationInModule": {
|
|
4639
4639
|
"filename": "lib/cluster.ts",
|
|
4640
|
-
"line":
|
|
4640
|
+
"line": 211
|
|
4641
4641
|
},
|
|
4642
4642
|
"name": "deletionProtection",
|
|
4643
4643
|
"optional": true,
|
|
@@ -4655,7 +4655,7 @@
|
|
|
4655
4655
|
"immutable": true,
|
|
4656
4656
|
"locationInModule": {
|
|
4657
4657
|
"filename": "lib/cluster.ts",
|
|
4658
|
-
"line":
|
|
4658
|
+
"line": 128
|
|
4659
4659
|
},
|
|
4660
4660
|
"name": "engineVersion",
|
|
4661
4661
|
"optional": true,
|
|
@@ -4673,7 +4673,7 @@
|
|
|
4673
4673
|
"immutable": true,
|
|
4674
4674
|
"locationInModule": {
|
|
4675
4675
|
"filename": "lib/cluster.ts",
|
|
4676
|
-
"line":
|
|
4676
|
+
"line": 182
|
|
4677
4677
|
},
|
|
4678
4678
|
"name": "iamAuthentication",
|
|
4679
4679
|
"optional": true,
|
|
@@ -4692,7 +4692,7 @@
|
|
|
4692
4692
|
"immutable": true,
|
|
4693
4693
|
"locationInModule": {
|
|
4694
4694
|
"filename": "lib/cluster.ts",
|
|
4695
|
-
"line":
|
|
4695
|
+
"line": 192
|
|
4696
4696
|
},
|
|
4697
4697
|
"name": "instanceIdentifierBase",
|
|
4698
4698
|
"optional": true,
|
|
@@ -4710,7 +4710,7 @@
|
|
|
4710
4710
|
"immutable": true,
|
|
4711
4711
|
"locationInModule": {
|
|
4712
4712
|
"filename": "lib/cluster.ts",
|
|
4713
|
-
"line":
|
|
4713
|
+
"line": 168
|
|
4714
4714
|
},
|
|
4715
4715
|
"name": "instances",
|
|
4716
4716
|
"optional": true,
|
|
@@ -4728,7 +4728,7 @@
|
|
|
4728
4728
|
"immutable": true,
|
|
4729
4729
|
"locationInModule": {
|
|
4730
4730
|
"filename": "lib/cluster.ts",
|
|
4731
|
-
"line":
|
|
4731
|
+
"line": 154
|
|
4732
4732
|
},
|
|
4733
4733
|
"name": "kmsKey",
|
|
4734
4734
|
"optional": true,
|
|
@@ -4746,7 +4746,7 @@
|
|
|
4746
4746
|
"immutable": true,
|
|
4747
4747
|
"locationInModule": {
|
|
4748
4748
|
"filename": "lib/cluster.ts",
|
|
4749
|
-
"line":
|
|
4749
|
+
"line": 237
|
|
4750
4750
|
},
|
|
4751
4751
|
"name": "parameterGroup",
|
|
4752
4752
|
"optional": true,
|
|
@@ -4765,7 +4765,7 @@
|
|
|
4765
4765
|
"immutable": true,
|
|
4766
4766
|
"locationInModule": {
|
|
4767
4767
|
"filename": "lib/cluster.ts",
|
|
4768
|
-
"line":
|
|
4768
|
+
"line": 147
|
|
4769
4769
|
},
|
|
4770
4770
|
"name": "preferredBackupWindow",
|
|
4771
4771
|
"optional": true,
|
|
@@ -4784,7 +4784,7 @@
|
|
|
4784
4784
|
"immutable": true,
|
|
4785
4785
|
"locationInModule": {
|
|
4786
4786
|
"filename": "lib/cluster.ts",
|
|
4787
|
-
"line":
|
|
4787
|
+
"line": 223
|
|
4788
4788
|
},
|
|
4789
4789
|
"name": "preferredMaintenanceWindow",
|
|
4790
4790
|
"optional": true,
|
|
@@ -4803,7 +4803,7 @@
|
|
|
4803
4803
|
"immutable": true,
|
|
4804
4804
|
"locationInModule": {
|
|
4805
4805
|
"filename": "lib/cluster.ts",
|
|
4806
|
-
"line":
|
|
4806
|
+
"line": 275
|
|
4807
4807
|
},
|
|
4808
4808
|
"name": "removalPolicy",
|
|
4809
4809
|
"optional": true,
|
|
@@ -4821,7 +4821,7 @@
|
|
|
4821
4821
|
"immutable": true,
|
|
4822
4822
|
"locationInModule": {
|
|
4823
4823
|
"filename": "lib/cluster.ts",
|
|
4824
|
-
"line":
|
|
4824
|
+
"line": 265
|
|
4825
4825
|
},
|
|
4826
4826
|
"name": "securityGroups",
|
|
4827
4827
|
"optional": true,
|
|
@@ -4834,6 +4834,25 @@
|
|
|
4834
4834
|
}
|
|
4835
4835
|
}
|
|
4836
4836
|
},
|
|
4837
|
+
{
|
|
4838
|
+
"abstract": true,
|
|
4839
|
+
"docs": {
|
|
4840
|
+
"default": "- required if instanceType is db.serverless",
|
|
4841
|
+
"remarks": "See https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-capacity-scaling.html",
|
|
4842
|
+
"stability": "experimental",
|
|
4843
|
+
"summary": "Specify minimum and maximum NCUs capacity for a serverless cluster."
|
|
4844
|
+
},
|
|
4845
|
+
"immutable": true,
|
|
4846
|
+
"locationInModule": {
|
|
4847
|
+
"filename": "lib/cluster.ts",
|
|
4848
|
+
"line": 319
|
|
4849
|
+
},
|
|
4850
|
+
"name": "serverlessScalingConfiguration",
|
|
4851
|
+
"optional": true,
|
|
4852
|
+
"type": {
|
|
4853
|
+
"fqn": "@aws-cdk/aws-neptune-alpha.ServerlessScalingConfiguration"
|
|
4854
|
+
}
|
|
4855
|
+
},
|
|
4837
4856
|
{
|
|
4838
4857
|
"abstract": true,
|
|
4839
4858
|
"docs": {
|
|
@@ -4844,7 +4863,7 @@
|
|
|
4844
4863
|
"immutable": true,
|
|
4845
4864
|
"locationInModule": {
|
|
4846
4865
|
"filename": "lib/cluster.ts",
|
|
4847
|
-
"line":
|
|
4866
|
+
"line": 161
|
|
4848
4867
|
},
|
|
4849
4868
|
"name": "storageEncrypted",
|
|
4850
4869
|
"optional": true,
|
|
@@ -4862,7 +4881,7 @@
|
|
|
4862
4881
|
"immutable": true,
|
|
4863
4882
|
"locationInModule": {
|
|
4864
4883
|
"filename": "lib/cluster.ts",
|
|
4865
|
-
"line":
|
|
4884
|
+
"line": 244
|
|
4866
4885
|
},
|
|
4867
4886
|
"name": "subnetGroup",
|
|
4868
4887
|
"optional": true,
|
|
@@ -4880,7 +4899,7 @@
|
|
|
4880
4899
|
"immutable": true,
|
|
4881
4900
|
"locationInModule": {
|
|
4882
4901
|
"filename": "lib/cluster.ts",
|
|
4883
|
-
"line":
|
|
4902
|
+
"line": 258
|
|
4884
4903
|
},
|
|
4885
4904
|
"name": "vpcSubnets",
|
|
4886
4905
|
"optional": true,
|
|
@@ -4910,7 +4929,7 @@
|
|
|
4910
4929
|
},
|
|
4911
4930
|
"locationInModule": {
|
|
4912
4931
|
"filename": "lib/instance.ts",
|
|
4913
|
-
"line":
|
|
4932
|
+
"line": 334
|
|
4914
4933
|
},
|
|
4915
4934
|
"parameters": [
|
|
4916
4935
|
{
|
|
@@ -4939,7 +4958,7 @@
|
|
|
4939
4958
|
"kind": "class",
|
|
4940
4959
|
"locationInModule": {
|
|
4941
4960
|
"filename": "lib/instance.ts",
|
|
4942
|
-
"line":
|
|
4961
|
+
"line": 307
|
|
4943
4962
|
},
|
|
4944
4963
|
"name": "DatabaseInstance",
|
|
4945
4964
|
"properties": [
|
|
@@ -4951,7 +4970,7 @@
|
|
|
4951
4970
|
"immutable": true,
|
|
4952
4971
|
"locationInModule": {
|
|
4953
4972
|
"filename": "lib/instance.ts",
|
|
4954
|
-
"line":
|
|
4973
|
+
"line": 312
|
|
4955
4974
|
},
|
|
4956
4975
|
"name": "cluster",
|
|
4957
4976
|
"type": {
|
|
@@ -4969,7 +4988,7 @@
|
|
|
4969
4988
|
"immutable": true,
|
|
4970
4989
|
"locationInModule": {
|
|
4971
4990
|
"filename": "lib/instance.ts",
|
|
4972
|
-
"line":
|
|
4991
|
+
"line": 327
|
|
4973
4992
|
},
|
|
4974
4993
|
"name": "dbInstanceEndpointAddress",
|
|
4975
4994
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseInstanceBase",
|
|
@@ -4988,7 +5007,7 @@
|
|
|
4988
5007
|
"immutable": true,
|
|
4989
5008
|
"locationInModule": {
|
|
4990
5009
|
"filename": "lib/instance.ts",
|
|
4991
|
-
"line":
|
|
5010
|
+
"line": 332
|
|
4992
5011
|
},
|
|
4993
5012
|
"name": "dbInstanceEndpointPort",
|
|
4994
5013
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseInstanceBase",
|
|
@@ -5007,7 +5026,7 @@
|
|
|
5007
5026
|
"immutable": true,
|
|
5008
5027
|
"locationInModule": {
|
|
5009
5028
|
"filename": "lib/instance.ts",
|
|
5010
|
-
"line":
|
|
5029
|
+
"line": 322
|
|
5011
5030
|
},
|
|
5012
5031
|
"name": "instanceEndpoint",
|
|
5013
5032
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseInstanceBase",
|
|
@@ -5026,7 +5045,7 @@
|
|
|
5026
5045
|
"immutable": true,
|
|
5027
5046
|
"locationInModule": {
|
|
5028
5047
|
"filename": "lib/instance.ts",
|
|
5029
|
-
"line":
|
|
5048
|
+
"line": 317
|
|
5030
5049
|
},
|
|
5031
5050
|
"name": "instanceIdentifier",
|
|
5032
5051
|
"overrides": "@aws-cdk/aws-neptune-alpha.DatabaseInstanceBase",
|
|
@@ -5052,7 +5071,7 @@
|
|
|
5052
5071
|
"kind": "interface",
|
|
5053
5072
|
"locationInModule": {
|
|
5054
5073
|
"filename": "lib/instance.ts",
|
|
5055
|
-
"line":
|
|
5074
|
+
"line": 187
|
|
5056
5075
|
},
|
|
5057
5076
|
"name": "DatabaseInstanceAttributes",
|
|
5058
5077
|
"properties": [
|
|
@@ -5065,7 +5084,7 @@
|
|
|
5065
5084
|
"immutable": true,
|
|
5066
5085
|
"locationInModule": {
|
|
5067
5086
|
"filename": "lib/instance.ts",
|
|
5068
|
-
"line":
|
|
5087
|
+
"line": 196
|
|
5069
5088
|
},
|
|
5070
5089
|
"name": "instanceEndpointAddress",
|
|
5071
5090
|
"type": {
|
|
@@ -5081,7 +5100,7 @@
|
|
|
5081
5100
|
"immutable": true,
|
|
5082
5101
|
"locationInModule": {
|
|
5083
5102
|
"filename": "lib/instance.ts",
|
|
5084
|
-
"line":
|
|
5103
|
+
"line": 191
|
|
5085
5104
|
},
|
|
5086
5105
|
"name": "instanceIdentifier",
|
|
5087
5106
|
"type": {
|
|
@@ -5097,7 +5116,7 @@
|
|
|
5097
5116
|
"immutable": true,
|
|
5098
5117
|
"locationInModule": {
|
|
5099
5118
|
"filename": "lib/instance.ts",
|
|
5100
|
-
"line":
|
|
5119
|
+
"line": 201
|
|
5101
5120
|
},
|
|
5102
5121
|
"name": "port",
|
|
5103
5122
|
"type": {
|
|
@@ -5156,7 +5175,7 @@
|
|
|
5156
5175
|
"kind": "class",
|
|
5157
5176
|
"locationInModule": {
|
|
5158
5177
|
"filename": "lib/instance.ts",
|
|
5159
|
-
"line":
|
|
5178
|
+
"line": 252
|
|
5160
5179
|
},
|
|
5161
5180
|
"methods": [
|
|
5162
5181
|
{
|
|
@@ -5166,7 +5185,7 @@
|
|
|
5166
5185
|
},
|
|
5167
5186
|
"locationInModule": {
|
|
5168
5187
|
"filename": "lib/instance.ts",
|
|
5169
|
-
"line":
|
|
5188
|
+
"line": 256
|
|
5170
5189
|
},
|
|
5171
5190
|
"name": "fromDatabaseInstanceAttributes",
|
|
5172
5191
|
"parameters": [
|
|
@@ -5206,7 +5225,7 @@
|
|
|
5206
5225
|
},
|
|
5207
5226
|
"locationInModule": {
|
|
5208
5227
|
"filename": "lib/instance.ts",
|
|
5209
|
-
"line":
|
|
5228
|
+
"line": 290
|
|
5210
5229
|
},
|
|
5211
5230
|
"name": "metric",
|
|
5212
5231
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseInstance",
|
|
@@ -5246,7 +5265,7 @@
|
|
|
5246
5265
|
"immutable": true,
|
|
5247
5266
|
"locationInModule": {
|
|
5248
5267
|
"filename": "lib/instance.ts",
|
|
5249
|
-
"line":
|
|
5268
|
+
"line": 270
|
|
5250
5269
|
},
|
|
5251
5270
|
"name": "dbInstanceEndpointAddress",
|
|
5252
5271
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseInstance",
|
|
@@ -5266,7 +5285,7 @@
|
|
|
5266
5285
|
"immutable": true,
|
|
5267
5286
|
"locationInModule": {
|
|
5268
5287
|
"filename": "lib/instance.ts",
|
|
5269
|
-
"line":
|
|
5288
|
+
"line": 275
|
|
5270
5289
|
},
|
|
5271
5290
|
"name": "dbInstanceEndpointPort",
|
|
5272
5291
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseInstance",
|
|
@@ -5286,7 +5305,7 @@
|
|
|
5286
5305
|
"immutable": true,
|
|
5287
5306
|
"locationInModule": {
|
|
5288
5307
|
"filename": "lib/instance.ts",
|
|
5289
|
-
"line":
|
|
5308
|
+
"line": 280
|
|
5290
5309
|
},
|
|
5291
5310
|
"name": "instanceEndpoint",
|
|
5292
5311
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseInstance",
|
|
@@ -5306,7 +5325,7 @@
|
|
|
5306
5325
|
"immutable": true,
|
|
5307
5326
|
"locationInModule": {
|
|
5308
5327
|
"filename": "lib/instance.ts",
|
|
5309
|
-
"line":
|
|
5328
|
+
"line": 285
|
|
5310
5329
|
},
|
|
5311
5330
|
"name": "instanceIdentifier",
|
|
5312
5331
|
"overrides": "@aws-cdk/aws-neptune-alpha.IDatabaseInstance",
|
|
@@ -5332,7 +5351,7 @@
|
|
|
5332
5351
|
"kind": "interface",
|
|
5333
5352
|
"locationInModule": {
|
|
5334
5353
|
"filename": "lib/instance.ts",
|
|
5335
|
-
"line":
|
|
5354
|
+
"line": 207
|
|
5336
5355
|
},
|
|
5337
5356
|
"name": "DatabaseInstanceProps",
|
|
5338
5357
|
"properties": [
|
|
@@ -5345,7 +5364,7 @@
|
|
|
5345
5364
|
"immutable": true,
|
|
5346
5365
|
"locationInModule": {
|
|
5347
5366
|
"filename": "lib/instance.ts",
|
|
5348
|
-
"line":
|
|
5367
|
+
"line": 211
|
|
5349
5368
|
},
|
|
5350
5369
|
"name": "cluster",
|
|
5351
5370
|
"type": {
|
|
@@ -5361,7 +5380,7 @@
|
|
|
5361
5380
|
"immutable": true,
|
|
5362
5381
|
"locationInModule": {
|
|
5363
5382
|
"filename": "lib/instance.ts",
|
|
5364
|
-
"line":
|
|
5383
|
+
"line": 216
|
|
5365
5384
|
},
|
|
5366
5385
|
"name": "instanceType",
|
|
5367
5386
|
"type": {
|
|
@@ -5378,7 +5397,7 @@
|
|
|
5378
5397
|
"immutable": true,
|
|
5379
5398
|
"locationInModule": {
|
|
5380
5399
|
"filename": "lib/instance.ts",
|
|
5381
|
-
"line":
|
|
5400
|
+
"line": 223
|
|
5382
5401
|
},
|
|
5383
5402
|
"name": "availabilityZone",
|
|
5384
5403
|
"optional": true,
|
|
@@ -5397,7 +5416,7 @@
|
|
|
5397
5416
|
"immutable": true,
|
|
5398
5417
|
"locationInModule": {
|
|
5399
5418
|
"filename": "lib/instance.ts",
|
|
5400
|
-
"line":
|
|
5419
|
+
"line": 231
|
|
5401
5420
|
},
|
|
5402
5421
|
"name": "dbInstanceName",
|
|
5403
5422
|
"optional": true,
|
|
@@ -5415,7 +5434,7 @@
|
|
|
5415
5434
|
"immutable": true,
|
|
5416
5435
|
"locationInModule": {
|
|
5417
5436
|
"filename": "lib/instance.ts",
|
|
5418
|
-
"line":
|
|
5437
|
+
"line": 238
|
|
5419
5438
|
},
|
|
5420
5439
|
"name": "parameterGroup",
|
|
5421
5440
|
"optional": true,
|
|
@@ -5433,7 +5452,7 @@
|
|
|
5433
5452
|
"immutable": true,
|
|
5434
5453
|
"locationInModule": {
|
|
5435
5454
|
"filename": "lib/instance.ts",
|
|
5436
|
-
"line":
|
|
5455
|
+
"line": 246
|
|
5437
5456
|
},
|
|
5438
5457
|
"name": "removalPolicy",
|
|
5439
5458
|
"optional": true,
|
|
@@ -5896,7 +5915,7 @@
|
|
|
5896
5915
|
"kind": "interface",
|
|
5897
5916
|
"locationInModule": {
|
|
5898
5917
|
"filename": "lib/cluster.ts",
|
|
5899
|
-
"line":
|
|
5918
|
+
"line": 325
|
|
5900
5919
|
},
|
|
5901
5920
|
"methods": [
|
|
5902
5921
|
{
|
|
@@ -5908,7 +5927,7 @@
|
|
|
5908
5927
|
},
|
|
5909
5928
|
"locationInModule": {
|
|
5910
5929
|
"filename": "lib/cluster.ts",
|
|
5911
|
-
"line":
|
|
5930
|
+
"line": 356
|
|
5912
5931
|
},
|
|
5913
5932
|
"name": "grant",
|
|
5914
5933
|
"parameters": [
|
|
@@ -5947,7 +5966,7 @@
|
|
|
5947
5966
|
},
|
|
5948
5967
|
"locationInModule": {
|
|
5949
5968
|
"filename": "lib/cluster.ts",
|
|
5950
|
-
"line":
|
|
5969
|
+
"line": 361
|
|
5951
5970
|
},
|
|
5952
5971
|
"name": "grantConnect",
|
|
5953
5972
|
"parameters": [
|
|
@@ -5973,7 +5992,7 @@
|
|
|
5973
5992
|
},
|
|
5974
5993
|
"locationInModule": {
|
|
5975
5994
|
"filename": "lib/cluster.ts",
|
|
5976
|
-
"line":
|
|
5995
|
+
"line": 369
|
|
5977
5996
|
},
|
|
5978
5997
|
"name": "metric",
|
|
5979
5998
|
"parameters": [
|
|
@@ -6012,7 +6031,7 @@
|
|
|
6012
6031
|
"immutable": true,
|
|
6013
6032
|
"locationInModule": {
|
|
6014
6033
|
"filename": "lib/cluster.ts",
|
|
6015
|
-
"line":
|
|
6034
|
+
"line": 341
|
|
6016
6035
|
},
|
|
6017
6036
|
"name": "clusterEndpoint",
|
|
6018
6037
|
"type": {
|
|
@@ -6028,7 +6047,7 @@
|
|
|
6028
6047
|
"immutable": true,
|
|
6029
6048
|
"locationInModule": {
|
|
6030
6049
|
"filename": "lib/cluster.ts",
|
|
6031
|
-
"line":
|
|
6050
|
+
"line": 329
|
|
6032
6051
|
},
|
|
6033
6052
|
"name": "clusterIdentifier",
|
|
6034
6053
|
"type": {
|
|
@@ -6047,7 +6066,7 @@
|
|
|
6047
6066
|
"immutable": true,
|
|
6048
6067
|
"locationInModule": {
|
|
6049
6068
|
"filename": "lib/cluster.ts",
|
|
6050
|
-
"line":
|
|
6069
|
+
"line": 347
|
|
6051
6070
|
},
|
|
6052
6071
|
"name": "clusterReadEndpoint",
|
|
6053
6072
|
"type": {
|
|
@@ -6066,7 +6085,7 @@
|
|
|
6066
6085
|
"immutable": true,
|
|
6067
6086
|
"locationInModule": {
|
|
6068
6087
|
"filename": "lib/cluster.ts",
|
|
6069
|
-
"line":
|
|
6088
|
+
"line": 335
|
|
6070
6089
|
},
|
|
6071
6090
|
"name": "clusterResourceIdentifier",
|
|
6072
6091
|
"type": {
|
|
@@ -6089,7 +6108,7 @@
|
|
|
6089
6108
|
"kind": "interface",
|
|
6090
6109
|
"locationInModule": {
|
|
6091
6110
|
"filename": "lib/instance.ts",
|
|
6092
|
-
"line":
|
|
6111
|
+
"line": 150
|
|
6093
6112
|
},
|
|
6094
6113
|
"methods": [
|
|
6095
6114
|
{
|
|
@@ -6101,7 +6120,7 @@
|
|
|
6101
6120
|
},
|
|
6102
6121
|
"locationInModule": {
|
|
6103
6122
|
"filename": "lib/instance.ts",
|
|
6104
|
-
"line":
|
|
6123
|
+
"line": 181
|
|
6105
6124
|
},
|
|
6106
6125
|
"name": "metric",
|
|
6107
6126
|
"parameters": [
|
|
@@ -6140,7 +6159,7 @@
|
|
|
6140
6159
|
"immutable": true,
|
|
6141
6160
|
"locationInModule": {
|
|
6142
6161
|
"filename": "lib/instance.ts",
|
|
6143
|
-
"line":
|
|
6162
|
+
"line": 166
|
|
6144
6163
|
},
|
|
6145
6164
|
"name": "dbInstanceEndpointAddress",
|
|
6146
6165
|
"type": {
|
|
@@ -6159,7 +6178,7 @@
|
|
|
6159
6178
|
"immutable": true,
|
|
6160
6179
|
"locationInModule": {
|
|
6161
6180
|
"filename": "lib/instance.ts",
|
|
6162
|
-
"line":
|
|
6181
|
+
"line": 173
|
|
6163
6182
|
},
|
|
6164
6183
|
"name": "dbInstanceEndpointPort",
|
|
6165
6184
|
"type": {
|
|
@@ -6175,7 +6194,7 @@
|
|
|
6175
6194
|
"immutable": true,
|
|
6176
6195
|
"locationInModule": {
|
|
6177
6196
|
"filename": "lib/instance.ts",
|
|
6178
|
-
"line":
|
|
6197
|
+
"line": 159
|
|
6179
6198
|
},
|
|
6180
6199
|
"name": "instanceEndpoint",
|
|
6181
6200
|
"type": {
|
|
@@ -6191,7 +6210,7 @@
|
|
|
6191
6210
|
"immutable": true,
|
|
6192
6211
|
"locationInModule": {
|
|
6193
6212
|
"filename": "lib/instance.ts",
|
|
6194
|
-
"line":
|
|
6213
|
+
"line": 154
|
|
6195
6214
|
},
|
|
6196
6215
|
"name": "instanceIdentifier",
|
|
6197
6216
|
"type": {
|
|
@@ -6281,7 +6300,7 @@
|
|
|
6281
6300
|
"docs": {
|
|
6282
6301
|
"stability": "experimental",
|
|
6283
6302
|
"summary": "Possible Instances Types to use in Neptune cluster used for defining `DatabaseInstanceProps.instanceType`.",
|
|
6284
|
-
"example": "const cluster = new neptune.DatabaseCluster(this, '
|
|
6303
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {\n vpc,\n instanceType: neptune.InstanceType.SERVERLESS,\n serverlessScalingConfiguration: {\n minCapacity: 1,\n maxCapacity: 5,\n },\n});",
|
|
6285
6304
|
"custom": {
|
|
6286
6305
|
"exampleMetadata": "infused"
|
|
6287
6306
|
}
|
|
@@ -6300,7 +6319,7 @@
|
|
|
6300
6319
|
},
|
|
6301
6320
|
"locationInModule": {
|
|
6302
6321
|
"filename": "lib/instance.ts",
|
|
6303
|
-
"line":
|
|
6322
|
+
"line": 129
|
|
6304
6323
|
},
|
|
6305
6324
|
"name": "of",
|
|
6306
6325
|
"parameters": [
|
|
@@ -6644,6 +6663,23 @@
|
|
|
6644
6663
|
"fqn": "@aws-cdk/aws-neptune-alpha.InstanceType"
|
|
6645
6664
|
}
|
|
6646
6665
|
},
|
|
6666
|
+
{
|
|
6667
|
+
"const": true,
|
|
6668
|
+
"docs": {
|
|
6669
|
+
"stability": "experimental",
|
|
6670
|
+
"summary": "db.serverless."
|
|
6671
|
+
},
|
|
6672
|
+
"immutable": true,
|
|
6673
|
+
"locationInModule": {
|
|
6674
|
+
"filename": "lib/instance.ts",
|
|
6675
|
+
"line": 124
|
|
6676
|
+
},
|
|
6677
|
+
"name": "SERVERLESS",
|
|
6678
|
+
"static": true,
|
|
6679
|
+
"type": {
|
|
6680
|
+
"fqn": "@aws-cdk/aws-neptune-alpha.InstanceType"
|
|
6681
|
+
}
|
|
6682
|
+
},
|
|
6647
6683
|
{
|
|
6648
6684
|
"const": true,
|
|
6649
6685
|
"docs": {
|
|
@@ -7055,6 +7091,59 @@
|
|
|
7055
7091
|
],
|
|
7056
7092
|
"symbolId": "lib/parameter-group:ParameterGroupProps"
|
|
7057
7093
|
},
|
|
7094
|
+
"@aws-cdk/aws-neptune-alpha.ServerlessScalingConfiguration": {
|
|
7095
|
+
"assembly": "@aws-cdk/aws-neptune-alpha",
|
|
7096
|
+
"datatype": true,
|
|
7097
|
+
"docs": {
|
|
7098
|
+
"stability": "experimental",
|
|
7099
|
+
"example": "const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {\n vpc,\n instanceType: neptune.InstanceType.SERVERLESS,\n serverlessScalingConfiguration: {\n minCapacity: 1,\n maxCapacity: 5,\n },\n});",
|
|
7100
|
+
"custom": {
|
|
7101
|
+
"exampleMetadata": "infused"
|
|
7102
|
+
}
|
|
7103
|
+
},
|
|
7104
|
+
"fqn": "@aws-cdk/aws-neptune-alpha.ServerlessScalingConfiguration",
|
|
7105
|
+
"kind": "interface",
|
|
7106
|
+
"locationInModule": {
|
|
7107
|
+
"filename": "lib/cluster.ts",
|
|
7108
|
+
"line": 107
|
|
7109
|
+
},
|
|
7110
|
+
"name": "ServerlessScalingConfiguration",
|
|
7111
|
+
"properties": [
|
|
7112
|
+
{
|
|
7113
|
+
"abstract": true,
|
|
7114
|
+
"docs": {
|
|
7115
|
+
"stability": "experimental",
|
|
7116
|
+
"summary": "Maximum NCU capacity (min value 2.5 - max value 128)."
|
|
7117
|
+
},
|
|
7118
|
+
"immutable": true,
|
|
7119
|
+
"locationInModule": {
|
|
7120
|
+
"filename": "lib/cluster.ts",
|
|
7121
|
+
"line": 116
|
|
7122
|
+
},
|
|
7123
|
+
"name": "maxCapacity",
|
|
7124
|
+
"type": {
|
|
7125
|
+
"primitive": "number"
|
|
7126
|
+
}
|
|
7127
|
+
},
|
|
7128
|
+
{
|
|
7129
|
+
"abstract": true,
|
|
7130
|
+
"docs": {
|
|
7131
|
+
"stability": "experimental",
|
|
7132
|
+
"summary": "Minimum NCU capacity (min value 1)."
|
|
7133
|
+
},
|
|
7134
|
+
"immutable": true,
|
|
7135
|
+
"locationInModule": {
|
|
7136
|
+
"filename": "lib/cluster.ts",
|
|
7137
|
+
"line": 111
|
|
7138
|
+
},
|
|
7139
|
+
"name": "minCapacity",
|
|
7140
|
+
"type": {
|
|
7141
|
+
"primitive": "number"
|
|
7142
|
+
}
|
|
7143
|
+
}
|
|
7144
|
+
],
|
|
7145
|
+
"symbolId": "lib/cluster:ServerlessScalingConfiguration"
|
|
7146
|
+
},
|
|
7058
7147
|
"@aws-cdk/aws-neptune-alpha.SubnetGroup": {
|
|
7059
7148
|
"assembly": "@aws-cdk/aws-neptune-alpha",
|
|
7060
7149
|
"base": "aws-cdk-lib.Resource",
|
|
@@ -7276,6 +7365,6 @@
|
|
|
7276
7365
|
"symbolId": "lib/subnet-group:SubnetGroupProps"
|
|
7277
7366
|
}
|
|
7278
7367
|
},
|
|
7279
|
-
"version": "2.
|
|
7368
|
+
"version": "2.89.0-alpha.0",
|
|
7280
7369
|
"fingerprint": "**********"
|
|
7281
7370
|
}
|