AWS Fundamentals Logo
AWS Fundamentals
aws neptune

AWS Amazon Neptune CLI Commands

70 CLI commands available for Amazon Neptune.

CommandSample
add-role-to-db-cluster

Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.

add-source-identifier-to-subscription

Adds a source identifier to an existing event notification subscription.

add-tags-to-resource

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

apply-pending-maintenance-action

Applies a pending maintenance action to a resource (for example, to a DB instance).

copy-db-cluster-parameter-group

Copies the specified DB cluster parameter group.

copy-db-cluster-snapshot

Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

copy-db-parameter-group

Copies the specified DB parameter group.

create-db-cluster

Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by de

create-db-cluster-endpoint

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

create-db-cluster-parameter-group

Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for

create-db-cluster-snapshot

Creates a snapshot of a DB cluster.

create-db-instance

Creates a new DB instance.

create-db-parameter-group

Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a

create-db-subnet-group

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

create-event-subscription

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS con

create-global-cluster

Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsy

delete-db-cluster

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. Note that the DB Cluster cannot be deleted if d

delete-db-cluster-endpoint

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

delete-db-cluster-parameter-group

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

delete-db-cluster-snapshot

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted.

delete-db-instance

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB sn

delete-db-parameter-group

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

delete-db-subnet-group

Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.

delete-event-subscription

Deletes an event notification subscription.

delete-global-cluster

Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.

describe-db-cluster-endpoints

Returns information about endpoints for an Amazon Neptune DB cluster. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

describe-db-cluster-parameter-groups

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

describe-db-cluster-parameters

Returns the detailed parameter list for a particular DB cluster parameter group.

describe-db-cluster-snapshot-attributes

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the

describe-db-cluster-snapshots

Returns information about DB cluster snapshots. This API action supports pagination.

describe-db-clusters

Returns information about provisioned DB clusters, and supports pagination. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

describe-db-engine-versions

Returns a list of the available DB engines.

describe-db-instances

Returns information about provisioned instances, and supports pagination. This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

describe-db-parameter-groups

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

describe-db-parameters

Returns the detailed parameter list for a particular DB parameter group.

describe-db-subnet-groups

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.

describe-engine-default-cluster-parameters

Returns the default engine and system parameter information for the cluster database engine.

describe-engine-default-parameters

Returns the default engine and system parameter information for the specified database engine.

describe-event-categories

Displays a list of categories for all event source types, or, if specified, for a specified source type.

describe-event-subscriptions

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.

describe-events

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past

describe-global-clusters

Returns information about Neptune global database clusters. This API supports pagination.

describe-orderable-db-instance-options

Returns a list of orderable DB instance options for the specified engine.

describe-pending-maintenance-actions

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

describe-valid-db-instance-modifications

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

failover-db-cluster

Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. Yo

failover-global-cluster

Initiates the failover process for a Neptune global database. A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current

list-tags-for-resource

Lists all tags on an Amazon Neptune resource.

modify-db-cluster

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

modify-db-cluster-endpoint

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

modify-db-cluster-parameter-group

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes

modify-db-cluster-snapshot-attribute

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are author

modify-db-instance

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance

modify-db-parameter-group

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to stati

modify-db-subnet-group

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

modify-event-subscription

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event catego

modify-global-cluster

Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.

promote-read-replica-db-cluster

Not supported.

reboot-db-instance

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the datab

remove-from-global-cluster

Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.

remove-role-from-db-cluster

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

remove-source-identifier-from-subscription

Removes a source identifier from an existing event notification subscription.

remove-tags-from-resource

Removes metadata tags from an Amazon Neptune resource.

reset-db-cluster-parameter-group

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When

reset-db-parameter-group

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resettin

restore-db-cluster-from-snapshot

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 so

restore-db-cluster-to-point-in-time

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB clu

start-db-cluster

Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

stop-db-cluster

Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups. Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

switchover-global-cluster

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers." Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands70
ServiceNeptune