Amazon Relational Database Service
ユーザーガイド (API バージョン 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>

サービス対象 名前 エンドポイント
米国西部 (オレゴン) リージョン us-west-2 https://rds.us-west-2.amazonaws.com
米国西部 (北カリフォルニア) リージョン us-west-1 https://rds.us-west-1.amazonaws.com
米国東部 (オハイオ) リージョン us-east-2 https://rds.us-east-2.amazonaws.com
米国東部 (バージニア北部) リージョン us-east-1 https://rds.us-east-1.amazonaws.com
アジアパシフィック (ムンバイ) リージョン ap-south-1 https://rds.ap-south-1.amazonaws.com
アジアパシフィック (ソウル) リージョン ap-northeast-2 https://rds.ap-northeast-2.amazonaws.com
アジアパシフィック (シンガポール) リージョン ap-southeast-1 https://rds.ap-southeast-1.amazonaws.com
アジアパシフィック (シドニー) リージョン ap-southeast-2 https://rds.ap-southeast-2.amazonaws.com
アジアパシフィック (東京) リージョン ap-northeast-1 https://rds.ap-northeast-1.amazonaws.com
カナダ (中部) リージョン ca-central-1 https://rds.ca-central-1.amazonaws.com
中国 (北京) リージョン cn-north-1 https://rds.cn-north-1.amazonaws.com.cn
欧州 (フランクフルト) リージョン eu-central-1 https://rds.eu-central-1.amazonaws.com
欧州 (アイルランド) リージョン eu-west-1 https://rds.eu-west-1.amazonaws.com
欧州 (ロンドン) リージョン eu-west-2 https://rds.eu-west-2.amazonaws.com
EU (パリ) リージョン eu-west-3 https://rds.eu-west-3.amazonaws.com
南米 (サンパウロ) リージョン sa-east-1 https://rds.sa-east-1.amazonaws.com
AWS GovCloud (米国) us-gov-west-1 https://rds.us-gov-west-1.amazonaws.com

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

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

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

例:

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

DB クラスター

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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

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

例:

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 インスタンスの詳細から、DB インスタンスの ARN を取得できます。


    				DB インスタンス ARN

AWS CLI

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

AWS 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 の場合:

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

Windows の場合:

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

API

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

RDS API アクション 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

このページの内容: