AWS CLI を使用した Aurora DSQL - Amazon Aurora DSQL
CreateClusterGetClusterUpdateClusterDeleteClusterListClustersマルチリージョンクラスターの GetCluster

AWS CLI を使用した Aurora DSQL

AWS CLI を使用してクラスターを管理する方法については、以下のセクションを参照してください。

CreateCluster

クラスターを作成するには、create-cluster コマンドを使用します。

注記

クラスターの作成は非同期的に行われます。ステータスが ACTIVE になるまで GetCluster API を呼び出します。クラスターは、ACTIVE になったら接続できます。

サンプルコマンド

aws dsql create-cluster --region us-east-1
注記

作成時に削除保護を無効にする場合は、--no-deletion-protection-enabled フラグを含めます。

レスポンス例

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "CREATING",
    "creationTime": "2025-05-22T14:03:26.631000-07:00",
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    },
    "deletionProtectionEnabled": true
}

GetCluster

クラスターを記述するには、get-cluster コマンドを使用します。

サンプルコマンド

aws dsql get-cluster \
  --region us-east-1 \
  --identifier <your_cluster_id>

レスポンス例

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "ACTIVE",
    "creationTime": "2025-05-22T14:03:26.631000-07:00",
    "deletionProtectionEnabled": true,
    "tags": {},
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    }
}

UpdateCluster

既存のクラスターを更新するには、update-cluster コマンドを使用します。

注記

更新は非同期的に行われます。ステータスが ACTIVE になるまで GetCluster API を呼び出し、変更が表示されます。

サンプルコマンド

aws dsql update-cluster \
  --region us-east-1 \
  --no-deletion-protection-enabled \
  --identifier your_cluster_id

レスポンス例

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "UPDATING",
    "creationTime": "2024-05-24T09:15:32.708000-07:00"
}

DeleteCluster

既存のクラスターを削除するには、delete-cluster コマンドを使用します。

注記

削除保護が無効になっているクラスターのみを削除できます。新しいクラスターを作成する場合は、デフォルトで削除保護が有効になっています。

サンプルコマンド

aws dsql delete-cluster \
  --region us-east-1 \
  --identifier your_cluster_id

レスポンス例

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "DELETING",
    "creationTime": "2024-05-24T09:16:43.778000-07:00"
}

ListClusters

クラスターの a を取得するには、list-clusters コマンドを使用します。

サンプルコマンド

aws dsql list-clusters --region us-east-1

レスポンス例

{
    "clusters": [
        {
            "identifier": "abc0def1baz2quux3quux4quuux",
            "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quux4quuux"
        },
        {
            "identifier": "abc0def1baz2quux3quux4quuuux",
            "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quux4quuuux"
        }
    ]
}

マルチリージョンクラスターの GetCluster

マルチリージョンクラスターに関する情報を取得するには、get-cluster コマンドを使用します。マルチリージョンクラスターの場合、レスポンスにはリンクされたクラスター ARN が含まれます。

サンプルコマンド

aws dsql get-cluster \
  --region us-east-1 \
  --identifier your_cluster_id

レスポンス例

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "ACTIVE",
    "creationTime": "2025-05-22T13:56:18.716000-07:00",
    "deletionProtectionEnabled": true,
    "multiRegionProperties": {
        "witnessRegion": "us-west-2",
        "clusters": [
            "arn:aws:dsql:us-east-1:842685632318:cluster/fuabuc7d3szkr37uqd5znkjynu"
        ]
    },
    "tags": {},
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    }
}