Terraformを使用してApsaraDB RDS for PostgreSQLインスタンスの設定をクエリするにはどうすればよいですか。 - ApsaraDB RDS

このトピックでは、Terraformを使用してApsaraDB RDS for PostgreSQLインスタンスの設定を照会する方法について説明します。

説明

このトピックのサンプルコードは、数回クリックするだけで実行できます。詳細については、「Terraform Explorer」をご参照ください。

前提条件

RDSインスタンスが作成されました。詳細については、「RDSインスタンスの作成」をご参照ください。
RDS インスタンスが実行中の状態である必要があります。次のいずれかの方法を使用して、RDSインスタンスが [実行中] 状態であるかどうかを確認できます。
- クエリインスタンスの詳細に記載されている手順に従って、statusパラメーターの値を確認します。値が [実行中] の場合、RDSインスタンスは [実行中] 状態です。
- ApsaraDB RDSコンソールにログインし、必要なリージョンに切り替えてRDSインスタンスを見つけ、インスタンスのステータスを確認します。
Alibaba Cloudアカウントには、アカウント内のリソースに対するすべての権限があります。 Alibaba Cloudアカウントが漏洩した場合、リソースは大きなリスクにさらされます。 Resource Access Management (RAM) ユーザーを使用し、RAMユーザーのAccessKeyペアを作成することを推奨します。詳細については、「RAMユーザーの作成」および「AccessKeyペアの作成」をご参照ください。

RAMを使用して、クラウドリソースに対するアクセス許可を効率的に管理する必要があります。これにより、マルチユーザーコラボレーションの要件を満たすことができ、最小限の権限 (PoLP) の原則に基づいてユーザーに権限を付与して、過度の権限によるセキュリティの脆弱性を防ぐことができます。詳細については、「RAMユーザーへの権限付与」をご参照ください。

{
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "vpc:DescribeVpcAttribute",
                "vpc:DescribeRouteTableList",
                "vpc:DescribeVSwitchAttributes",
                "vpc:DeleteVpc",
                "vpc:DeleteVSwitch",
                "vpc:CreateVpc",
                "vpc:CreateVSwitch"
            ],
            "Resource": "*"
        },
        {
            "Action": "rds:*",
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": "dbs:*",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Action": "hdm:*",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Action": "dms:LoginDatabase",
            "Resource": "acs:rds:*:*:*",
            "Effect": "Allow"
        },
        {
            "Effect": "Allow",
            "Action": "ram:CreateServiceLinkedRole",
            "Resource": "*",
            "Condition": {
                "StringEquals": {
                    "ram:ServiceName": [
                        "backupencryption.rds.aliyuncs.com"
                    ]
                }
            }
        },
        {
            "Effect": "Allow",
            "Action": "bss:ModifyAgreementRecord",
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "bss:DescribeOrderList",
                "bss:DescribeOrderDetail",
                "bss:PayOrder",
                "bss:CancelOrder"
            ],
            "Resource": "*"
        }
    ]
}

Terraform環境を準備します。 Terraformを使用するには、次のいずれかの方法を使用できます。
- Terraform ExplorerでTerraformを使用する: Alibaba Cloudは、Terraformのオンラインランタイム環境であるTerraform Explorerを提供します。 Terraform Explorerにログインした後、Terraformをインストールする必要なくTerraformを使用できます。詳細については、「Terraform ExplorerでのTerraformの使用」をご参照ください。この方法は、Terraformを高速かつ便利な方法で追加費用なしで使用およびデバッグするシナリオに適しています。
- Cloud ShellでTerraformを使用する: TerraformはCloud Shellにプリインストールされ、ID認証情報が設定されています。 Cloud ShellでTerraformコマンドを直接実行できます。詳細については、「Cloud ShellでのTerraformの使用」をご参照ください。この方法は、Terraformを高速で便利な方法で低コストで使用およびデバッグするシナリオに適しています。
- オンプレミスのマシンにTerraformをインストールして構成する: この方法は、ネットワークの状態が悪い、またはカスタム開発環境が使用されているシナリオに適しています。詳細については、「ローカルPCでのTerraformのインストールと設定」をご参照ください。

Resources

説明

特定のリソースに対して課金されます。リソースが不要になった場合は、できるだけ早い機会にリソースを解放または購読解除する必要があります。

alicloud_vpc: 仮想プライベートクラウド (VPC) を作成します。
alicloud_vswitch: VPC用のvSwitchを作成します。
alicloud_db_instance: RDSインスタンスを作成します。
alicloud_db_zones: 使用可能なゾーンを照会します。
alicloud_db_instance_classes: 使用可能なインスタンスタイプを照会します。
alicloud_regions: 使用可能なリージョンを照会します。
alicloud_db_instances: RDSインスタンスを照会します。

利用可能なゾーンの照会

このセクションでは、RDSインスタンスの使用可能ゾーンをクエリする方法について説明します。

作業ディレクトリとmain.tfという名前の設定ファイルをディレクトリに作成します。次のコードをmain.tf設定ファイルにコピーします。

必要なリソースを作成します。

variable "region" {
  default = "cn-heyuan"
}

provider "alicloud" {
  region = var.region
}

variable "zone_id" {
  default = "cn-heyuan-b"
}

variable "instance_type" {
  default = "pg.n2.2c.2m"
}

# Create a VPC.
resource "alicloud_vpc" "main" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# Create a vSwitch.
resource "alicloud_vswitch" "main" {
  vpc_id     = alicloud_vpc.main.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# Create an RDS instance.
resource "alicloud_db_instance" "instance" {
  engine               = "PostgreSQL"
  engine_version       = "13.0"
  instance_type        = var.instance_type
  instance_storage     = "30"
  instance_charge_type = "Postpaid"
  vswitch_id           = alicloud_vswitch.main.id
}

data "alicloud_db_zones" "queryzones" {} 設定項目をmain.tfファイルに追加します。

...
data "alicloud_db_zones" "queryzones" {
  instance_charge_type     = "PostPaid"
  engine                   = "PostgreSQL"
  db_instance_storage_type = "cloud_essd"
}

次のコマンドを実行してTerraformを初期化します。

terraform init

次の情報が返された場合、Terraformは初期化されます。

Initializing the backend...

Initializing provider plugins...
- Checking for available provider plugins...
- Downloading plugin for provider "alicloud" (hashicorp/alicloud) 1.90.1...
...

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

実行計画を作成し、変更をプレビューします。
```
terraform plan
```

次のコマンドを実行してリソースを作成します。

terraform apply

実行中に、プロンプトに従ってyesと入力し、enterキーを押します。コマンドが正常に実行されるまで待ちます。次の情報が表示された場合、操作は成功です。

data.alicloud_db_zones.queryzones: Reading...
data.alicloud_db_zones.queryzones: Read complete after 1s [id=262******]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are needed.

Apply complete!  Resources: 0 added, 0 changed, 0 destroyed.

結果を確認します。

次のコマンドを実行して結果を表示できます。

terraform show

# data.alicloud_db_zones.queryzones:
data "alicloud_db_zones" "queryzones" {
    db_instance_storage_type = "cloud_essd"
    engine                   = "PostgreSQL"
    id                       = "262******"
    ids                      = [
        "cn-heyuan-b",
    ]
    instance_charge_type     = "PostPaid"
    multi                    = false
    multi_zone               = false
    zones                    = [
        {
            id             = "cn-hangzhou-b"
            multi_zone_ids = []
        },
    ]
}

利用可能なインスタンスタイプの照会

main.tfファイルに、次の内容を追加します。

...
data "alicloud_db_instance_classes" "queryclasses" {
  instance_charge_type= "PostPaid"
  engine = "PostgreSQL"
  db_instance_storage_type = "cloud_essd"
}

以下のコマンドを実行します。

terraform apply

data.alicloud_db_instance_classes.queryclasses: Reading...
alicloud_vpc.main: Refreshing state... [id=vpc-****]
alicloud_vswitch.main: Refreshing state... [id=vsw-****]
alicloud_db_instance.instance: Refreshing state... [id=pgm-****]
data.alicloud_db_instance_classes.queryclasses: Still reading... [10s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [20s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [30s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [40s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [50s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [1m0s elapsed]
...
data.alicloud_db_instance_classes.queryclasses: Still reading... [6m50s elapsed]
data.alicloud_db_instance_classes.queryclasses: Still reading... [7m0s elapsed]
data.alicloud_db_instance_classes.queryclasses: Read complete after 7m9s [id=130302****]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are
needed.

Apply complete!  Resources: 0 added, 0 changed, 0 destroyed.

結果を確認します。

次のコマンドを実行して結果を表示できます。

terraform show

{
            instance_class = "pg.n8.8xlarge.1"
            price          = ""
            storage_range  = {
                "max"  = "32000"
                "min"  = "1500"
                "step" = "5"
            }
            zone_ids       = [
                {
                    id           = "cn-hangzhou-k"
                    sub_zone_ids = []
                },
            ]
},
{
            instance_class = "pg.n2.small.1"
            price          = ""
            storage_range  = {
                "max"  = "32000"
                "min"  = "1500"
                "step" = "5"
            }
            zone_ids       = [
                {
                    id           = "cn-hangzhou-k"
                    sub_zone_ids = []
                },
            ]
},
......

リージョンの照会

main.tfファイルに、次の内容を追加します。
```
data "alicloud_regions" "query_regions" {
}
```

以下のコマンドを実行します。

terraform apply

data.alicloud_regions.query_regions: Reading...
alicloud_vpc.main: Refreshing state... [id=vpc-****]
alicloud_vswitch.main: Refreshing state... [id=vsw-****]
data.alicloud_regions.query_regions: Read complete after 1s [id=2105****]
alicloud_db_instance.instance: Refreshing state... [id=pgm-****]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are
needed.

Apply complete!  Resources: 0 added, 0 changed, 0 destroyed.

結果を確認します。

次のコマンドを実行して結果を表示できます。

terraform show

# data.alicloud_regions.query_regions:
data "alicloud_regions" "query_regions" {
    id      = "210547****"
    ids     = [
        "cn-qingdao",
        "cn-beijing",
        "cn-zhangjiakou",
        "cn-huhehaote",
        "cn-wulanchabu",
        "cn-hangzhou",
        "cn-shanghai",
        "cn-nanjing",
        "cn-shenzhen",
        "cn-heyuan",
        "cn-guangzhou",
        "cn-fuzhou",
        "cn-chengdu",
        "cn-hongkong",
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-southeast-1",
        "ap-southeast-2",
        "ap-southeast-3",
        "ap-southeast-6",
        "ap-southeast-5",
        "ap-southeast-7",
        "us-east-1",
        "us-west-1",
        "eu-west-1",
        "me-east-1",
        "me-central-1",
        "eu-central-1",
    ]
    regions = [
        {
            id         = "cn-qingdao"
            local_name = "China (Qingdao)"
            region_id  = "cn-qingdao"
        },
        {
            id         = "cn-beijing"
            local_name = "China (Beijing)"
            region_id  = "cn-beijing"
        },
        {
            id         = "cn-zhangjiakou"
            local_name = "China (Zhangjiakou)"
            region_id  = "cn-zhangjiakou"
        },
        {
            id         = "cn-huhehaote"
            local_name = "China (Hohhot)"
            region_id  = "cn-huhehaote"
        },
        {
            id         = "cn-wulanchabu"
            local_name = "China (Ulanqab)"
            region_id  = "cn-wulanchabu"
        },
        {
            id         = "cn-hangzhou"
            local_name = "China (Hangzhou)"
            region_id  = "cn-hangzhou"
        },
        {
            id         = "cn-shanghai"
            local_name = "China (Shanghai)"
            region_id  = "cn-shanghai"
        },
        {
            id         = "cn-shenzhen"
            local_name = "China (Shenzhen)"
            region_id  = "cn-shenzhen"
        },
        {
            id         = "cn-heyuan"
            local_name = "China (Heyuan)"
            region_id  = "cn-heyuan"
        },
        {
            id         = "cn-guangzhou"
            local_name = "China (Guangzhou)"
            region_id  = "cn-guangzhou"
        },
        {
            id         = "cn-chengdu"
            local_name = "China (Chengdu)"
            region_id  = "cn-chengdu"
        },
        {
            id         = "cn-hongkong"
            local_name = "China (Hong Kong)"
            region_id  = "cn-hongkong"
        },
        {
            id         = "ap-northeast-1"
            "localName": "Japan (Tokyo)"
            region_id  = "ap-northeast-1"
        },
        {
            id         = "ap-northeast-2"
            local_name = "South Korea (Seoul)"
            region_id  = "ap-northeast-2"
        },
        {
            id         = "ap-southeast-1"
            local_name = "Singapore"
            region_id  = "ap-southeast-1"
        },
        {
            id         = "ap-southeast-2"
            local_name = "Australia (Sydney)"
            region_id  = "ap-southeast-2"
        },
        {
            id         = "ap-southeast-3"
            local_name = "Malaysia (Kuala Lumpur)"
            region_id  = "ap-southeast-3"
        },
        {
            id         = "ap-southeast-6"
            local_name = "Philippines (Manila)"
            region_id  = "ap-southeast-6"
        },
        {
            id         = "ap-southeast-5"
            local_name = "Indonesia (Jakarta)"
            region_id  = "ap-southeast-5"
        },
        {
            id         = "ap-southeast-7"
            local_name = "Thailand (Bangkok)"
            region_id  = "ap-southeast-7"
        },
        {
            id         = "us-east-1"
            local_name = "US (Virginia)"
            region_id  = "us-east-1"
        },
        {
            id         = "us-west-1"
            local_name = "US (Silicon Valley)"
            region_id  = "us-west-1"
        },
        {
            id         = "eu-west-1"
            local_name = "UK (London)"
            region_id  = "eu-west-1"
        },
        {
            id         = "me-east-1"
            local_name = "UAE (Dubai)"
            region_id  = "me-east-1"
        },
        {
            id         = "eu-central-1"
            local_name = "Germany (Frankfurt)"
            region_id  = "eu-central-1"
        },
    ]
}

RDSインスタンスの照会

main.tfファイルに、次の内容を追加します。
```
data "alicloud_db_instances" "queryinstances" {
}
```

以下のコマンドを実行します。

terraform apply

data.alicloud_db_instances.queryinstances: Reading...
alicloud_vpc.main: Refreshing state... [id=vpc-****]
alicloud_vswitch.main: Refreshing state... [id=vsw-****]
data.alicloud_db_instances.queryinstances: Read complete after 1s [id=277****]
alicloud_db_instance.instance: Refreshing state... [id=pgm-****]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are
needed.

Apply complete!  Resources: 0 added, 0 changed, 0 destroyed.

結果を確認します。

次のコマンドを実行して結果を表示できます。

terraform show

# data.alicloud_db_instances.queryinstances:
data "alicloud_db_instances" "queryinstances" {
    enable_details = false
    id             = "27790****"
    ids            = [
        "pgm-bp1zirc6i2****",
    ]
    instances      = [
        {
            acl                         = ""
            availability_zone           = "cn-hangzhou-j"
            ca_type                     = ""
            charge_type                 = "Postpaid"
            client_ca_cert              = ""
            client_ca_cert_expire_time  = ""
            client_cert_revocation_list = ""
            connection_mode             = "Standard"
            connection_string           = "pgm-****.pg.rds.aliyuncs.com"
            create_time                 = "2022-09-28T06:15:32Z"
            creator                     = ""
            db_instance_storage_type    = "cloud_essd"
            db_type                     = "Primary"
            delete_date                 = ""
            deletion_protection         = false
            description                 = ""
            encryption_key              = ""
            encryption_key_status       = ""
            engine                      = "PostgreSQL"
            engine_version              = "13.0"
            expire_time                 = ""
            guard_instance_id           = "<nil>"
            id                          = "pgm-****"
            instance_storage            = 50
            instance_type               = "pg.n2.2c.2m"
            key_usage                   = ""
            last_modify_status          = ""
            master_instance_id          = "<nil>"
            master_zone                 = ""
            material_expire_time        = ""
            modify_status_reason        = ""
            name                        = "terraformtest"
            net_type                    = "Intranet"
            origin                      = ""
            parameters                  = []
            port                        = "5432"
            readonly_instance_ids       = []
            region_id                   = "cn-hangzhou"
            replication_acl             = ""
            require_update              = ""
            require_update_item         = ""
            require_update_reason       = ""
            server_ca_url               = ""
            server_cert                 = ""
            server_key                  = ""
            ssl_create_time             = ""
            ssl_enabled                 = "off"
            ssl_expire_time             = ""
            status                      = "Running"
            temp_instance_id            = "<nil>"
            vpc_id                      = "vpc-****"
            vswitch_id                  = "vsw-****"
            zone_id_slave_a             = ""
            zone_id_slave_b             = ""
        },
    ]
    names          = [
        "terraformtest",
    ]
    page_size      = 100
    total_count    = 1
}

インスタンスの詳細の照会

main.tfファイルに、次の内容を追加します。
- 特定のRDSインスタンスを照会します。
  説明
  RDSインスタンスが作成されました。詳細については、「RDSインスタンスの作成」をご参照ください。
  RDS インスタンスが実行中の状態である必要があります。次のいずれかの方法を使用して、RDSインスタンスが [実行中] 状態であるかどうかを確認できます。
  - クエリインスタンスの詳細に記載されている手順に従って、statusパラメーターの値を確認します。値が [実行中] の場合、RDSインスタンスは [実行中] 状態です。
  - ApsaraDB RDSコンソールにログインし、必要なリージョンに切り替えてRDSインスタンスを見つけ、インスタンスのステータスを確認します。
```
data "alicloud_db_instances" "queryinstance" {
  ids    = ["pgm-f8z04t******"]
  engine = "PostgreSQL"
}
```
- 環境変数で指定されたリージョン内のすべてのインスタンスを照会します。
```
data "alicloud_db_instances" "queryinstance" {
  ids    = []
  engine = "PostgreSQL"
}
```

以下のコマンドを実行します。

terraform apply

data.alicloud_db_instances.queryinstance: Reading...
data.alicloud_db_instances.queryinstance: Read complete after 5s [id=69816****]

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration and found no differences, so no changes are needed.

Apply complete!  Resources: 0 added, 0 changed, 0 destroyed.

結果を確認します。

次のコマンドを実行して結果を表示できます。

terraform show

# data.alicloud_db_instances.queryinstance:
data "alicloud_db_instances" "queryinstance" {
    enable_details = false
    engine         = "PostgreSQL"
    id             = "277908****"
    ids            = [
        "pgm-****",
    ]
    instances      = [
        {
            acl                         = ""
            availability_zone           = "cn-hangzhou-j"
            ca_type                     = ""
            charge_type                 = "Postpaid"
            client_ca_cert              = ""
            client_ca_cert_expire_time  = ""
            client_cert_revocation_list = ""
            connection_mode             = "Standard"
            connection_string           = "pgm-****.pg.rds.aliyuncs.com"
            create_time                 = "2022-09-28T06:15:32Z"
            creator                     = ""
            db_instance_storage_type    = "cloud_essd"
            db_type                     = "Primary"
            delete_date                 = ""
            deletion_protection         = false
            description                 = ""
            encryption_key              = ""
            encryption_key_status       = ""
            engine                      = "PostgreSQL"
            engine_version              = "13.0"
            expire_time                 = ""
            guard_instance_id           = "<nil>"
            id                          = "pgm-****"
            instance_storage            = 50
            instance_type               = "pg.n2.2c.2m"
            key_usage                   = ""
            last_modify_status          = ""
            master_instance_id          = "<nil>"
            master_zone                 = ""
            material_expire_time        = ""
            modify_status_reason        = ""
            name                        = "terraformtest"
            net_type                    = "Intranet"
            origin                      = ""
            parameters                  = []
            port                        = "5432"
            readonly_instance_ids       = []
            region_id                   = "cn-hangzhou"
            replication_acl             = ""
            require_update              = ""
            require_update_item         = ""
            require_update_reason       = ""
            server_ca_url               = ""
            server_cert                 = ""
            server_key                  = ""
            ssl_create_time             = ""
            ssl_enabled                 = "off"
            ssl_expire_time             = ""
            status                      = "Running"
            temp_instance_id            = "<nil>"
            vpc_id                      = "vpc-****"
            vswitch_id                  = "vsw-****"
            zone_id_slave_a             = ""
            zone_id_slave_b             = ""
        },
    ]
    names          = [
        "terraformtest",
    ]
    page_size      = 100
    total_count    = 1
}

Terraformを使用して作成または管理された上記のリソースが不要になった場合は、次のコマンドを実行してリソースを解放します。 terraform destroyコマンドの詳細については、「一般的なコマンド」をご参照ください。

terraform destroy

完全なサンプルコード

説明

このトピックのサンプルコードは、数回クリックするだけで実行できます。詳細については、「Terraform Explorer」をご参照ください。

サンプルコード

variable "region" {
  default = "cn-hangzhou"
}

provider "alicloud" {
  region = var.region
}

variable "zone_id" {
  default = "cn-hangzhou-b"
}

variable "instance_type" {
  default = "pg.n2.2c.2m"
}

# Create a VPC.
resource "alicloud_vpc" "main" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# Create a vSwitch.
resource "alicloud_vswitch" "main" {
  vpc_id     = alicloud_vpc.main.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# Create an RDS instance.
resource "alicloud_db_instance" "instance" {
  engine               = "PostgreSQL"
  engine_version       = "13.0"
  instance_type        = var.instance_type
  instance_storage     = "30"
  instance_charge_type = "Postpaid"
  vswitch_id           = alicloud_vswitch.main.id
}

# Query available zones.
data "alicloud_db_zones" "queryzones" {
  instance_charge_type     = "PostPaid"
  engine                   = "PostgreSQL"
  db_instance_storage_type = "cloud_essd"
}

# Query available instance types.
data "alicloud_db_instance_classes" "queryclasses" {
  instance_charge_type     = "PostPaid"
  engine                   = "PostgreSQL"
  db_instance_storage_type = "cloud_essd"
}

# Query regions.
data "alicloud_regions" "query_regions" {
}

# Query RDS instances.
data "alicloud_db_instances" "queryinstances" {
}

# Query specific RDS instances.
data "alicloud_db_instances" "queryinstance" {
  ids = [alicloud_db_instance.instance.id]
  # Query all instances in a region that is specified by the environment variable.
  # ids  = []
  engine = "PostgreSQL"
}

さらに多くの例を体験したい場合は、[クイックスタート] ページに移動し、対応するサービスのフォルダーにある例を表示します。