を使用した Amazon DocumentDB の例 AWS CLI

次のコード例は、Amazon DocumentDB AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。このリンクには、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

アクション

次の例は、add-tags-to-resource を使用する方法を説明しています。

AWS CLI

指定したリソースに 1 つ以上のタグを追加するには

次のadd-tags-to-resource例では、に 3 つのタグを追加しますsample-cluster。1 つのタグ (CropB) にはキー名がありますが、値はありません。


aws docdb add-tags-to-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn"

このコマンドでは何も出力されません。

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB リソースのタグ付け」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスAddTagsToResource」の「」を参照してください。 AWS CLI

次のコード例は、apply-pending-maintenance-action を使用する方法を示しています。

AWS CLI

保留中のメンテナンスアクションを次のメンテナンスウィンドウ中に実行するには

次のapply-pending-maintenance-action例では、次にスケジュールされたメンテナンスウィンドウ中にすべてのシステム更新アクションが実行されます。


aws docdb apply-pending-maintenance-action \
--resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
--apply-action system-update \
--opt-in-type next-maintenance

このコマンドでは何も出力されません。

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB 更新の適用」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスApplyPendingMaintenanceAction」の「」を参照してください。 AWS CLI

次の例は、copy-db-cluster-parameter-group を使用する方法を説明しています。

AWS CLI

既存の DB クラスターパラメータグループを複製するには

次のcopy-db-cluster-parameter-group例では、というcustom-docdb3-6名前のパラメータグループのコピーを作成しますcustom-docdb3-6-copy。コピーを作成すると、新しいパラメータグループにタグが追加されます。


aws docdb copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier custom-docdb3-6 \
    --target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \
    --target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \
    --tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes"

出力:


{
    "DBClusterParameterGroup": {
        "DBParameterGroupFamily": "docdb3.6",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy",
        "DBClusterParameterGroupName": "custom-docdb3-6-copy",
        "Description": "Copy of custom-docdb3-6"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループのコピー」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCopyDbClusterParameterGroup」の「」を参照してください。 AWS CLI

次の例は、copy-db-cluster-snapshot を使用する方法を説明しています。

AWS CLI

スナップショットのコピーを作成するには

次の copy-db-cluster-snapshot の例では、sample-cluster-snapshot-copy という名前の sample-cluster-snapshot のコピーを作成します。コピーには、元ののすべてのタグに加えて、キー名の新しいタグが含まれますCopyNumber。


aws docdb copy-db-cluster-snapshot \
    --source-db-cluster-snapshot-identifier sample-cluster-snapshot \
    --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
    --copy-tags \
    --tags Key="CopyNumber",Value="1"

このコマンドでは何も出力されません。

詳細については、「Amazon DocumentDB デベロッパーガイド」の「クラスタースナップショットのコピー」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCopyDbClusterSnapshot」の「」を参照してください。 AWS CLI

次のコード例は、create-db-cluster-parameter-group を使用する方法を示しています。

AWS CLI

Amazon DocumentDB クラスターパラメータグループを作成するには

次のcreate-db-cluster-parameter-group例では、 docdb3.6ファミリーsample-parameter-groupを使用して DB クラスターパラメータグループを作成します。


aws docdb create-db-cluster-parameter-group \
    --db-cluster-parameter-group-name sample-parameter-group \
    --db-parameter-group-family docdb3.6 \
    --description "Sample parameter group based on docdb3.6"

出力:


{
    "DBClusterParameterGroup": {
        "Description": "Sample parameter group based on docdb3.6",
        "DBParameterGroupFamily": "docdb3.6",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group",
        "DBClusterParameterGroupName": "sample-parameter-group"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループの作成」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCreateDbClusterParameterGroup」の「」を参照してください。 AWS CLI

次の例は、create-db-cluster-snapshot を使用する方法を説明しています。

AWS CLI

手動 Amazon DocumentDB クラスタースナップショットを作成するには

次のcreate-db-cluster-snapshot例では、という名前の Amazon DB クラスタースナップショットを作成します sample-cluster-snapshot。


aws docdb create-db-cluster-snapshot \
   --db-cluster-identifier sample-cluster \
   --db-cluster-snapshot-identifier sample-cluster-snapshot

出力:


{
    "DBClusterSnapshot": {
        "MasterUsername": "master-user",
        "SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
            "us-west-2d",
            "us-west-2e",
            "us-west-2f"
        ],
        "SnapshotType": "manual",
        "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
        "EngineVersion": "3.6.0",
        "PercentProgress": 0,
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "Status": "creating",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "Port": 0,
        "StorageEncrypted": false,
        "VpcId": "vpc-91280df6"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「手動クラスタースナップショットの作成」を参照してください。

API 詳細については、「コマンドリファレンスCreateDbClusterSnapshot」の「」を参照してください。 AWS CLI

次の例は、create-db-cluster を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターを作成するには

次のcreate-db-cluster例では、日曜日の 20:30 から 11:00 までの優先メンテナンスウィンドウsample-clusterを使用して、という名前の Amazon DocumentDB クラスターを作成します。


aws docdb create-db-cluster \
    --db-cluster-identifier sample-cluster \
    --engine docdb \
    --master-username master-user \
    --master-user-password password \
    --preferred-maintenance-window Sun:20:30-Sun:21:00

出力:


{
    "DBCluster": {
        "DBClusterParameterGroup": "default.docdb3.6",
        "AssociatedRoles": [],
        "DBSubnetGroup": "default",
        "ClusterCreateTime": "2019-03-18T18:06:34.616Z",
        "Status": "creating",
        "Port": 27017,
        "PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "DBClusterMembers": [],
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "PreferredBackupWindow": "10:12-10:42",
        "AvailabilityZones": [
            "us-west-2d",
            "us-west-2f",
            "us-west-2e"
        ],
        "MasterUsername": "master-user",
        "BackupRetentionPeriod": 1,
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "StorageEncrypted": false,
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
        "MultiAZ": false,
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "EngineVersion": "3.6.0"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの作成」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCreateDbCluster」の「」を参照してください。 AWS CLI

次の例は、create-db-instance を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターインスタンスを作成するには

次のコードcreate-db-instance例では、Amazon DocumentDB クラスター sample-cluster-instance-2にインスタンスを作成しますsample-cluster。


aws docdb create-db-instance \
    --db-cluster-identifier sample-cluster \
    --db-instance-class db.r4.xlarge \
    --db-instance-identifier sample-cluster-instance-2 \
    --engine docdb

出力:


{
    "DBInstance": {
        "DBInstanceStatus": "creating",
        "PendingModifiedValues": {
            "PendingCloudwatchLogsExports": {
                "LogTypesToEnable": [
                    "audit"
                ]
            }
        },
        "PubliclyAccessible": false,
        "PreferredBackupWindow": "00:00-00:30",
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "StorageEncrypted": false,
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupDescription": "default",
            "SubnetGroupStatus": "Complete",
            "VpcId": "vpc-91280df6",
            "DBSubnetGroupName": "default"
        },
        "DBInstanceClass": "db.r4.xlarge",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「クラスターへの Amazon DocumentDB インスタンスの追加」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCreateDbInstance」の「」を参照してください。 AWS CLI

次のコード例は、create-db-subnet-group を使用する方法を示しています。

AWS CLI

Amazon DocumentDB サブネットグループを作成するには

次のcreate-db-subnet-group例では、という名前の Amazon DocumentDB サブネットグループを作成しますsample-subnet-group。


aws docdb create-db-subnet-group \
    --db-subnet-group-description "a sample subnet group" \
    --db-subnet-group-name sample-subnet-group \
    --subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636"

出力:


{
    "DBSubnetGroup": {
        "SubnetGroupStatus": "Complete",
        "DBSubnetGroupName": "sample-subnet-group",
        "DBSubnetGroupDescription": "a sample subnet group",
        "VpcId": "vpc-91280df6",
        "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group",
        "Subnets": [
            {
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-53ab3636",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2d"
                }
            },
            {
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-991cb8d0",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                }
            },
            {
                "SubnetStatus": "Active",
                "SubnetIdentifier": "subnet-29ab1025",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2c"
                }
            }
        ]
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB サブネットグループの作成」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスCreateDbSubnetGroup」の「」を参照してください。 AWS CLI

次の例は、delete-db-cluster-parameter-group を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターパラメータグループを削除するには

次のdelete-db-cluster-parameter-group例では、Amazon DocumentDB パラメータグループを削除しますsample-parameter-group。


aws docdb delete-db-cluster-parameter-group \
    --db-cluster-parameter-group-name sample-parameter-group

このコマンドでは何も出力されません。

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループの削除」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDeleteDbClusterParameterGroup」の「」を参照してください。 AWS CLI

次の例は、delete-db-cluster-snapshot を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスタースナップショットを削除するには

次のdelete-db-cluster-snapshot例では、Amazon DocumentDB クラスタースナップショットを削除しますsample-cluster-snapshot。


aws docdb delete-db-cluster-snapshot \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

出力:


{
    "DBClusterSnapshot": {
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
            "us-west-2d"
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
        "VpcId": "vpc-91280df6",
        "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
        "EngineVersion": "3.6.0",
        "Engine": "docdb",
        "SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
        "Status": "available",
        "MasterUsername": "master-user",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "PercentProgress": 100,
        "StorageEncrypted": false,
        "SnapshotType": "manual",
        "Port": 0
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「クラスタースナップショットの削除」を参照してください。

API 詳細については、「コマンドリファレンスDeleteDbClusterSnapshot」の「」を参照してください。 AWS CLI

次の例は、delete-db-cluster を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターを削除するには

次のdelete-db-cluster例では、Amazon DocumentDB クラスターを削除しますsample-cluster。削除する前にクラスターのバックアップは行われません。NOTE: クラスターを削除する前に、クラスターに関連付けられているすべてのインスタンスを削除する必要があります。


aws docdb delete-db-cluster \
    --db-cluster-identifier sample-cluster \
    --skip-final-snapshot

出力:


{
    "DBCluster": {
        "DBClusterIdentifier": "sample-cluster",
        "DBSubnetGroup": "default",
        "EngineVersion": "3.6.0",
        "Engine": "docdb",
        "LatestRestorableTime": "2019-03-18T18:07:24.610Z",
        "PreferredMaintenanceWindow": "sun:20:30-sun:21:00",
        "StorageEncrypted": false,
        "EarliestRestorableTime": "2019-03-18T18:07:24.610Z",
        "Port": 27017,
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "MultiAZ": false,
        "MasterUsername": "master-user",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "Status": "available",
        "PreferredBackupWindow": "10:12-10:42",
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
        ],
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q",
        "ClusterCreateTime": "2019-03-18T18:06:34.616Z",
        "AssociatedRoles": [],
        "DBClusterParameterGroup": "default.docdb3.6",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "BackupRetentionPeriod": 1,
        "DBClusterMembers": []
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの削除」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDeleteDbCluster」の「」を参照してください。 AWS CLI

次の例は、delete-db-instance を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB インスタンスを削除するには

次のdelete-db-instance例では、Amazon DocumentDB インスタンスを削除しますsample-cluster-instance-2。


aws docdb delete-db-instance \
    --db-instance-identifier sample-cluster-instance-2

出力:


{
    "DBInstance": {
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-91280df6",
            "SubnetGroupStatus": "Complete"
        },
        "PreferredBackupWindow": "00:00-00:30",
        "InstanceCreateTime": "2019-03-18T18:37:33.709Z",
        "DBInstanceClass": "db.r4.xlarge",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE",
        "BackupRetentionPeriod": 3,
        "Engine": "docdb",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "AutoMinorVersionUpgrade": true,
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "Endpoint": {
            "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "PendingModifiedValues": {},
        "DBInstanceStatus": "deleting",
        "PubliclyAccessible": false,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZone": "us-west-2c",
        "StorageEncrypted": false
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB インスタンスの削除」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDeleteDbInstance」の「」を参照してください。 AWS CLI

次の例は、delete-db-subnet-group を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB サブネットグループを削除するには

次のdelete-db-subnet-group例では、Amazon DocumentDB サブネットグループを削除しますsample-subnet-group。


aws docdb delete-db-subnet-group \
    --db-subnet-group-name sample-subnet-group

このコマンドでは何も出力されません。

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB サブネットグループの削除」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDeleteDbSubnetGroup」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-cluster-parameter-groups を使用する方法を示しています。

AWS CLI

1 つ以上の Amazon DocumentDB クラスターパラメータグループの詳細を表示するには

次のdescribe-db-cluster-parameter-groups例では、Amazon DocumentDB クラスターパラメータグループの詳細を表示しますcustom3-6-param-grp。


aws docdb describe-db-cluster-parameter-groups \
    --db-cluster-parameter-group-name custom3-6-param-grp

出力:


{
    "DBClusterParameterGroups": [
        {
            "DBParameterGroupFamily": "docdb3.6",
            "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp",
            "Description": "Custom docdb3.6 parameter group",
            "DBClusterParameterGroupName": "custom3-6-param-grp"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループの表示」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeDbClusterParameterGroups」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-cluster-parameters を使用する方法を示しています。

AWS CLI

Amazon DocumentDB クラスターパラメータグループの詳細なパラメータリストを表示するには。

次のdescribe-db-cluster-parameters例では、Amazon DocumentDB パラメータグループの custom3-6-param-grp のパラメータを一覧表示します。


aws docdb describe-db-cluster-parameters \
     --db-cluster-parameter-group-name custom3-6-param-grp

出力:


{
    "Parameters": [
        {
            "DataType": "string",
            "ParameterName": "audit_logs",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot",
            "Source": "system",
            "ApplyType": "dynamic",
            "AllowedValues": "enabled,disabled",
            "Description": "Enables auditing on cluster.",
            "ParameterValue": "disabled"
        },
        {
            "DataType": "string",
            "ParameterName": "tls",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot",
            "Source": "system",
            "ApplyType": "static",
            "AllowedValues": "disabled,enabled",
            "Description": "Config to enable/disable TLS",
            "ParameterValue": "enabled"
        },
        {
            "DataType": "string",
            "ParameterName": "ttl_monitor",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot",
            "Source": "user",
            "ApplyType": "dynamic",
            "AllowedValues": "disabled,enabled",
            "Description": "Enables TTL Monitoring",
            "ParameterValue": "enabled"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータの表示」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeDbClusterParameters」の「」を参照してください。 AWS CLI

次の例は、describe-db-cluster-snapshot-attributes を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB スナップショットの属性名と値を一覧表示するには

次のdescribe-db-cluster-snapshot-attributes例では、Amazon DocumentDB スナップショットの属性名と値を一覧表示しますsample-cluster-snapshot。


aws docdb describe-db-cluster-snapshot-attributes \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

出力:


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": []
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「DescribeDBClusterSnapshotAttributes」を参照してください。

API 詳細については、「コマンドリファレンスDescribeDbClusterSnapshotAttributes」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-cluster-snapshots を使用する方法を示しています。

AWS CLI

Amazon DocumentDB スナップショットを記述するには

次のdescribe-db-cluster-snapshots例では、Amazon DocumentDB スナップショットの詳細を表示しますsample-cluster-snapshot。


aws docdb describe-db-cluster-snapshots \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

出力:


{
    "DBClusterSnapshots": [
        {
            "AvailabilityZones": [
                "us-west-2a",
                "us-west-2b",
                "us-west-2c",
                "us-west-2d"
            ],
            "Status": "available",
            "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
            "SnapshotCreateTime": "2019-03-15T20:41:26.515Z",
            "SnapshotType": "manual",
            "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
            "DBClusterIdentifier": "sample-cluster",
            "MasterUsername": "master-user",
            "StorageEncrypted": false,
            "VpcId": "vpc-91280df6",
            "EngineVersion": "3.6.0",
            "PercentProgress": 100,
            "Port": 0,
            "Engine": "docdb",
            "ClusterCreateTime": "2019-03-15T20:29:58.836Z"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイドescribeDBCluster」の「D スナップショット」を参照してください。

API 詳細については、「コマンドリファレンスDescribeDbClusterSnapshots」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-clusters を使用する方法を示しています。

AWS CLI

1 つ以上の Amazon DocumentDB クラスターに関する詳細情報を取得するには。

次のdescribe-db-clusters例では、Amazon DocumentDB クラスターの詳細を表示しますsample-cluster。--db-cluster-identifier パラメータを省略すると、最大 100 個のクラスターの情報を取得できます。


aws docdb describe-db-clusters
    --db-cluster-identifier sample-cluster

出力:


{
    "DBClusters": [
        {
            "DBClusterParameterGroup": "default.docdb3.6",
            "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "PreferredBackupWindow": "00:00-00:30",
            "DBClusterIdentifier": "sample-cluster",
            "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
            "LatestRestorableTime": "2019-03-18T20:28:03.239Z",
            "MasterUsername": "master-user",
            "DBClusterMembers": [
                {
                    "PromotionTier": 1,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "IsClusterWriter": false,
                    "DBInstanceIdentifier": "sample-cluster"
                },
                {
                    "PromotionTier": 1,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "IsClusterWriter": true,
                    "DBInstanceIdentifier": "sample-cluster2"
                }
            ],
            "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-77186e0d",
                    "Status": "active"
                }
            ],
            "Engine": "docdb",
            "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "DBSubnetGroup": "default",
            "MultiAZ": true,
            "AvailabilityZones": [
                "us-west-2a",
                "us-west-2c",
                "us-west-2b"
            ],
            "EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
            "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
            "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
            "BackupRetentionPeriod": 3,
            "HostedZoneId": "ZNKXH85TT8WVW",
            "StorageEncrypted": false,
            "EnabledCloudwatchLogsExports": [
                "audit"
            ],
            "AssociatedRoles": [],
            "EngineVersion": "3.6.0",
            "Port": 27017,
            "Status": "available"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの説明」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeDbClusters」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-engine-versions を使用する方法を示しています。

AWS CLI

利用可能な Amazon DocumentDB エンジンバージョンを一覧表示するには

次のdescribe-db-engine-versions例では、使用可能なすべての Amazon DocumentDB エンジンバージョンを一覧表示します。


aws docdb describe-db-engine-versions \
    --engine docdb

出力:


{
    "DBEngineVersions": [
        {
            "DBEngineVersionDescription": "DocDB version 1.0.200837",
            "DBParameterGroupFamily": "docdb3.6",
            "EngineVersion": "3.6.0",
            "ValidUpgradeTarget": [],
            "DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)",
            "SupportsLogExportsToCloudwatchLogs": true,
            "Engine": "docdb",
            "ExportableLogTypes": [
                "audit"
            ]
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「D escribeDBEngineバージョン」を参照してください。

API 詳細については、「コマンドリファレンスDescribeDbEngineVersions」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-instances を使用する方法を示しています。

AWS CLI

プロビジョニングされた Amazon DocumentDB インスタンスに関する情報を検索するには

次のdescribe-db-instances例では、Amazon DocumentDB インスタンスに関する詳細を表示しますsample-cluster-instance。--db-instance-identifier パラメータを省略すると、最大 100 個のインスタンスに関する情報を取得します。


aws docdb describe-db-instances \
    --db-instance-identifier sample-cluster-instance

出力:


{
    "DBInstances": [
        {
            "Endpoint": {
                "HostedZoneId": "ZNKXH85TT8WVW",
                "Address": "sample-cluster-instance.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
                "Port": 27017
            },
            "PreferredBackupWindow": "00:00-00:30",
            "DBInstanceStatus": "available",
            "DBInstanceClass": "db.r4.large",
            "EnabledCloudwatchLogsExports": [
                "audit"
            ],
            "DBInstanceIdentifier": "sample-cluster-instance",
            "DBSubnetGroup": {
                "Subnets": [
                    {
                        "SubnetStatus": "Active",
                        "SubnetIdentifier": "subnet-4e26d263",
                        "SubnetAvailabilityZone": {
                            "Name": "us-west-2a"
                        }
                    },
                    {
                        "SubnetStatus": "Active",
                        "SubnetIdentifier": "subnet-afc329f4",
                        "SubnetAvailabilityZone": {
                            "Name": "us-west-2c"
                        }
                    },
                    {
                        "SubnetStatus": "Active",
                        "SubnetIdentifier": "subnet-53ab3636",
                        "SubnetAvailabilityZone": {
                            "Name": "us-west-2d"
                        }
                    },
                    {
                        "SubnetStatus": "Active",
                        "SubnetIdentifier": "subnet-991cb8d0",
                        "SubnetAvailabilityZone": {
                            "Name": "us-west-2b"
                        }
                    }
                ],
                "DBSubnetGroupName": "default",
                "SubnetGroupStatus": "Complete",
                "DBSubnetGroupDescription": "default",
                "VpcId": "vpc-91280df6"
            },
            "InstanceCreateTime": "2019-03-15T20:36:06.338Z",
            "Engine": "docdb",
            "StorageEncrypted": false,
            "AutoMinorVersionUpgrade": true,
            "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance",
            "PreferredMaintenanceWindow": "tue:08:39-tue:09:09",
            "VpcSecurityGroups": [
                {
                    "Status": "active",
                    "VpcSecurityGroupId": "sg-77186e0d"
                }
            ],
            "DBClusterIdentifier": "sample-cluster",
            "PendingModifiedValues": {},
            "BackupRetentionPeriod": 3,
            "PubliclyAccessible": false,
            "EngineVersion": "3.6.0",
            "PromotionTier": 1,
            "AvailabilityZone": "us-west-2c",
            "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB インスタンスの説明」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeDbInstances」の「」を参照してください。 AWS CLI

次のコード例は、describe-db-subnet-groups を使用する方法を示しています。

AWS CLI

Amazon DocumentDB サブネットの説明のリストを取得するには

次のdescribe-db-subnet-groups例では、という名前の Amazon DocumentDB サブネットの詳細について説明しますdefault。


aws docdb describe-db-subnet-groups \
    --db-subnet-group-name default

出力:


{
    "DBSubnetGroups": [
        {
            "VpcId": "vpc-91280df6",
            "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:default",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-4e26d263",
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    }
                },
                {
                    "SubnetIdentifier": "subnet-afc329f4",
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    }
                },
                {
                    "SubnetIdentifier": "subnet-53ab3636",
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    }
                },
                {
                    "SubnetIdentifier": "subnet-991cb8d0",
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    }
                }
            ],
            "DBSubnetGroupName": "default",
            "SubnetGroupStatus": "Complete",
            "DBSubnetGroupDescription": "default"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「サブネットグループの説明」を参照してください。

API 詳細については、「コマンドリファレンスDescribeDbSubnetGroups」の「」を参照してください。 AWS CLI

次の例は、describe-engine-default-cluster-parameters を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB のデフォルトのエンジンおよびシステムパラメータ情報を記述するには

次のdescribe-engine-default-cluster-parameters例では、Amazon DocumentDB パラメータグループのデフォルトのエンジンおよびシステムパラメータ情報の詳細を表示しますdocdb3.6。


aws docdb describe-engine-default-cluster-parameters \
    --db-parameter-group-family docdb3.6

出力:


{
    "EngineDefaults": {
        "DBParameterGroupFamily": "docdb3.6",
        "Parameters": [
            {
                "ApplyType": "dynamic",
                "ParameterValue": "disabled",
                "Description": "Enables auditing on cluster.",
                "Source": "system",
                "DataType": "string",
                "MinimumEngineVersion": "3.6.0",
                "AllowedValues": "enabled,disabled",
                "ParameterName": "audit_logs",
                "IsModifiable": true
            },
            {
                "ApplyType": "static",
                "ParameterValue": "enabled",
                "Description": "Config to enable/disable TLS",
                "Source": "system",
                "DataType": "string",
                "MinimumEngineVersion": "3.6.0",
                "AllowedValues": "disabled,enabled",
                "ParameterName": "tls",
                "IsModifiable": true
            },
            {
                "ApplyType": "dynamic",
                "ParameterValue": "enabled",
                "Description": "Enables TTL Monitoring",
                "Source": "system",
                "DataType": "string",
                "MinimumEngineVersion": "3.6.0",
                "AllowedValues": "disabled,enabled",
                "ParameterName": "ttl_monitor",
                "IsModifiable": true
            }
        ]
    }
}

詳細については、Amazon DocumentDB デベロッパーガイドDescribeEngineDefaultClusterParameters」の「」を参照してください。

API 詳細については、「コマンドリファレンスDescribeEngineDefaultClusterParameters」の「」を参照してください。 AWS CLI

次のコード例は、describe-event-categories を使用する方法を示しています。

AWS CLI

すべての Amazon DocumentDB イベントカテゴリを記述するには

次のdescribe-event-categories例では、Amazon DocumentDB イベントソースタイプのすべてのカテゴリを一覧表示しますdb-instance。


aws docdb describe-event-categories \
    --source-type db-cluster

出力:


{
    "EventCategoriesMapList": [
        {
            "SourceType": "db-cluster",
            "EventCategories": [
                "failover",
                "maintenance",
                "notification",
                "failure"
            ]
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「イベントカテゴリの表示」を参照してください。

API 詳細については、「コマンドリファレンスDescribeEventCategories」の「」を参照してください。 AWS CLI

次の例は、describe-events を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB イベントを一覧表示するには

次のdescribe-events例では、過去 24 時間 (1440 分) のすべての Amazon DocumentDB イベントを一覧表示します。


aws docdb describe-events \
    --duration 1440

このコマンドでは何も出力されません。出力:


{
    "Events": [
        {
            "EventCategories": [
                "failover"
            ],
            "Message": "Started cross AZ failover to DB instance: sample-cluster",
            "Date": "2019-03-18T21:36:29.807Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
            "SourceIdentifier": "sample-cluster",
            "SourceType": "db-cluster"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance restarted",
            "Date": "2019-03-18T21:36:40.793Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster",
            "SourceIdentifier": "sample-cluster",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [],
            "Message": "A new writer was promoted. Restarting database as a reader.",
            "Date": "2019-03-18T21:36:43.873Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance restarted",
            "Date": "2019-03-18T21:36:51.257Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "failover"
            ],
            "Message": "Completed failover to DB instance: sample-cluster",
            "Date": "2019-03-18T21:36:53.462Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
            "SourceIdentifier": "sample-cluster",
            "SourceType": "db-cluster"
        },
        {
            "Date": "2019-03-19T16:51:48.847Z",
            "EventCategories": [
                "configuration change"
            ],
            "Message": "Updated parameter audit_logs to enabled with apply method pending-reboot",
            "SourceIdentifier": "custom3-6-param-grp",
            "SourceType": "db-parameter-group"
        },
        {
            "EventCategories": [
                "configuration change"
            ],
            "Message": "Applying modification to database instance class",
            "Date": "2019-03-19T17:55:20.095Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance shutdown",
            "Date": "2019-03-19T17:56:31.127Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "configuration change"
            ],
            "Message": "Finished applying modification to DB instance class",
            "Date": "2019-03-19T18:00:45.822Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance restarted",
            "Date": "2019-03-19T18:00:53.397Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance shutdown",
            "Date": "2019-03-19T18:23:36.045Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "EventCategories": [
                "availability"
            ],
            "Message": "DB instance restarted",
            "Date": "2019-03-19T18:23:46.209Z",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
            "SourceIdentifier": "sample-cluster2",
            "SourceType": "db-instance"
        },
        {
            "Date": "2019-03-19T18:39:05.822Z",
            "EventCategories": [
                "configuration change"
            ],
            "Message": "Updated parameter ttl_monitor to enabled with apply method immediate",
            "SourceIdentifier": "custom3-6-param-grp",
            "SourceType": "db-parameter-group"
        },
        {
            "Date": "2019-03-19T18:39:48.067Z",
            "EventCategories": [
                "configuration change"
            ],
            "Message": "Updated parameter audit_logs to disabled with apply method immediate",
            "SourceIdentifier": "custom3-6-param-grp",
            "SourceType": "db-parameter-group"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB イベントの表示」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeEvents」の「」を参照してください。 AWS CLI

次の例は、describe-orderable-db-instance-options を使用する方法を説明しています。

AWS CLI

注文できる Amazon DocumentDB インスタンスオプションを見つけるには

次のdescribe-orderable-db-instance-options例では、リージョンの Amazon DocumentDB のすべてのインスタンスオプションを一覧表示します。


aws docdb describe-orderable-db-instance-options \
    --engine docdb \
    --region us-east-1

出力:


{
    "OrderableDBInstanceOptions": [
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.16xlarge",
            "LicenseModel": "na",
            "Engine": "docdb"
        },
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.2xlarge",
            "LicenseModel": "na",
            "Engine": "docdb"
        },
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.4xlarge",
            "LicenseModel": "na",
            "Engine": "docdb"
        },
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.8xlarge",
            "LicenseModel": "na",
            "Engine": "docdb"
        },
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.large",
            "LicenseModel": "na",
            "Engine": "docdb"
        },
        {
            "Vpc": true,
            "AvailabilityZones": [
                {
                    "Name": "us-east-1a"
                },
                {
                    "Name": "us-east-1b"
                },
                {
                    "Name": "us-east-1c"
                },
                {
                    "Name": "us-east-1d"
                }
            ],
            "EngineVersion": "3.6.0",
            "DBInstanceClass": "db.r4.xlarge",
            "LicenseModel": "na",
            "Engine": "docdb"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「クラスターへの Amazon DocumentDB インスタンスの追加」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスDescribeOrderableDbInstanceOptions」の「」を参照してください。 AWS CLI

次のコード例は、describe-pending-maintenance-actions を使用する方法を示しています。

AWS CLI

保留中の Amazon DocumentDB メンテナンスアクションを一覧表示するには

次のdescribe-pending-maintenance-actions例では、保留中のすべての Amazon DocumentDB メンテナンスアクションを一覧表示します。


aws docdb describe-pending-maintenance-actions

出力:


{
    "PendingMaintenanceActions": []
}

詳細については、Amazon DocumentDB デベロッパーガイド」のAmazon DocumentDB の維持」を参照してください。

API 詳細については、「コマンドリファレンスDescribePendingMaintenanceActions」の「」を参照してください。 AWS CLI

次の例は、failover-db-cluster を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターをレプリカに強制フェイルオーバーするには

次のfailover-db-cluster例では、Amazon DocumentDB クラスターの sample-cluster のプライマリインスタンスがレプリカにフェイルオーバーします。


aws docdb failover-db-cluster \
    --db-cluster-identifier sample-cluster

出力:


{
    "DBCluster": {
        "AssociatedRoles": [],
        "DBClusterIdentifier": "sample-cluster",
        "EngineVersion": "3.6.0",
        "DBSubnetGroup": "default",
        "MasterUsername": "master-user",
        "EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2c",
            "us-west-2b"
        ],
        "LatestRestorableTime": "2019-03-18T21:35:23.548Z",
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "PreferredBackupWindow": "00:00-00:30",
        "Port": 27017,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "StorageEncrypted": false,
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "MultiAZ": true,
        "Status": "available",
        "DBClusterMembers": [
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "IsClusterWriter": false,
                "DBInstanceIdentifier": "sample-cluster",
                "PromotionTier": 1
            },
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "IsClusterWriter": true,
                "DBInstanceIdentifier": "sample-cluster2",
                "PromotionTier": 2
            }
        ],
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "DBClusterParameterGroup": "default.docdb3.6",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "BackupRetentionPeriod": 3,
        "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Engine": "docdb"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB フェイルオーバー」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスFailoverDbCluster」の「」を参照してください。 AWS CLI

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB リソースのすべてのタグを一覧表示するには

次のlist-tags-for-resource例では、Amazon DocumentDB クラスターのすべてのタグを一覧表示しますsample-cluster。


aws docdb list-tags-for-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster

出力:


{
    "TagList": [
        {
            "Key": "A",
            "Value": "ALPHA"
        },
        {
            "Key": "B",
            "Value": ""
        },
        {
            "Key": "C",
            "Value": "CHARLIE"
        }
    ]
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB リソースでのタグの一覧表示」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスListTagsForResource」の「」を参照してください。 AWS CLI

次のコード例は、modify-db-cluster-parameter-group を使用する方法を示しています。

AWS CLI

Amazon DocumentDB DB クラスターパラメータグループを変更するには

次のmodify-db-cluster-parameter-group例では、2 つのパラメータ audit_logsとを有効にcustom3-6-param-grpして Amazon DocumentDB クラスターパラメータグループを変更しますttl_monitor。変更は次回の再起動時に適用されます。


aws docdb modify-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \
                 ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot

出力:


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループの変更」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスModifyDbClusterParameterGroup」の「」を参照してください。 AWS CLI

次の例は、modify-db-cluster-snapshot-attribute を使用する方法を説明しています。

AWS CLI

例 1: Amazon DocumentDB スナップショットに属性を追加するには

次のmodify-db-cluster-snapshot-attribute例では、Amazon DocumentDB クラスタースナップショットに 4 つの属性値を追加します。


aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-add 123456789011 123456789012 123456789013

出力:


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789012",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

例 2: Amazon DocumentDB スナップショットから属性を削除するには

次のmodify-db-cluster-snapshot-attribute例では、Amazon DocumentDB クラスタースナップショットから 2 つの属性値を削除します。


aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-remove 123456789012

出力:


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「ModifyDBClusterSnapshotAttribute」を参照してください。

API 詳細については、「コマンドリファレンスModifyDbClusterSnapshotAttribute」の「」を参照してください。 AWS CLI

次の例は、modify-db-cluster を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB クラスターを変更するには

次のmodify-db-cluster例では、自動バックアップの保持期間を 7 日間に設定し、バックアップとメンテナンスの両方の優先ウィンドウを変更sample-clusterすることで、Amazon DocumentDB クラスターを変更します。すべての変更は、次のメンテナンスウィンドウに適用されます。


aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --no-apply-immediately \
    --backup-retention-period 7 \
    --preferred-backup-window 18:00-18:30 \
    --preferred-maintenance-window sun:20:00-sun:20:30

出力:


{
    "DBCluster": {
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DBClusterMembers": [
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster",
                "IsClusterWriter": true,
                "PromotionTier": 1
            },
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster2",
                "IsClusterWriter": false,
                "PromotionTier": 2
            }
        ],
        "HostedZoneId": "ZNKXH85TT8WVW",
        "StorageEncrypted": false,
        "PreferredBackupWindow": "18:00-18:30",
        "MultiAZ": true,
        "EngineVersion": "3.6.0",
        "MasterUsername": "master-user",
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DBSubnetGroup": "default",
        "LatestRestorableTime": "2019-03-18T22:08:13.408Z",
        "EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
        "PreferredMaintenanceWindow": "sun:20:00-sun:20:30",
        "AssociatedRoles": [],
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "Engine": "docdb",
        "DBClusterParameterGroup": "default.docdb3.6",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2c",
            "us-west-2b"
        ],
        "Status": "available",
        "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "Port": 27017
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの変更」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスModifyDbCluster」の「」を参照してください。 AWS CLI

次の例は、modify-db-instance を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB インスタンスを変更するには

次のmodify-db-instance例では、インスタンスクラスをにdb.r4.4xlarge、昇格階層をに変更sample-cluster2することで、Amazon DocumentDB インスタンスを変更します5。変更はすぐに適用されますが、インスタンスのステータスが使用可能になった後にのみ表示されます。


aws docdb modify-db-instance \
    --db-instance-identifier sample-cluster2 \
    --apply-immediately \
    --db-instance-class db.r4.4xlarge \
    --promotion-tier 5

出力:


{
    "DBInstance": {
        "EngineVersion": "3.6.0",
        "StorageEncrypted": false,
        "DBInstanceClass": "db.r4.large",
        "PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
        "AutoMinorVersionUpgrade": true,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "PreferredBackupWindow": "18:00-18:30",
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "AvailabilityZone": "us-west-2f",
        "DBInstanceIdentifier": "sample-cluster2",
        "InstanceCreateTime": "2019-03-15T20:36:06.338Z",
        "Engine": "docdb",
        "BackupRetentionPeriod": 7,
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-4e26d263",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-afc329f4",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-53ab3636",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-991cb8d0",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active"
                }
            ],
            "VpcId": "vpc-91280df6"
        },
        "PromotionTier": 2,
        "Endpoint": {
            "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
        "DBClusterIdentifier": "sample-cluster",
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
        "PendingModifiedValues": {
            "DBInstanceClass": "db.r4.4xlarge"
        },
        "PubliclyAccessible": false,
        "DBInstanceStatus": "available"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB インスタンスの変更」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスModifyDbInstance」の「」を参照してください。 AWS CLI

次のコード例は、modify-db-subnet-group を使用する方法を示しています。

AWS CLI

Amazon DocumentDB サブネットグループを変更するには

次のmodify-db-subnet-group例では、指定されたサブネットと新しい説明sample-subnet-groupを追加して、サブネットグループを変更します。


aws docdb modify-db-subnet-group \
    --db-subnet-group-name sample-subnet-group \
    --subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \
    --db-subnet-group-description "New subnet description"

出力:


{
    "DBSubnetGroup": {
        "DBSubnetGroupName": "sample-subnet-group",
        "SubnetGroupStatus": "Complete",
        "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group",
        "VpcId": "vpc-91280df6",
        "DBSubnetGroupDescription": "New subnet description",
        "Subnets": [
            {
                "SubnetIdentifier": "subnet-b3806e8f",
                "SubnetStatus": "Active",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2a"
                }
            },
            {
                "SubnetIdentifier": "subnet-53ab3636",
                "SubnetStatus": "Active",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2c"
                }
            },
            {
                "SubnetIdentifier": "subnet-991cb8d0",
                "SubnetStatus": "Active",
                "SubnetAvailabilityZone": {
                    "Name": "us-west-2b"
                }
            }
        ]
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB サブネットグループの変更」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスModifyDbSubnetGroup」の「」を参照してください。 AWS CLI

次のコード例は、reboot-db-instance を使用する方法を示しています。

AWS CLI

Amazon DocumentDB インスタンスを再起動するには

次のreboot-db-instance例では、Amazon DocumentDB インスタンスを再起動しますsample-cluster2。


aws docdb reboot-db-instance \
    --db-instance-identifier sample-cluster2

このコマンドでは何も出力されません。出力:


{
    "DBInstance": {
        "PreferredBackupWindow": "18:00-18:30",
        "DBInstanceIdentifier": "sample-cluster2",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "DBSubnetGroup": {
            "VpcId": "vpc-91280df6",
            "Subnets": [
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetStatus": "Active",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "SubnetGroupStatus": "Complete",
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default"
        },
        "PendingModifiedValues": {},
        "Endpoint": {
            "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com",
            "HostedZoneId": "ZNKXH85TT8WVW",
            "Port": 27017
        },
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "StorageEncrypted": false,
        "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA",
        "AutoMinorVersionUpgrade": true,
        "Engine": "docdb",
        "InstanceCreateTime": "2019-03-15T20:36:06.338Z",
        "EngineVersion": "3.6.0",
        "PromotionTier": 5,
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "sample-cluster",
        "PreferredMaintenanceWindow": "mon:08:39-mon:09:09",
        "PubliclyAccessible": false,
        "DBInstanceClass": "db.r4.4xlarge",
        "AvailabilityZone": "us-west-2d",
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
        "DBInstanceStatus": "rebooting"
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB の再起動ILnstance」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスRebootDbInstance」の「」を参照してください。 AWS CLI

次の例は、remove-tags-from-resource を使用する方法を説明しています。

AWS CLI

Amazon DocumentDB リソースからタグを削除するには

次のremove-tags-from-resource例では、Amazon DocumentDB クラスター Bからという名前のキーを持つタグを削除しますsample-cluster。


aws docdb remove-tags-from-resource \
    --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --tag-keys B

このコマンドでは何も出力されません。

詳細については、「Amazon DocumentDB デベロッパーガイド」の「Amazon D からのタグocumentDBResourceの削除」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスRemoveTagsFromResource」の「」を参照してください。 AWS CLI

次のコード例は、reset-db-cluster-parameter-group を使用する方法を示しています。

AWS CLI

指定されたパラメータ値を Amazon DocumentDB パラメータグループのデフォルトにリセットするには

次のreset-db-cluster-parameter-group例では、Amazon DocumentDB パラメータグループのパラメータttl_monitorをデフォルト値custom3-6-param-grpにリセットします。


aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=ttl_monitor,ApplyMethod=immediate

出力:


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「タイトル」を参照してください。

Amazon DocumentDB パラメータグループの指定された値またはすべてのパラメータ値をデフォルトにリセットするには

次のreset-db-cluster-parameter-group例では、Amazon DocumentDB パラメータグループのすべてのパラメータをデフォルト値custom3-6-param-grpにリセットします。


aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --reset-all-parameters

出力:


{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターパラメータグループのリセット」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスResetDbClusterParameterGroup」の「」を参照してください。 AWS CLI

次の例は、restore-db-cluster-from-snapshot を使用する方法を説明しています。

AWS CLI

自動または手動スナップショットから Amazon DocumentDB クラスターを復元するには

次のrestore-db-cluster-from-snapshot例では、スナップショット sample-cluster-2019-03-16-00-01-restoredからという名前の新しい Amazon DocumentDB クラスターを作成しますrds:sample-cluster-2019-03-16-00-01。


aws docdb restore-db-cluster-from-snapshot \
    --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \
    --engine docdb \
    --snapshot-identifier rds:sample-cluster-2019-03-16-00-01

出力:


{
    "DBCluster": {
        "ClusterCreateTime": "2019-03-19T18:45:01.857Z",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "Engine": "docdb",
        "DBClusterMembers": [],
        "MultiAZ": false,
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2c",
            "us-west-2b"
        ],
        "StorageEncrypted": false,
        "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Port": 27017,
        "PreferredBackupWindow": "00:00-00:30",
        "DBSubnetGroup": "default",
        "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
        "DBClusterParameterGroup": "default.docdb3.6",
        "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
        "MasterUsername": "master-user",
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "AssociatedRoles": [],
        "Status": "creating",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ]
    }
}

詳細については、「Amazon DocumentDB デベロッパーガイド」の「クラスタースナップショットからの復元」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスRestoreDbClusterFromSnapshot」の「」を参照してください。 AWS CLI

次の例は、restore-db-cluster-to-point-in-time を使用する方法を説明しています。

AWS CLI

手動スナップショット point-in-time から Amazon DocumentDB クラスターをに復元するには

次のrestore-db-cluster-to-point-in-time例ではsample-cluster-snapshot、を使用して、復元可能な最新の時刻を使用して新しい Amazon DocumentDB クラスター sample-cluster-pitを作成します。


aws docdb restore-db-cluster-to-point-in-time \
    --db-cluster-identifier sample-cluster-pit \
    --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \
    --use-latest-restorable-time

出力:


{
    "DBCluster": {
        "StorageEncrypted": false,
        "BackupRetentionPeriod": 3,
        "MasterUsername": "master-user",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "PreferredBackupWindow": "00:00-00:30",
        "MultiAZ": false,
        "DBClusterIdentifier": "sample-cluster-pit",
        "DBSubnetGroup": "default",
        "ClusterCreateTime": "2019-04-03T15:55:21.320Z",
        "AssociatedRoles": [],
        "DBClusterParameterGroup": "default.docdb3.6",
        "DBClusterMembers": [],
        "Status": "creating",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2d",
            "us-west-2b"
        ],
        "ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "Port": 27017,
        "Engine": "docdb",
        "EngineVersion": "3.6.0",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit"
    }
}

詳細については、「Amazon DocumentDB デベロッパーガイド」の「ポイントインタイムへのスナップショットの復元」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスRestoreDbClusterToPointInTime」の「」を参照してください。 AWS CLI

次の例は、start-db-cluster を使用する方法を説明しています。

AWS CLI

停止した Amazon DocumentDB クラスターを開始するには

次のstart-db-cluster例では、指定された Amazon DocumentDB クラスターを起動します。


aws docdb start-db-cluster \
    --db-cluster-identifier sample-cluster

出力:


{
    "DBCluster": {
        "ClusterCreateTime": "2019-03-19T18:45:01.857Z",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "Engine": "docdb",
        "DBClusterMembers": [],
        "MultiAZ": false,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1c",
            "us-east-1f"
        ],
        "StorageEncrypted": false,
        "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
        "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
        "Port": 27017,
        "PreferredBackupWindow": "00:00-00:30",
        "DBSubnetGroup": "default",
        "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
        "DBClusterParameterGroup": "default.docdb3.6",
        "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
        "MasterUsername": "master-user",
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "AssociatedRoles": [],
        "Status": "creating",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ]
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの停止と起動」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスStartDbCluster」の「」を参照してください。 AWS CLI

次のコード例は、stop-db-cluster を使用する方法を示しています。

AWS CLI

実行中の Amazon DocumentDB クラスターを停止するには

次のstop-db-cluster例では、指定された Amazon DocumentDB クラスターを停止します。


aws docdb stop-db-cluster \
    --db-cluster-identifier sample-cluster

出力:


{
    "DBCluster": {
        "ClusterCreateTime": "2019-03-19T18:45:01.857Z",
        "HostedZoneId": "ZNKXH85TT8WVW",
        "Engine": "docdb",
        "DBClusterMembers": [],
        "MultiAZ": false,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1c",
            "us-east-1f"
        ],
        "StorageEncrypted": false,
        "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
        "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com",
        "Port": 27017,
        "PreferredBackupWindow": "00:00-00:30",
        "DBSubnetGroup": "default",
        "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored",
        "PreferredMaintenanceWindow": "sat:04:30-sat:05:00",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored",
        "DBClusterParameterGroup": "default.docdb3.6",
        "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU",
        "MasterUsername": "master-user",
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "AssociatedRoles": [],
        "Status": "creating",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ]
    }
}

詳細については、Amazon DocumentDB デベロッパーガイド」の「Amazon DocumentDB クラスターの停止と起動」を参照してください。 Amazon DocumentDB

API 詳細については、「コマンドリファレンスStopDbCluster」の「」を参照してください。 AWS CLI

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS DMS

DynamoDB