Amazon Neptune
User Guide (API Version 2017-11-29)

Launching a Neptune DB Cluster

The following procedures describe how to use the AWS Management Console to launch an Amazon Neptune DB cluster and create a Neptune Replica.

Launch a Neptune DB Cluster Using the Console

Before you can access the Neptune console and create a Neptune cluster, you must have an IAM user with NeptuneFullAccess permissions. For information about adding these permissions, see AWS Managed (Predefined) Policies for Amazon Neptune.

The NeptuneFullAccess IAM policy does not grant permissions for VPC, VPC endpoints, or S3. You must add these additional permissions to your IAM user or role to operate on other services. For example, if you choose to have the Neptune Console create a VPC, the IAM user or role must have VPC permissions.

Note

Neptune requires permission to create a service-linked role the first time you create any Neptune resources. Add the following iam:CreateServiceLinkedRole permissions to the same user or role that you give NeptuneFullAccess.

{ "Action": "iam:CreateServiceLinkedRole", "Effect": "Allow", "Resource": "arn:aws:iam::*:role/aws-service-role/rds.amazonaws.com/AWSServiceRoleForRDS", "Condition": { "StringLike": { "iam:AWSServiceName":"rds.amazonaws.com" } } }

For more information, see Using Service-Linked Roles for Neptune.

To launch a Neptune DB cluster using the console

  1. Sign in to the AWS Management Console, and open the Amazon Neptune console at https://console.aws.amazon.com/neptune/home.

  2. Choose Launch DB Instance to start the Launch DB instance wizard.

  3. On the Specify DB details page, you can customize the settings for your Neptune DB cluster. The following table shows the advanced settings for a DB cluster.

    For this option... Do this

    DB instance class

    Choose a DB instance class that defines the processing and memory requirements for each instance in the DB cluster. Neptune supports the db.r4.large , db.r4.xlarge, db.r4.2xlarge, db.r4.4xlarge, db.r4.8xlarge DB instance classes.

    DB instance identifier

    Type a name for the primary instance in your DB cluster. This identifier is used in the endpoint address for the primary instance of your DB cluster.

    The DB instance identifier has the following constraints:

    • It must contain from 1 to 63 alphanumeric characters or hyphens.

    • Its first character must be a letter.

    • It cannot end with a hyphen or contain two consecutive hyphens.

    • It must be unique for all DB instances per AWS account, per AWS Region.

  4. On the Configure advanced settings page, you can customize additional settings for your Neptune DB cluster. The following table shows the advanced settings for a DB cluster.

    For this option... Do this

    Virtual Private Cloud (VPC)

    Choose the VPC that will host the DB cluster. Choose Create a new VPC to have Neptune create a VPC for you. You need to create an Amazon EC2 instance in this same VPC to access the Neptune instance. For more information, see Neptune VPC Requirements.

    Subnet group

    Choose the Neptune DB subnet group to use for the DB cluster. If your VPC does not have any subnet groups, Neptune creates a DB subnet group for you. For more information, see Neptune VPC Requirements.

    Availability Zone

    Specify a particular Availability Zone, or choose No preference to have Neptune choose one for you.

    VPC security groups

    Choose one or more VPC security groups to secure network access to the DB cluster. Choose Create a new VPC security group to have Neptune create a VPC security group for you. For more information, see Creating a Security Group to Provide Access to the Neptune DB Instance in the VPC .

    DB Cluster Identifier

    The identifier for your DB cluster. If you don't specify this value, Neptune creates one based on the DB instance identifier.

    Database port

    The port for all HTTP and WebSockets connections. Neptune DB clusters use 8182 as the default.

    IAM DB Authentication Choose Enable IAM DB authentication to manage access and authentication using AWS Identity and Access Management.

    Important

    This requires that you sign all requests with AWS Signature version 4 signing. For more information, see IAM Database Authentication for Neptune

    Enable encryption

    Choose Yes to enable encryption at rest for this DB cluster. For more information, see Encrypting Neptune Resources.

    Failover priority

    Choose the priority tier. If there is contention within a tier, the replica that is the same size as the primary instance is selected.

    Backup retention period

    Choose the length of time, from 1 to 35 days, that Neptune will retain backup copies of the database. Backup copies can be used for point-in-time restores (PITR) of your database down to the second.

    Auto minor version upgrade

    Choose Yes if you want to enable your Neptune DB cluster to receive minor Neptune DB Engine version upgrades automatically when they become available.

    The Auto minor version upgrade option applies only to upgrades to Neptune minor engine versions for your Amazon Neptune DB cluster. It doesn't apply to regular patches that are applied to maintain system stability.

    Maintenance window

    Choose the weekly time range during which system maintenance can occur.

  5. Choose Launch DB instance to launch your Neptune DB instance, and then choose Close to close the wizard.

    On the Amazon Neptune console, the new DB cluster appears in the list of DB clusters. The DB cluster has a status of creating until it is created and ready for use. When the state changes to available, you can connect to the primary instance for your DB cluster. Depending on the DB instance class and store allocated, it can take several minutes for the new instances to be available.

    To view the newly created cluster, choose the Clusters view in the Neptune console.

    Note

    If you delete all Neptune DB instances in a DB cluster using the AWS Management Console, the DB cluster will be deleted automatically. If you are using the AWS CLI or SDK, you must delete the DB cluster manually after you delete the last instance.

    Note the Cluster endpoint value. You will need this to connect to your Neptune DB cluster.