@swamp/aws/neptune
v2026.04.23.3
AWS NEPTUNE infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
awsneptunecloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/aws/neptune@swamp/aws/neptune/dbclusterv2026.04.23.2dbcluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| AssociatedRoles? | array | Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. |
| AvailabilityZones? | array | Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. |
| BackupRetentionPeriod? | number | Specifies the number of days for which automatic DB snapshots are retained. |
| CopyTagsToSnapshot? | boolean | A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them. |
| DBClusterIdentifier? | string | The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string. |
| DBClusterParameterGroupName? | string | Provides the name of the DB cluster parameter group. |
| DBInstanceParameterGroupName? | string | The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request. |
| DBPort? | number | The port number on which the DB instances in the DB cluster accept connections. If not specified, the default port used is `8182`. Note: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities. |
| DBSubnetGroupName? | string | Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. |
| DeletionProtection? | boolean | Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. |
| EnableCloudwatchLogsExports? | array | Specifies a list of log types that are enabled for export to CloudWatch Logs. |
| EngineVersion? | string | Indicates the database engine version. |
| IamAuthEnabled? | boolean | True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
| KmsKeyId? | string | The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true. |
| PreferredBackupWindow? | string | Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
| PreferredMaintenanceWindow? | string | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
| RestoreToTime? | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. |
| RestoreType? | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. |
| ServerlessScalingConfiguration? | object | Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster. |
| SnapshotIdentifier? | string | Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original D |
| SourceDBClusterIdentifier? | string | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. |
| StorageEncrypted? | boolean | Indicates whether the DB cluster is encrypted. If you specify the KmsKeyId property, then you must enable encryption and set this property to true. If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster. If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited |
| Tags? | array | The tags assigned to this cluster. |
| UseLatestRestorableTime? | boolean | Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. |
| VpcSecurityGroupIds? | array | Provides a list of VPC security groups that the DB cluster belongs to. |
createCreate a Neptune DBCluster
getGet a Neptune DBCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBCluster |
updateUpdate a Neptune DBCluster
deleteDelete a Neptune DBCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBCluster |
syncSync Neptune DBCluster state from AWS
Resources
state(infinite)— Neptune DBCluster resource state
@swamp/aws/neptune/dbcluster-parameter-groupv2026.04.23.2dbcluster_parameter_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| Description | string | Provides the customer-specified description for this DB cluster parameter group. |
| Family | string | Must be neptune1 for engine versions prior to 1.2.0.0, or neptune1.2 for engine version 1.2.0.0 and higher. |
| Parameters | string | An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. |
| Name? | string | Provides the name of the DB cluster parameter group. |
| Tags? | array | The list of tags for the cluster parameter group. |
createCreate a Neptune DBClusterParameterGroup
getGet a Neptune DBClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBClusterParameterGroup |
updateUpdate a Neptune DBClusterParameterGroup
deleteDelete a Neptune DBClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBClusterParameterGroup |
syncSync Neptune DBClusterParameterGroup state from AWS
Resources
state(infinite)— Neptune DBClusterParameterGroup resource state
@swamp/aws/neptune/dbinstancev2026.04.23.2dbinstance.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| AllowMajorVersionUpgrade? | boolean | Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. |
| AutoMinorVersionUpgrade? | boolean | Indicates that minor version patches are applied automatically. When updating this property, some interruptions may occur. |
| PubliclyAccessible? | boolean | Indicates that public accessibility is enabled. This should be enabled in combination with IAM Auth enabled on the DBCluster |
| AvailabilityZone? | string | Specifies the name of the Availability Zone the DB instance is located in. |
| DBClusterIdentifier? | string | If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. |
| DBInstanceClass | string | Contains the name of the compute and memory capacity class of the DB instance. If you update this property, some interruptions may occur. |
| DBInstanceIdentifier? | string | Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. |
| DBParameterGroupName? | string | The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. |
| DBSnapshotIdentifier? | string | This parameter is not supported. `AWS::Neptune::DBInstance` does not support restoring from snapshots. `AWS::Neptune::DBCluster` does support restoring from snapshots. |
| DBSubnetGroupName? | string | A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC). |
| PreferredMaintenanceWindow? | string | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this DB instance. |
createCreate a Neptune DBInstance
getGet a Neptune DBInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBInstance |
updateUpdate a Neptune DBInstance
deleteDelete a Neptune DBInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBInstance |
syncSync Neptune DBInstance state from AWS
Resources
state(infinite)— Neptune DBInstance resource state
@swamp/aws/neptune/dbparameter-groupv2026.04.23.2dbparameter_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| Name? | string | Provides the name of the DB parameter group. |
| Description | string | Provides the customer-specified description for this DB parameter group. |
| Family | string | Must be `neptune1` for engine versions prior to 1.2.0.0, or `neptune1.2` for engine version `1.2.0.0` and higher. |
| Parameters | string | The parameters to set for this DB parameter group. The parameters are expressed as a JSON object consisting of key-value pairs. Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover. |
| Tags? | array | An optional array of key-value pairs to apply to this DB parameter group. |
createCreate a Neptune DBParameterGroup
getGet a Neptune DBParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBParameterGroup |
updateUpdate a Neptune DBParameterGroup
deleteDelete a Neptune DBParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBParameterGroup |
syncSync Neptune DBParameterGroup state from AWS
Resources
state(infinite)— Neptune DBParameterGroup resource state
@swamp/aws/neptune/dbsubnet-groupv2026.04.23.2dbsubnet_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| DBSubnetGroupName? | string | The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". Example: mysubnetgroup |
| DBSubnetGroupDescription | string | The description for the DB subnet group. |
| SubnetIds | array | The Amazon EC2 subnet IDs for the DB subnet group. |
| Tags? | array | An optional array of key-value pairs to apply to this DB subnet group. |
createCreate a Neptune DBSubnetGroup
getGet a Neptune DBSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBSubnetGroup |
updateUpdate a Neptune DBSubnetGroup
deleteDelete a Neptune DBSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune DBSubnetGroup |
syncSync Neptune DBSubnetGroup state from AWS
Resources
state(infinite)— Neptune DBSubnetGroup resource state
@swamp/aws/neptune/event-subscriptionv2026.04.23.2event_subscription.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| Tags? | array | An array of key-value pairs to apply to this resource. |
| Enabled? | boolean | A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. |
| EventCategories? | array | A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon Neptune User Guide or by using the DescribeEventCategories action. |
| SnsTopicArn | string | The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. |
| SubscriptionName? | string | The name of the subscription. |
| SourceIds? | array | The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. |
| SourceType? | string | The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. |
createCreate a Neptune EventSubscription
getGet a Neptune EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune EventSubscription |
updateUpdate a Neptune EventSubscription
deleteDelete a Neptune EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Neptune EventSubscription |
syncSync Neptune EventSubscription state from AWS
Resources
state(infinite)— Neptune EventSubscription resource state
2026.04.23.21.2 MBApr 23, 2026
AWS NEPTUNE infrastructure models
Release Notes
- Updated: dbcluster, dbcluster_parameter_group, dbinstance, dbparameter_group, dbsubnet_group, event_subscription
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsneptunecloudinfrastructure
2026.04.03.21.2 MBApr 3, 2026
AWS NEPTUNE infrastructure models
Release Notes
- Updated: dbcluster, dbcluster_parameter_group, dbinstance, dbparameter_group, dbsubnet_group, event_subscription
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsneptunecloudinfrastructure
2026.03.19.11.2 MBMar 19, 2026
AWS NEPTUNE infrastructure models
Release Notes
- Updated: dbcluster, dbcluster_parameter_group, dbinstance, dbparameter_group, dbsubnet_group, event_subscription
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsneptunecloudinfrastructure
2026.03.16.11.2 MBMar 16, 2026
AWS NEPTUNE infrastructure models
Release Notes
- Updated: dbcluster, dbcluster_parameter_group, dbinstance, dbparameter_group, dbsubnet_group, event_subscription
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsneptunecloudinfrastructure
2026.03.10.51.2 MBMar 10, 2026
AWS NEPTUNE infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
awsneptunecloudinfrastructure