Amazon Neptune
Guide de l'utilisateur (Version de l'API 2017-11-29)

Utilisation des ARN dans Neptune

Les ressources créées dans Amazon Web Services sont identifiées de façon unique par un Amazon Resource Name (ARN). Vous devez identifier de façon unique une ressource Neptune en spécifiant son ARN pour certaines opérations Amazon Neptune.

Important

Amazon Neptune partage le format des ARN Amazon RDS. Les ARN Neptune contiennent rds et non neptune.

Création d'un ARN pour Neptune

Vous pouvez créer un ARN pour une ressource Amazon Neptune en utilisant la syntaxe suivante. Neptune partage le format des ARN Amazon RDS.

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

Le tableau suivant indique le format à utiliser lors de la création d'un ARN pour un type de ressource Neptune particulier.

Type de ressource Format ARN
instance de base de données

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

Par exemple :

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

Cluster DB

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

Par exemple :

arn:aws:rds:us-east-2:123456789012:cluster:my-cluster-1
Abonnement aux événements

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

Par exemple :

arn:aws:rds:us-east-2:123456789012:es:my-subscription
Groupe de paramètres DB

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

Par exemple :

arn:aws:rds:us-east-2:123456789012:pg:my-param-enable-logs
Groupe de paramètres de cluster DB

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

Par exemple :

arn:aws:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
Instantané DB

arn:aws:rds:<region>:<account>:snapshot:<name>

Par exemple :

arn:aws:rds:us-east-2:123456789012:snapshot:my-snap-20130507
Instantané de cluster DB

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

Par exemple :

arn:aws:rds:us-east-2:123456789012:cluster-snapshot:my-snap-20160809
Groupe de sous-réseaux DB

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

Par exemple :

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

Obtention d'un ARN existant

Vous pouvez obtenir l'ARN d'une ressource Neptune à l'aide de AWS Management Console, AWS Command Line Interface (AWS CLI) ou de l'API Neptune.

AWS Management Console

Pour obtenir un ARN à l'aide de la console, accédez à la ressource pour laquelle vous souhaitez obtenir un ARN, puis consultez les détails de cette ressource. Par exemple, pour obtenir l'ARN d'une instance de base de données, choisissez Instances dans le volet de navigation, puis choisissez l'instance souhaitée dans la liste. L'ARN se trouve dans la section Instance Details (Détails de l'instance).

AWS CLI

Pour utiliser le AWS CLI afin d'obtenir un ARN pour une ressource Neptune particulière, utilisez la commande describe pour cette ressource. Le tableau suivant présente chaque commande AWS CLI et la propriété d'ARN utilisée avec la commande pour obtenir un ARN.

Commande AWS CLI Propriété d'ARN
describe-event-subscriptions EventSubscriptionArn
describe-certificates CertificateArn
describe-db-parameter-groups DBParameterGroupArn
describe-db-cluster-parameter-groups DBClusterParameterGroupArn
describe-db-instances DBInstanceArn
describe-db-snapshots DBSnapshotArn
describe-events SourceArn
describe-db-subnet-groups DBSubnetGroupArn
describe-db-clusters DBClusterArn
describe-db-cluster-snapshots DBClusterSnapshotArn

Par exemple, la commande AWS CLI suivante permet d'obtenir l'ARN pour une instance de base de données.

Exemple

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

API

Pour obtenir un ARN pour une ressource Neptune particulière, appelez les actions d'API Amazon RDS suivantes et utilisez les propriétés d'ARN indiquées.

Action d'API Neptune Propriété d'ARN
DescribeEventSubscriptions EventSubscriptionArn
DescribeCertificates CertificateArn
DescribeDBParameterGroups DBParameterGroupArn
DescribeDBClusterParameterGroups DBClusterParameterGroupArn
DescribeDBInstances DBInstanceArn
DescribeDBSnapshots DBSnapshotArn
DescribeEvents SourceArn
DescribeDBSubnetGroups DBSubnetGroupArn
DescribeDBClusters DBClusterArn
DescribeDBClusterSnapshots DBClusterSnapshotArn