メニュー
Amazon Relational Database Service
ユーザーガイド (API Version 2014-10-31)

Amazon RDS の Amazon リソースネーム (ARN) の使用

Amazon Web Services で作成されたリソースは、Amazon リソースネーム (ARN) によってそれぞれ一意に識別されます。特定の Amazon RDS オペレーションでは、ARN を指定して、Amazon RDS リソースを一意に識別する必要があります。例えば、RDS DB インスタンスのリードレプリカを作成する場合、ソース DB インスタンスの ARN を指定する必要があります。

Amazon RDS 用 ARN の構築

Amazon Web Services で作成されたリソースは、Amazon リソースネーム (ARN) によってそれぞれ一意に識別されます。次の構文を使用して Amazon RDS リソースの ARN を構築できます。

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

この構文で示される項目には次のような意味があります。

  • <リージョン> は、Amazon RDS リソースが作成された AWS リージョンの名前です。リージョン名のリストについては、「リージョンとアベイラビリティーゾーン」を参照してください。

  • <account number> はダッシュ記号が省略されたアカウント番号です。アカウント番号を見つけるには、https://aws.amazon.com でご利用の AWS アカウントにサインインして、My Account/Console を選択してから、My Account を選びます。

  • <resourcetype> は、DB インスタンスまたはクラスターなどの、Amazon RDS リソースのタイプです。

  • <name> は Amazon RDS リソースのリソース識別子です。

次の表に、特定の Amazon RDS リソースタイプの ARN の構築時に使用する形式を示します。

リソースタイプ ARN 形式
DB インスタンス

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

(例:

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

DB クラスター

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:cluster:my-aurora-cluster-1
イベントサブスクリプション

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:es:my-subscription
DB オプショングループ

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:og:my-og-oracle-tde
DB パラメータグループ

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:pg:my-param-enable-logs
DB クラスターのパラメータグループ

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:cluster-pg:my-cluster-param-timezone
リザーブド DB インスタンス

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:ri:my-reserved-postgresql
DB セキュリティグループ

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:secgrp:my-public
DB スナップショット

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:snapshot:my-mysql-snap-20130507
DB クラスタースナップショット

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

(例:

Copy
arn:aws:rds:us-east-2:123456789012:cluster-snapshot:my-aurora-snap-20160809
DB サブネットグループ

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

(例:

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

既存の ARN の取得

AWS マネジメントコンソール、AWS Command Line Interface (AWS CLI)、または RDS API を使用して、RDS リソースの ARN を取得できます。

AWS マネジメントコンソール

AWS マネジメントコンソール から ARN を取得するには、ARN を取得したいリソースに移動し、リソースの [詳細を表示] を選択します。たとえば、以下に示す [構成の詳細] ページから、DB インスタンスの ARN を取得できます。

 DB インスタンス ARN

AWS CLI

特定の RDS リソースの AWS CLI から ARN を取得するには、そのリソースに対して describe コマンドを使用します。次の表に、各 RDS CLI コマンド、および ARN を取得するコマンドで使用された ARN のプロパティを示します。

RDS CLI コマンド 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-security-groups DBSecurityGroupArn
describe-db-snapshots DBSnapshotArn
イベントの説明 SourceArn
describe-reserved-db-instances ReservedDBInstanceArn
describe-db-subnet-groups DBSubnetGroupArn
describe-option-groups OptionGroupArn
describe-db-clusters DBClusterArn
describe-db-cluster-snapshots DBClusterSnapshotArn

たとえば、次の AWS CLI コマンドで DB インスタンスの ARN を取得します。

Linux、OS X、Unix の場合:

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

Windows の場合:

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

API

特定の RDS リソースの ARN を取得するには、次の RDS API のアクションを呼び出し、次に示す ARN のプロパティを使用できます。

RDS CLI コマンド ARN プロパティ
DescribeEventSubscriptions EventSubscriptionArn
DescribeCertificates CertificateArn
DescribeDBParameterGroups DBParameterGroupArn
DescribeDBClusterParameterGroups DBClusterParameterGroupArn
DescribeDBInstances DBInstanceArn
DescribeDBSecurityGroups DBSecurityGroupArn
DescribeDBSnapshots DBSnapshotArn
DescribeEvents SourceArn
DescribeReservedDBInstances ReservedDBInstanceArn
DescribeDBSubnetGroups DBSubnetGroupArn
DescribeOptionGroups OptionGroupArn
DescribeDBClusters DBClusterArn
DescribeDBClusterSnapshots DBClusterSnapshotArn

関連トピック