Working with administrative ARNs in Amazon Neptune - 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.

Working with administrative ARNs in Amazon Neptune

Resources that are created in Amazon Web Services are each uniquely identified with an Amazon Resource Name (ARN). For certain Amazon Neptune operations, you must uniquely identify a Neptune resource by specifying its ARN.

Important

Amazon Neptune shares the format of Amazon RDS ARNs for administrative actions that use the Neptune Management API. Neptune administrative ARNs contain rds and not neptune-db. For data-plane ARNs that identify Neptune data resources, see Specifying data resources.

Constructing an ARN for Neptune

You can construct an ARN for an Amazon Neptune resource using the following syntax. Note that Neptune shares the format of Amazon RDS ARNs.

arn:aws-cn:rds:<region>:<account number>:<resourcetype>:<name>

The following table shows the format that you should use when constructing an ARN for a particular Neptune administrative resource type.

Resource Type ARN Format
DB instance

arn:aws-cn:rds:<region>:<account>:db:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:db:my-instance-1

DB cluster

arn:aws-cn:rds:<region>:<account>:cluster:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:cluster:my-cluster-1
Event subscription

arn:aws-cn:rds:<region>:<account>:es:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:es:my-subscription
DB parameter group

arn:aws-cn:rds:<region>:<account>:pg:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:pg:my-param-enable-logs
DB cluster parameter group

arn:aws-cn:rds:<region>:<account>:cluster-pg:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
DB cluster snapshot

arn:aws-cn:rds:<region>:<account>:cluster-snapshot:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:cluster-snapshot:my-snap-20160809
DB subnet group

arn:aws-cn:rds:<region>:<account>:subgrp:<name>

For example:

arn:aws-cn:rds:us-east-2:123456789012:subgrp:my-subnet-10

Getting an Existing ARN in Amazon Neptune

You can get the ARN of a Neptune resource by using the Amazon Web Services Management Console, Amazon Command Line Interface (Amazon CLI), or Neptune API.

Getting an Existing ARN Using the Amazon Web Services Management Console

To get an ARN using the console, navigate to the resource that you want an ARN for, and view the details for that resource. For example, to get the ARN for a DB instance, choose Instances in the navigation panel, and choose the instance that you want from the list. The ARN is in the Instance Details section.

Getting an Existing ARN Using the Amazon CLI

To use the Amazon CLI to get an ARN for a particular Neptune resource, use the describe command for that resource. The following table shows each Amazon CLI command and the ARN property that is used with the command to get an ARN.

Amazon CLI Command ARN Property
describe-event-subscriptions EventSubscriptionArn
describe-certificates CertificateArn
describe-db-parameter-groups DBParameterGroupArn
describe-db-cluster-parameter-groups DBClusterParameterGroupArn
describe-db-instances DBInstanceArn
describe-events SourceArn
describe-db-subnet-groups DBSubnetGroupArn
describe-db-clusters DBClusterArn
describe-db-cluster-snapshots DBClusterSnapshotArn

For example, the following Amazon CLI command gets the ARN for a DB instance.

Example

For Linux, OS X, or Unix:

aws neptune describe-db-instances \ --db-instance-identifier DBInstanceIdentifier \ --region us-west-2

For Windows:

aws neptune describe-db-instances ^ --db-instance-identifier DBInstanceIdentifier ^ --region us-west-2

Getting an Existing ARN Using the API

To get an ARN for a particular Neptune resource, call the following API actions and use the ARN properties shown.

Neptune API Action ARN Property
DescribeEventSubscriptions EventSubscriptionArn
DescribeCertificates CertificateArn
DescribeDBParameterGroups DBParameterGroupArn
DescribeDBClusterParameterGroups DBClusterParameterGroupArn
DescribeDBInstances DBInstanceArn
DescribeEvents SourceArn
DescribeDBSubnetGroups DBSubnetGroupArn
DescribeDBClusters DBClusterArn
DescribeDBClusterSnapshots DBClusterSnapshotArn