2021-11-19
DBサブネットグループの情報を取得する方法について記載しています。
DBサブネット
サブネットは、VPC の IP アドレス範囲のセグメントで、セキュリティや運用上のニーズに基づいてリソースをグループ化するために指定します。DB サブネットグループは VPC に作成するサブネット (通常はプライベート) のコレクションで、DB インスタンス用に指定します。DB サブネットグループには、CLI または API を使用して DB インスタンスを作成するときに特定の VPC を指定することができます。コンソールを使用する場合は、使用する VPC とサブネットを選択できます。
aws rds describe-db-subnet-groups
実行結果 TEXT
DBSUBNETGROUPS arn:aws:rds:ap-northeast-1:987654321000:subgrp:dsub-project-01 Project 01 DB Subnet Group dsub-project-01 Complete vpc-8db025e* SUBNETS subnet-a44c06e* Active SUBNETAVAILABILITYZONE ap-northeast-1a SUBNETS subnet-802fa8d* Active SUBNETAVAILABILITYZONE ap-northeast-1c
TABLE
-------------------------------------------------------------------------------------------------- | DescribeDBSubnetGroups | +------------------------------------------------------------------------------------------------+ || DBSubnetGroups || |+---------------------------+------------------------------------------------------------------+| || DBSubnetGroupArn | arn:aws:rds:ap-northeast-1:987654321000:subgrp:dsub-project-01 || || DBSubnetGroupDescription | Project 01 DB Subnet Group || || DBSubnetGroupName | dsub-project-01 || || SubnetGroupStatus | Complete || || VpcId | vpc-8db025e* || |+---------------------------+------------------------------------------------------------------+| ||| Subnets ||| ||+----------------------------------------------+---------------------------------------------+|| ||| SubnetIdentifier | subnet-a44c06e* ||| ||| SubnetStatus | Active ||| ||+----------------------------------------------+---------------------------------------------+|| |||| SubnetAvailabilityZone |||| |||+-----------------------+------------------------------------------------------------------+||| |||| Name | ap-northeast-1a |||| |||+-----------------------+------------------------------------------------------------------+||| ||| Subnets ||| ||+----------------------------------------------+---------------------------------------------+|| ||| SubnetIdentifier | subnet-802fa8d* ||| ||| SubnetStatus | Active ||| ||+----------------------------------------------+---------------------------------------------+|| |||| SubnetAvailabilityZone |||| |||+-----------------------+------------------------------------------------------------------+||| |||| Name | ap-northeast-1c |||| |||+-----------------------+------------------------------------------------------------------+|||
JSON
{ "DBSubnetGroups": [ { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-a44c06e*", "SubnetAvailabilityZone": { "Name": "ap-northeast-1a" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-802fa8d*", "SubnetAvailabilityZone": { "Name": "ap-northeast-1c" } } ], "VpcId": "vpc-8db025e*", "DBSubnetGroupDescription": "Project 01 DB Subnet Group ", "SubnetGroupStatus": "Complete", "DBSubnetGroupArn": "arn:aws:rds:ap-northeast-1:987654321000:subgrp:dsub-project-01", "DBSubnetGroupName": "dsub-project-01" } ] }
出力結果から以下の項目が取得できます。
項目 | 形式 | 説明 | 対応箇所 |
---|---|---|---|
DBSubnetGroupName | string | DBサブネットグループの名前。 | 名前 |
DBSubnetGroupDescription | string | DBサブネットグループの説明を提供します。 | 説明 |
VpcId | string | DBサブネットグループのVpcIdを提供します。 | VPC ID |
SubnetGroupStatus | string | DBサブネットグループのステータスを提供します。 | – |
Subnets | list | サブネット要素のリストを含みます。 | サブネット |
SubnetIdentifier | string | サブネットの識別子を指定します。 | サブネットID |
SubnetAvailabilityZone | structure | 可用性ゾーン情報が含まれます。 | アベイラビリティゾーン |
Name | string | 可用性ゾーンの名前。 | サブネット名 |
SubnetStatus | string | サブネットのステータスを指定します。 | 状態 |
DBSubnetGroupArn | string | DBサブネットグループのAmazonリソース名(ARN)。 | ARN |