Amazon Neptune and Application Auto Scaling - Application Auto Scaling
Service-linked roleService principalRegistering Neptune clusters as scalable targets with Application Auto ScalingRelated resources
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).

Amazon Neptune and Application Auto Scaling

You can scale Neptune clusters using target tracking scaling policies and scheduled scaling.

Use the following information to help you integrate Neptune with Application Auto Scaling.

Service-linked role created for Neptune

The following service-linked role is automatically created in your Amazon Web Services account when registering Neptune resources as scalable targets with Application Auto Scaling. This role allows Application Auto Scaling to perform supported operations within your account. For more information, see Service-linked roles for Application Auto Scaling.

  • AWSServiceRoleForApplicationAutoScaling_NeptuneCluster

Service principal used by the service-linked role

The service-linked role in the previous section can be assumed only by the service principal authorized by the trust relationships defined for the role. The service-linked role used by Application Auto Scaling grants access to the following service principal:

  • neptune.application-autoscaling.amazonaws.com

Registering Neptune clusters as scalable targets with Application Auto Scaling

Application Auto Scaling requires a scalable target before you can create scaling policies or scheduled actions for a Neptune cluster. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

To configure auto scaling using the Amazon CLI or one of the Amazon SDKs, you can use the following options:

  • Amazon CLI:

    Call the register-scalable-target command for a Neptune cluster. The following example registers the desired capacity of a cluster called mycluster, with a minimum capacity of one and a maximum capacity of eight.

    aws application-autoscaling register-scalable-target \
  --service-namespace neptune \
  --scalable-dimension neptune:cluster:ReadReplicaCount \
  --resource-id cluster:mycluster \
  --min-capacity 1 \
  --max-capacity 8

    If successful, this command returns the ARN of the scalable target.

    {
    "ScalableTargetARN": "arn:aws-cn:application-autoscaling:region:account-id:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}

  • Amazon SDK:

    Call the RegisterScalableTarget operation and provide ResourceId, ScalableDimension, ServiceNamespace, MinCapacity, and MaxCapacity as parameters.

If you are just getting started with Application Auto Scaling, you can find additional useful information about scaling your Neptune resources in the following documentation:

Auto-scaling the number of replicas in an Amazon Neptune DB cluster in the Neptune User Guide