View a markdown version of this page

Using the Neptune ML Amazon CloudFormation template to get started quickly in a new DB cluster - Amazon Neptune
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Using the Neptune ML Amazon CloudFormation template to get started quickly in a new DB cluster

The easiest way to get started with Neptune ML is to use the Amazon CloudFormation quick-start template. This template installs all necessary components, including a new Neptune DB cluster, all the necessary IAM roles, and a new Neptune graph-notebook to make working with Neptune ML easier.

To create the Neptune ML quick-start stack

  1. To launch the Amazon CloudFormation stack on the Amazon CloudFormation console, choose one of the Launch Stack buttons in the following table:

    Region View Launch
    US East (N. Virginia) View Orange button labeled "Launch Stack" with an arrow icon.
    US East (Ohio) View Orange button labeled "Launch Stack" with an arrow icon.
    US West (N. California) View Orange button labeled "Launch Stack" with an arrow icon.
    US West (Oregon) View Orange button labeled "Launch Stack" with an arrow icon.
    Canada (Central) View Orange button labeled "Launch Stack" with an arrow icon.
    South America (São Paulo) View Orange button labeled "Launch Stack" with an arrow icon.
    Europe (Stockholm) View Orange button labeled "Launch Stack" with an arrow icon.
    Europe (Ireland) View Orange button labeled "Launch Stack" with an arrow icon.
    Europe (London) View Orange button labeled "Launch Stack" with an arrow icon.
    Europe (Paris) View Orange button labeled "Launch Stack" with an arrow icon.
    Europe (Frankfurt) View Orange button labeled "Launch Stack" with an arrow icon.
    Middle East (Bahrain) View Orange button labeled "Launch Stack" with an arrow icon.
    Middle East (UAE) View Orange button labeled "Launch Stack" with an arrow icon.
    Israel (Tel Aviv) View Orange button labeled "Launch Stack" with an arrow icon.
    Africa (Cape Town) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Hong Kong) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Tokyo) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Seoul) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Singapore) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Sydney) View Orange button labeled "Launch Stack" with an arrow icon.
    Asia Pacific (Mumbai) View Orange button labeled "Launch Stack" with an arrow icon.
    China (Beijing) View Orange button labeled "Launch Stack" with an arrow icon.
    China (Ningxia) View Orange button labeled "Launch Stack" with an arrow icon.
    Amazon GovCloud (US-West) View Orange button labeled "Launch Stack" with an arrow icon.

  2. On the Select Template page, choose Next.

  3. On the Specify Details page, choose Next.

  4. On the Options page, choose Next.

  5. On the Review page, there are two check boxes that you need to check:

    • The first one acknowledges that Amazon CloudFormation might create IAM resources with custom names.

    • The second acknowledges that Amazon CloudFormation might require the CAPABILITY_AUTO_EXPAND capability for the new stack. CAPABILITY_AUTO_EXPAND explicitly allows Amazon CloudFormation to expand macros automatically when creating the stack, without prior review.

      Customers often create a change set from a processed template so that the changes made by macros can be reviewed before actually creating the stack. For more information, see the Amazon CloudFormation CreateStack API.

    Then choose Create.

The quick-start template creates and sets up the following:

  • A Neptune DB cluster.

  • The necessary IAM roles (and attaches them).

  • The necessary Amazon EC2 security group.

  • The necessary SageMaker AI VPC endpoints.

  • A DB cluster parameter group for Neptune ML.

  • The necessary parameters in that parameter group.

  • The Neptune-Export service.

You can also use the following Amazon CLI command to run the quick-start Amazon CloudFormation template:

aws cloudformation create-stack \
  --stack-name neptune-ml-fullstack-$(date '+%Y-%m-%d-%H-%M') \
  --template-url https://aws-neptune-customer-samples.s3.amazonaws.com/v2/cloudformation-templates/neptune-ml-nested-stack.json \
  --parameters ParameterKey=EnableIAMAuthOnExportAPI,ParameterValue=(true if you have IAM auth enabled, or false otherwise) \
               ParameterKey=Env,ParameterValue=test$(date '+%H%M')\
  --capabilities CAPABILITY_IAM \
  --region (the Amazon region, like us-east-1) \
  --disable-rollback \
  --profile (optionally, a named CLI profile of yours)