翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon DocumentDB の操作
これらのセクションでは、Amazon DocumentDB を使用した開発について説明します。
**Topics**
+ [DocumentDB に接続する](connect-docdb.md)
+ [DocumentDB を使用したプログラム](program-docdb.md)
# Amazon DocumentDB に接続する
Amazon DocumentDB には、MongoDB ドライバーを使用したプログラムによる接続、SSH トンネリングまたは AWS VPN を介した VPC 外部からの接続、Studio 3T や DataGrip などの一般的なツールなど、複数の接続オプションが用意されています。このサービスは、高可用性のためにレプリカセット接続をサポートしています。分析とレポートの場合は、JDBC または ODBC ドライバーを使用して接続できます。同じ VPC 内の EC2 インスタンスは、DocumentDB クラスターに直接接続できます。すべての接続には TLS と適切な AWS 認証情報/認証が必要です。
**Topics**
+ [プログラムによる接続](connect_programmatically.md)
+ [Amazon VPC の外部からの接続](connect-from-outside-a-vpc.md)
+ [レプリカセットとして接続する](connect-to-replica-set.md)
+ [Studio 3T を使用して接続](studio3t.md)
+ [DataGrip を使用して接続する](data-grip-connect.md)
+ [Amazon EC2 を使用した接続](connect-ec2.md)
+ [JDBC ドライバーによる接続](connect-jdbc.md)
+ [ODBC ドライバーを使用して接続します](connect-odbc.md)
# プログラムによる Amazon DocumentDB への接続
このセクションでは、複数の言語を使用して Amazon DocumentDB (MongoDB 互換）に接続する方法を示すコード例を紹介します。コード例は、Transport Layer Security (TLS) が有効または無効になっているクラスターに接続しているかどうかに基づいて、2 つのセクションに分かれています。TLS は、新しい Amazon DocumentDB クラスターに対してデフォルトで有効になっています。ただし、必要に応じて TLS を無効にすることができます。詳細については、「[転送中のデータの暗号化](security.encryption.ssl.md)」を参照してください。
クラスターが存在する VPC の外部から Amazon DocumentDB に接続しようとしている場合は、「[Amazon VPC の外部から Amazon DocumentDB クラスターへの接続](connect-from-outside-a-vpc.md)」を参照してください。
クラスターに接続する前に、TLS がクラスターで有効になっているかどうかを把握しておく必要があります。次のセクションでは、`tls` または AWS マネジメントコンソール を使用してクラスターの AWS CLI パラメータの値を確認する方法について説明します。続いて、適切なコード例を見つけて適用する操作について説明します。
**Topics**
+ [`tls` パラメータの値の確認](#connect_programmatically-determine_tls_value)
+ [TLS が有効な場合の接続](#connect_programmatically-tls_enabled)
+ [TLS が無効な場合の接続](#connect_programmatically-tls_disabled)
## `tls` パラメータの値の確認
クラスターで TLS が有効になっているかどうかは、AWS マネジメントコンソール または AWS CLI を使用して実行できる 2 段階のプロセスで確認します。
1. **クラスターを管理しているパラメータグループを確認します。**
------
#### [ Using the AWS マネジメントコンソール ]
1. AWS マネジメントコンソール にサインインして、Amazon DocumentDB コンソール [https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) を開いてください。
1. 左のナビゲーションペインで **[Clusters]** (クラスター) を選択します。
1. クラスターのリストで、クラスターの名前を選択します。
1. 結果のページには、選択したクラスターの詳細が表示されます。[**Configuration (設定)**] タブを選択します。[**設定およびステータス**] セクションで、[**クラスターパラメータグループ**] の下にあるパラメータグループの名前を見つけます。
------
#### [ Using the AWS CLI ]
次の AWS CLI コードでは、クラスターを管理しているパラメータを確認します。*`sample-cluster`* は、必ずクラスターの名前に置き換えてください。
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'
```
このオペレーションによる出力は、次のようになります。
```
[
[
"sample-cluster",
"sample-parameter-group"
]
]
```
------
1. **クラスターの `tls` パラメータグループでパラメータの値を確認します。**
------
#### [ Using the AWS マネジメントコンソール ]
1. ナビゲーションペインで、**[パラメータグループ]** を選択します。
1. [**クラスターパラメータグループ**] ウィンドウで、ステップ 1 からクラスターパラメータグループ名を選択します。
1. 結果ページに、クラスターパラメータグループのパラメータが表示されます。ここで `tls` パラメータの値を確認できます。このパラメータの変更については、「[Amazon DocumentDB クラスターパラメータグループを変更する](cluster_parameter_groups-modify.md)」を参照してください。
------
#### [ Using the AWS CLI ]
`describe-db-cluster-parameters` AWS CLI コマンドを使用して、クラスターパラメータグループのパラメータの詳細を表示できます。
+ **`--describe-db-cluster-parameters`** — パラメータグループ内のすべてのパラメータとその詳細の一覧を表示するには。
+ **`--db-cluster-parameter-group name`** — 必須。クラスターパラメータグループの名前。
次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。
```
aws docdb describe-db-cluster-parameters \
--db-cluster-parameter-group-name sample-parameter-group
```
このオペレーションによる出力は、次のようになります。
```
{
"Parameters": [
{
"ParameterName": "profiler_threshold_ms",
"ParameterValue": "100",
"Description": "Operations longer than profiler_threshold_ms will be logged",
"Source": "system",
"ApplyType": "dynamic",
"DataType": "integer",
"AllowedValues": "50-2147483646",
"IsModifiable": true,
"ApplyMethod": "pending-reboot"
},
{
"ParameterName": "tls",
"ParameterValue": "disabled",
"Description": "Config to enable/disable TLS",
"Source": "user",
"ApplyType": "static",
"DataType": "string",
"AllowedValues": "disabled,enabled,fips-140-3",
"IsModifiable": true,
"ApplyMethod": "pending-reboot"
}
]
}
```
**注記**
Amazon DocumentDBは、Amazon DocumentDB 5.0 (エンジンバージョン 3.0.3727) クラスター以降、ca-central-1、us-west-2、us-east-1、us-east-2、us-gov-east-1、us-gov-west-1 リージョンで FIPS 140-3 エンドポイントをサポートします。
------
`tls` パラメータの値を確認したら、続いて以下のセクションのコード例のうち 1 つを使用してクラスターに接続します。
+ [TLS が有効な場合の接続](#connect_programmatically-tls_enabled)
+ [TLS が無効な場合の接続](#connect_programmatically-tls_disabled)
## TLS が有効な場合の接続
TLS が有効化されている Amazon DocumentDB クラスターにプログラムで接続するためのコード例を表示するには、使用する言語に該当するタブを選択してください。
転送中のデータを暗号化するには、以下のオペレーションを使用して、 `global-bundle.pem` という Amazon DocumentDB のパブリックキーをダウンロードします。
```
wget https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem
```
アプリケーションが Microsoft Windows 上にあり、PKCS7 ファイルが必要な場合は、PKCS7 証明書バンドルをダウンロードできます。このバンドルには、[https://truststore.pki.rds.amazonaws.com/global/global-bundle.p7b](https://truststore.pki.rds.amazonaws.com/global/global-bundle.p7b) にある中間証明書とルート証明書の両方が含まれています。
------
#### [ Python ]
次のコードは、TLS が有効になっているときに Python を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
import pymongo
import sys
##Create a MongoDB client, open a connection to Amazon DocumentDB as a replica set and specify the read preference as secondary preferred
client = pymongo.MongoClient('mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
##Specify the database to be used
db = client.sample_database
##Specify the collection to be used
col = db.sample_collection
##Insert a single document
col.insert_one({'hello':'Amazon DocumentDB'})
##Find the document that was previously written
x = col.find_one({'hello':'Amazon DocumentDB'})
##Print the result to the screen
print(x)
##Close the connection
client.close()
```
------
#### [ Node.js ]
次のコードは、TLS が有効になっているときに Python を使用して Amazon DocumentDB に接続する方法を示しています。
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
var MongoClient = require('mongodb').MongoClient
//Create a MongoDB client, open a connection to DocDB; as a replica set,
// and specify the read preference as secondary preferred
var client = MongoClient.connect(
'mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/sample-database?tls=true&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false',
{
tlsCAFile: `global-bundle.pem` //Specify the DocDB; cert
},
function(err, client) {
if(err)
throw err;
//Specify the database to be used
db = client.db('sample-database');
//Specify the collection to be used
col = db.collection('sample-collection');
//Insert a single document
col.insertOne({'hello':'Amazon DocumentDB'}, function(err, result){
//Find the document that was previously written
col.findOne({'hello':'Amazon DocumentDB'}, function(err, result){
//Print the result to the screen
console.log(result);
//Close the connection
client.close()
});
});
});
```
------
#### [ PHP ]
次のコードは、TLS が有効になっているときに Python を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
"true", "tlsCAFile" => $TLS_DIR ]);
//Specify the database and collection to be used
$col = $client->sampledatabase->samplecollection;
//Insert a single document
$result = $col->insertOne( [ 'hello' => 'Amazon DocumentDB'] );
//Find the document that was previously written
$result = $col->findOne(array('hello' => 'Amazon DocumentDB'));
//Print the result to the screen
print_r($result);
?>
```
------
#### [ Go ]
次のコードは、TLS が有効になっているときに Go を使用して Amazon DocumentDB に接続する方法を示しています。
**注記**
バージョン 1.2.1 現在、MongoDB Go ドライバーは `sslcertificateauthorityfile` にある最初の CA サーバー証明書のみを使用します。次のコード例では、この制限に対処するために、`sslcertificateauthorityfile` にあるすべてのサーバー証明書を、クライアントの作成時に使用されるカスタム TLS 設定に手動で追加しています。
次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。
```
package main
import (
"context"
"fmt"
"log"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"io/ioutil"
"crypto/tls"
"crypto/x509"
"errors"
)
const (
// Path to the AWS CA file
caFilePath = "global-bundle.pem"
// Timeout operations after N seconds
connectTimeout = 5
queryTimeout = 30
username = "sample-user"
password = "password"
clusterEndpoint = "sample-cluster.node.us-east-1.docdb.amazonaws.com:27017"
// Which instances to read from
readPreference = "secondaryPreferred"
connectionStringTemplate = "mongodb://%s:%s@%s/sample-database?tls=true&replicaSet=rs0&readpreference=%s"
)
func main() {
connectionURI := fmt.Sprintf(connectionStringTemplate, username, password, clusterEndpoint, readPreference)
tlsConfig, err := getCustomTLSConfig(caFilePath)
if err != nil {
log.Fatalf("Failed getting TLS configuration: %v", err)
}
client, err := mongo.NewClient(options.Client().ApplyURI(connectionURI).SetTLSConfig(tlsConfig))
if err != nil {
log.Fatalf("Failed to create client: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), connectTimeout*time.Second)
defer cancel()
err = client.Connect(ctx)
if err != nil {
log.Fatalf("Failed to connect to cluster: %v", err)
}
// Force a connection to verify our connection string
err = client.Ping(ctx, nil)
if err != nil {
log.Fatalf("Failed to ping cluster: %v", err)
}
fmt.Println("Connected to DocumentDB!")
collection := client.Database("sample-database").Collection("sample-collection")
ctx, cancel = context.WithTimeout(context.Background(), queryTimeout*time.Second)
defer cancel()
res, err := collection.InsertOne(ctx, bson.M{"name": "pi", "value": 3.14159})
if err != nil {
log.Fatalf("Failed to insert document: %v", err)
}
id := res.InsertedID
log.Printf("Inserted document ID: %s", id)
ctx, cancel = context.WithTimeout(context.Background(), queryTimeout*time.Second)
defer cancel()
cur, err := collection.Find(ctx, bson.D{})
if err != nil {
log.Fatalf("Failed to run find query: %v", err)
}
defer cur.Close(ctx)
for cur.Next(ctx) {
var result bson.M
err := cur.Decode(&result)
log.Printf("Returned: %v", result)
if err != nil {
log.Fatal(err)
}
}
if err := cur.Err(); err != nil {
log.Fatal(err)
}
}
func getCustomTLSConfig(caFile string) (*tls.Config, error) {
tlsConfig := new(tls.Config)
certs, err := ioutil.ReadFile(caFile)
if err != nil {
return tlsConfig, err
}
tlsConfig.RootCAs = x509.NewCertPool()
ok := tlsConfig.RootCAs.AppendCertsFromPEM(certs)
if !ok {
return tlsConfig, errors.New("Failed parsing pem file")
}
return tlsConfig, nil
```
------
#### [ Java ]
Java アプリケーションから TLS が有効な Amazon DocumentDB クラスターに接続する場合、プログラムは AWS 提供の認証機関 (CA) ファイルを使用して接続を検証する必要があります。Amazon RDS CA 証明書を使用するには、以下の手順に従ってください。
1. Amazon RDS CA ファイルを [https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem](https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem) ダウンロード。
1. 次のコマンドを実行し、ファイルに含まれている CA 認定を使用して信頼ストアを作成します。*truststore-password* は必ず変更してください。古い CA 認定 (`rds-ca-2015-root.pem`) と新しい CA 認定 (`rds-ca-2019-root.pem`) の両方を含む信頼ストアにアクセスする場合は、認定バンドルを信頼ストアにインポートできます。
Linux オペレーティングシステムで、証明書バンドルを信頼ストアにインポートするサンプルシェルスクリプトを次に示します。次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。特に、サンプルディレクトリ「*mydir*」がスクリプトに含まれている場合は、このタスク用に作成したディレクトリに置き換えます。
```
mydir=/tmp/certs
truststore=${mydir}/rds-truststore.jks
storepassword=truststore-password
curl -sS "https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem" > ${mydir}/global-bundle.pem
awk 'split_after == 1 {n++;split_after=0} /-----END CERTIFICATE-----/ {split_after=1}{print > "rds-ca-" n ".pem"}' < ${mydir}/global-bundle.pem
for CERT in rds-ca-*; do
alias=$(openssl x509 -noout -text -in $CERT | perl -ne 'next unless /Subject:/; s/.*(CN=|CN = )//; print')
echo "Importing $alias"
keytool -import -file ${CERT} -alias "${alias}" -storepass ${storepassword} -keystore ${truststore} -noprompt
rm $CERT
done
rm ${mydir}/global-bundle.pem
echo "Trust store content is: "
keytool -list -v -keystore "$truststore" -storepass ${storepassword} | grep Alias | cut -d " " -f3- | while read alias
do
expiry=`keytool -list -v -keystore "$truststore" -storepass ${storepassword} -alias "${alias}" | grep Valid | perl -ne 'if(/until: (.*?)\n/) { print "$1\n"; }'`
echo " Certificate ${alias} expires in '$expiry'"
done
```
macOS で証明書バンドルを信頼ストアにインポートするサンプルシェルスクリプトを次に示します。
```
mydir=/tmp/certs
truststore=${mydir}/rds-truststore.jks
storepassword=truststore-password
curl -sS "https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem" > ${mydir}/global-bundle.pem
split -p "-----BEGIN CERTIFICATE-----" ${mydir}/global-bundle.pem rds-ca-
for CERT in rds-ca-*; do
alias=$(openssl x509 -noout -text -in $CERT | perl -ne 'next unless /Subject:/; s/.*(CN=|CN = )//; print')
echo "Importing $alias"
keytool -import -file ${CERT} -alias "${alias}" -storepass ${storepassword} -keystore ${truststore} -noprompt
rm $CERT
done
rm ${mydir}/global-bundle.pem
echo "Trust store content is: "
keytool -list -v -keystore "$truststore" -storepass ${storepassword} | grep Alias | cut -d " " -f3- | while read alias
do
expiry=`keytool -list -v -keystore "$truststore" -storepass ${storepassword} -alias "${alias}" | grep Valid | perl -ne 'if(/until: (.*?)\n/) { print "$1\n"; }'`
echo " Certificate ${alias} expires in '$expiry'"
done
```
1. Amazon DocumentDB クラスターに接続する前に、プログラムで `keystore` を使用するために、アプリケーションで次のシステムプロパティを設定します。
```
javax.net.ssl.trustStore: truststore
javax.net.ssl.trustStorePassword: truststore-password;
```
1. 次のコードは、TLS が有効になっているときに Java を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
package com.example.documentdb;
import com.mongodb.client.*;
import org.bson.Document;
public final class Test {
private Test() {
}
public static void main(String[] args) {
String template = "mongodb://%s:%s@%s/sample-database?ssl=true&replicaSet=rs0&readpreference=%s";
String username = "sample-user";
String password = "password";
String clusterEndpoint = "sample-cluster.node.us-east-1.docdb.amazonaws.com:27017";
String readPreference = "secondaryPreferred";
String connectionString = String.format(template, username, password, clusterEndpoint, readPreference);
String truststore = "truststore";
String truststorePassword = "truststore-password";
System.setProperty("javax.net.ssl.trustStore", truststore);
System.setProperty("javax.net.ssl.trustStorePassword", truststorePassword);
MongoClient mongoClient = MongoClients.create(connectionString);
MongoDatabase testDB = mongoClient.getDatabase("sample-database");
MongoCollection numbersCollection = testDB.getCollection("sample-collection");
Document doc = new Document("name", "pi").append("value", 3.14159);
numbersCollection.insertOne(doc);
MongoCursor cursor = numbersCollection.find().iterator();
try {
while (cursor.hasNext()) {
System.out.println(cursor.next().toJson());
}
} finally {
cursor.close();
}
}
}
```
------
#### [ C\$1 / .NET ]
次のコードは、TLS が有効になっているときに C\$1 / .NET を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
using System;
using System.Text;
using System.Linq;
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Net.Security;
using MongoDB.Driver;
using MongoDB.Bson;
namespace DocDB
{
class Program
{
static void Main(string[] args)
{
string template = "mongodb://{0}:{1}@{2}/sampledatabase?tls=true&replicaSet=rs0&readpreference={3}";
string username = "sample-user";
string password = "password";
string readPreference = "secondaryPreferred";
string clusterEndpoint="sample-cluster.node.us-east-1.docdb.amazonaws.com:27017";
string connectionString = String.Format(template, username, password, clusterEndpoint, readPreference);
string pathToCAFile = "";
// ADD CA certificate to local trust store
// DO this once - Maybe when your service starts
X509Store localTrustStore = new X509Store(StoreName.Root);
X509Certificate2Collection certificateCollection = new X509Certificate2Collection();
certificateCollection.Import(pathToCAFile);
try
{
localTrustStore.Open(OpenFlags.ReadWrite);
localTrustStore.AddRange(certificateCollection);
}
catch (Exception ex)
{
Console.WriteLine("Root certificate import failed: " + ex.Message);
throw;
}
finally
{
localTrustStore.Close();
}
var settings = MongoClientSettings.FromUrl(new MongoUrl(connectionString));
var client = new MongoClient(settings);
var database = client.GetDatabase("sampledatabase");
var collection = database.GetCollection("samplecollection");
var docToInsert = new BsonDocument { { "pi", 3.14159 } };
collection.InsertOne(docToInsert);
}
}
}
```
------
#### [ MongoDB Shell ]
次のコードは、TLS が有効化されている場合に、最新バージョンの mongosh、または以前の mongo シェルバージョンを使用して Amazon DocumentDB に接続してクエリする方法を示しています。
**mongosh を使用して Amazon DocumentDB に接続**
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。
```
mongosh --tls --host cluster-end-point:27017 --tlsCAFile global-bundle.pem --username sample-user --password password --retryWrites false
```
**以前の mongo シェルバージョンを使用して Amazon DocumentDB に接続**
IAM を使用する場合は、mongo シェルの以前のバージョンを使用する必要があります。次のコマンドオプションのいずれかを入力します。
```
mongo --ssl --host cluster-end-point:27017 --sslCAFile global-bundle.pem --username sample-user --password password
```
4.2 かそれ以降のバージョンの Mongo シェルを使用している場合は、次のコードを使用して接続します。再試行可能な書き込みは Amazon DocumentDB ではサポートされていません。例外: mongo シェル を使用している場合は、どのコード文字列にも `retryWrites=false` コマンドを含めないでください。デフォルトでは、再試行可能な書き込みは無効になっています。`retryWrites=false` を含めると、通常の読み取りコマンドでは失敗する可能性があります。
```
mongo --tls --host cluster-end-point:27017 --tlsCAFile global-bundle.pem --username sample-user --password password
```
**接続をテストする**
1. 単一のドキュメントを挿入します。
```
db.myTestCollection.insertOne({'hello':'Amazon DocumentDB'})
```
1. 以前に挿入されたドキュメントを検索します。
```
db.myTestCollection.find({'hello':'Amazon DocumentDB'})
```
------
#### [ R ]
次のコードは、TLS が有効になっているときに mongolite ([https://jeroen.github.io/mongolite/](https://jeroen.github.io/mongolite/)) を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
#Include the mongolite library.
library(mongolite)
mongourl <- paste("mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/test2?ssl=true&",
"readPreference=secondaryPreferred&replicaSet=rs0", sep="")
#Create a MongoDB client, open a connection to Amazon DocumentDB as a replica
# set and specify the read preference as secondary preferred
client <- mongo(url = mongourl, options = ssl_options(weak_cert_validation = F, ca =""))
#Insert a single document
str <- c('{"hello" : "Amazon DocumentDB"}')
client$insert(str)
#Find the document that was previously written
client$find()
```
------
#### [ Ruby ]
次のコードは、TLS が有効になっているときに Ruby を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
require 'mongo'
require 'neatjson'
require 'json'
client_host = 'mongodb://sample-cluster.node.us-east-1.docdb.amazonaws.com:27017'
client_options = {
database: 'test',
replica_set: 'rs0',
read: {:secondary_preferred => 1},
user: 'sample-user',
password: 'password',
ssl: true,
ssl_verify: true,
ssl_ca_cert: 'PATH/global-bundle.pem',
retry_writes: false
}
begin
##Create a MongoDB client, open a connection to Amazon DocumentDB as a
## replica set and specify the read preference as secondary preferred
client = Mongo::Client.new(client_host, client_options)
##Insert a single document
x = client[:test].insert_one({"hello":"Amazon DocumentDB"})
##Find the document that was previously written
result = client[:test].find()
#Print the document
result.each do |document|
puts JSON.neat_generate(document)
end
end
#Close the connection
client.close
```
------
## TLS が無効な場合の接続
TLS が無効化されている Amazon DocumentDB クラスターにプログラムで接続するためのコード例を表示するには、使用する言語のタブを選択してください。
------
#### [ Python ]
次のコードは、TLS が無効になっているときに Python を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
## Create a MongoDB client, open a connection to Amazon DocumentDB as a replica set and specify the read preference as secondary preferred
import pymongo
import sys
client = pymongo.MongoClient('mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/?replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
##Specify the database to be used
db = client.sample_database
##Specify the collection to be used
col = db.sample_collection
##Insert a single document
col.insert_one({'hello':'Amazon DocumentDB'})
##Find the document that was previously written
x = col.find_one({'hello':'Amazon DocumentDB'})
##Print the result to the screen
print(x)
##Close the connection
client.close()
```
------
#### [ Node.js ]
次のコードは、TLS が無効になっているときに Node.js を使用して Amazon DocumentDB に接続する方法を示しています。
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
var MongoClient = require('mongodb').MongoClient;
//Create a MongoDB client, open a connection to Amazon DocumentDB as a replica set,
// and specify the read preference as secondary preferred
var client = MongoClient.connect(
'mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/sample-database?replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false',
{
useNewUrlParser: true
},
function(err, client) {
if(err)
throw err;
//Specify the database to be used
db = client.db('sample-database');
//Specify the collection to be used
col = db.collection('sample-collection');
//Insert a single document
col.insertOne({'hello':'Amazon DocumentDB'}, function(err, result){
//Find the document that was previously written
col.findOne({'hello':'Amazon DocumentDB'}, function(err, result){
//Print the result to the screen
console.log(result);
//Close the connection
client.close()
});
});
});
```
------
#### [ PHP ]
次のコードは、TLS が無効になっているときに PHP を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
sampledatabase->samplecollection;
//Insert a single document
$result = $col->insertOne( [ 'hello' => 'Amazon DocumentDB'] );
//Find the document that was previously written
$result = $col->findOne(array('hello' => 'Amazon DocumentDB'));
//Print the result to the screen
print_r($result);
?>
```
------
#### [ Go ]
次のコードは、TLS が無効になっているときに Go を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
package main
import (
"context"
"fmt"
"log"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
)
const (
// Timeout operations after N seconds
connectTimeout = 5
queryTimeout = 30
username = "sample-user"
password = "password"
clusterEndpoint = "sample-cluster.node.us-east-1.docdb.amazonaws.com:27017"
// Which instances to read from
readPreference = "secondaryPreferred"
connectionStringTemplate = "mongodb://%s:%s@%s/sample-database?replicaSet=rs0&readpreference=%s"
)
func main() {
connectionURI := fmt.Sprintf(connectionStringTemplate, username, password, clusterEndpoint, readPreference)
client, err := mongo.NewClient(options.Client().ApplyURI(connectionURI))
if err != nil {
log.Fatalf("Failed to create client: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), connectTimeout*time.Second)
defer cancel()
err = client.Connect(ctx)
if err != nil {
log.Fatalf("Failed to connect to cluster: %v", err)
}
// Force a connection to verify our connection string
err = client.Ping(ctx, nil)
if err != nil {
log.Fatalf("Failed to ping cluster: %v", err)
}
fmt.Println("Connected to DocumentDB!")
collection := client.Database("sample-database").Collection("sample-collection")
ctx, cancel = context.WithTimeout(context.Background(), queryTimeout*time.Second)
defer cancel()
res, err := collection.InsertOne(ctx, bson.M{"name": "pi", "value": 3.14159})
if err != nil {
log.Fatalf("Failed to insert document: %v", err)
}
id := res.InsertedID
log.Printf("Inserted document ID: %s", id)
ctx, cancel = context.WithTimeout(context.Background(), queryTimeout*time.Second)
defer cancel()
cur, err := collection.Find(ctx, bson.D{})
if err != nil {
log.Fatalf("Failed to run find query: %v", err)
}
defer cur.Close(ctx)
for cur.Next(ctx) {
var result bson.M
err := cur.Decode(&result)
log.Printf("Returned: %v", result)
if err != nil {
log.Fatal(err)
}
}
if err := cur.Err(); err != nil {
log.Fatal(err)
}
}
```
------
#### [ Java ]
次のコードは、TLS が無効になっているときに Java を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
package com.example.documentdb;
import com.mongodb.MongoClient;
import com.mongodb.MongoClientURI;
import com.mongodb.ServerAddress;
import com.mongodb.MongoException;
import com.mongodb.client.MongoCursor;
import com.mongodb.client.MongoDatabase;
import com.mongodb.client.MongoCollection;
import org.bson.Document;
public final class Main {
private Main() {
}
public static void main(String[] args) {
String template = "mongodb://%s:%s@%s/sample-database?replicaSet=rs0&readpreference=%s";
String username = "sample-user";
String password = "password";
String clusterEndpoint = "sample-cluster.node.us-east-1.docdb.amazonaws.com:27017";
String readPreference = "secondaryPreferred";
String connectionString = String.format(template, username, password, clusterEndpoint, readPreference);
MongoClientURI clientURI = new MongoClientURI(connectionString);
MongoClient mongoClient = new MongoClient(clientURI);
MongoDatabase testDB = mongoClient.getDatabase("sample-database");
MongoCollection numbersCollection = testDB.getCollection("sample-collection");
Document doc = new Document("name", "pi").append("value", 3.14159);
numbersCollection.insertOne(doc);
MongoCursor cursor = numbersCollection.find().iterator();
try {
while (cursor.hasNext()) {
System.out.println(cursor.next().toJson());
}
} finally {
cursor.close();
}
}
}
```
------
#### [ C\$1 / .NET ]
次のコードは、TLS が無効になっているときに C\$1 / .NET を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
using System;
using System.Text;
using System.Linq;
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Net.Security;
using MongoDB.Driver;
using MongoDB.Bson;
namespace CSharpSample
{
class Program
{
static void Main(string[] args)
{
string template = "mongodb://{0}:{1}@{2}/sampledatabase?replicaSet=rs0&readpreference={3}";
string username = "sample-user";
string password = "password";
string clusterEndpoint = "sample-cluster.node.us-east-1.docdb.amazonaws.com:27017";
string readPreference = "secondaryPreferred";
string connectionString = String.Format(template, username, password, clusterEndpoint, readPreference);
var settings = MongoClientSettings.FromUrl(new MongoUrl(connectionString));
var client = new MongoClient(settings);
var database = client.GetDatabase("sampledatabase");
var collection = database.GetCollection("samplecollection");
var docToInsert = new BsonDocument { { "pi", 3.14159 } };
collection.InsertOne(docToInsert);
}
}
}
```
------
#### [ MongoDB Shell ]
次のコードは、TLS が無効化されている場合に、最新バージョンの mongosh、または以前の mongo シェルバージョンを使用して Amazon DocumentDB に接続してクエリする方法を示しています。
**mongosh を使用して Amazon DocumentDB に接続**
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
次の例では*ユーザー入力プレースホルダー*をユーザー自身の情報で置き換えます。
```
mongosh --host cluster-end-point:27017 --username sample-user --password password --retryWrites false
```
**以前の mongo シェルバージョンを使用して Amazon DocumentDB に接続**
IAM を使用する場合は、mongo シェルの以前のバージョンを使用する必要があります。次のコマンドオプションのいずれかを入力します。
```
mongo --host cluster-end-point:27017 --username sample-user --password password
```
4.2 かそれ以降のバージョンの Mongo シェルを使用している場合は、次のコードを使用して接続します。再試行可能な書き込みは Amazon DocumentDB ではサポートされていません。例外: mongo シェル を使用している場合は、どのコード文字列にも `retryWrites=false` コマンドを含めないでください。デフォルトでは、再試行可能な書き込みは無効になっています。`retryWrites=false` を含めると、通常の読み取りコマンドでは失敗する可能性があります。
```
mongo --host cluster-end-point:27017 --username sample-user --password password
```
**接続をテストする**
1. 単一のドキュメントを挿入します。
```
db.myTestCollection.insertOne({'hello':'Amazon DocumentDB'})
```
1. 以前に挿入されたドキュメントを検索します。
```
db.myTestCollection.find({'hello':'Amazon DocumentDB'})
```
------
#### [ R ]
次のコードは、TLS が無効になっているときに mongolite ([https://jeroen.github.io/mongolite/](https://jeroen.github.io/mongolite/)) を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
#Include the mongolite library.
library(mongolite)
#Create a MongoDB client, open a connection to Amazon DocumentDB as a replica
# set and specify the read preference as secondary preferred
client <- mongo(url = "mongodb://sample-user:password@sample-cluster.node.us-east-1.docdb.amazonaws.com:27017/sample-database?readPreference=secondaryPreferred&replicaSet=rs0")
##Insert a single document
str <- c('{"hello" : "Amazon DocumentDB"}')
client$insert(str)
##Find the document that was previously written
client$find()
```
------
#### [ Ruby ]
次のコードは、TLS が無効になっているときに Ruby を使用して Amazon DocumentDB に接続する方法を示しています。
次の例では、各 *ユーザー入力プレースホルダー* をクラスターの情報に置き換えます。
```
require 'mongo'
require 'neatjson'
require 'json'
client_host = 'mongodb://sample-cluster.node.us-east-1.docdb.amazonaws.com:27017'
client_options = {
database: 'test',
replica_set: 'rs0',
read: {:secondary_preferred => 1},
user: 'sample-user',
password: 'password',
retry_writes: false
}
begin
##Create a MongoDB client, open a connection to Amazon DocumentDB as a
## replica set and specify the read preference as secondary preferred
client = Mongo::Client.new(client_host, client_options)
##Insert a single document
x = client[:test].insert_one({"hello":"Amazon DocumentDB"})
##Find the document that was previously written
result = client[:test].find()
#Print the document
result.each do |document|
puts JSON.neat_generate(document)
end
end
#Close the connection
client.close
```
------
# Amazon VPC の外部から Amazon DocumentDB クラスターへの接続
Amazon DocumentDB (MongoDB 互換) クラスターは、Amazon VPC (Amazon Virtual Private Cloud) 内にデプロイされます。それらのクラスターには、同じ Amazon VPC にデプロイされている Amazon EC2 インスタンスや他の AWS のサービスから直接アクセスできます。また、Amazon DocumentDB には、同じ AWS のリージョン内に、あるいは VPC ピアリングを介する別のリージョン内にある異なる VPC の中の EC2 インスタンスや他の AWS リージョン のサービスによってアクセスできます。
ただし、お客様のユースケースで、お客様 (またはお客様のアプリケーション) が、クラスターの VPC の外部から Amazon DocumentDB リソースにアクセスする必要があるとします。その場合は、SSH トンネリング (*ポート転送* とも呼ばれる) を使用して、Amazon DocumentDB リソースにアクセスできます。
SSH トンネリングに関する詳細な説明は、このトピックでは扱いません。SSH トンネリングの詳細については、次のドキュメントを参照してください。
+ [SSH トンネル](https://www.ssh.com/ssh/tunneling/)
+ [SSH ポート転送の例](https://www.ssh.com/ssh/tunneling/example)、特に「[ローカル転送](https://www.ssh.com/ssh/tunneling/example#sec-Local-Forwarding)」セクション
SSH トンネルを作成するには、Amazon DocumentDB クラスターと同じ Amazon VPC で実行中の Amazon EC2 インスタンスが必要です。クラスターと同じ VPC で既存の EC2 インスタンスを使用するか、新しい EC2 インスタンスを作成できます。詳細については、以下でオペレーティングシステムに該当するトピックを参照してください。
+ [Amazon EC2 Linux インスタンスの使用開始](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html)
+ [Amazon EC2 Windows インスタンスの開始方法](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/EC2_GetStarted.html)
通常、以下のコマンドを使用して EC2 インスタンスに接続します。
```
ssh -i "ec2Access.pem" ubuntu@ec2-34-229-221-164.compute-1.amazonaws.com
```
その場合、ローカルコンピュータで以下のコマンドを実行することにより Amazon DocumentDB クラスター`sample-cluster.node.us-east-1.docdb.amazonaws.com` に SSH トンネルを設定できます。ローカルポートの転送を行う場合は、`-L` フラグを使用します。SSH トンネルを使用する場合は、クラスターエンドポイントを使用してクラスターに接続することをお勧めします。レプリカセットモード (接続文字列に `replicaSet=rs0` を指定) で接続するとエラーが発生します。
```
ssh -i "ec2Access.pem" -L 27017:sample-cluster.node.us-east-1.docdb.amazonaws.com:27017 ubuntu@ec2-34-229-221-164.compute-1.amazonaws.com -N
```
SSH トンネルが作成されると、`localhost:27017` に対して発行するすべてのコマンドは、Amazon VPC で実行中の Amazon DocumentDB クラスター `sample-cluster` に転送されます。Amazon DocumentDB クラスターで TLS (Transport Layer Security) が有効になっている場合は、Amazon DocumentDB の[https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem](https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem) パブリックキーをダウンロードする必要があります。次のオペレーションでは、このファイルをダウンロードします。
```
wget https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem
```
**注記**
TLS は、新しい Amazon DocumentDB クラスターに対してデフォルトで有効になっています。ただし、無効にすることは可能です。詳細については、「[Amazon DocumentDB クラスター TLS 設定の管理](security.encryption.ssl.md#security.encryption.ssl.managing)」を参照してください。
Amazon VPC の外部から Amazon DocumentDB クラスターに接続するには、以下のコマンドを使用します。
```
mongo --sslAllowInvalidHostnames --ssl --sslCAFile global-bundle.pem --username --password
```
# レプリカセットとしての Amazon DocumentDB に接続する
Amazon DocumentDB (MongoDB 互換）で開発する場合は、レプリカセットとしてクラスターに接続し、ドライバーに組み込まれている読み取り設定機能を使用してレプリカインスタンスに読み取りを分散することをお勧めします。このセクションでは、その意味についてさらに詳しく説明し、例として SDK for Python を使用して、レプリカセットとして Amazon DocumentDB クラスターに接続する方法について説明します。
Amazon DocumentDB には、クラスターへの接続に使用できる 3 つのエンドポイントがあります。
+ クラスターエンドポイント
+ リーダーエンドポイント
+ インスタンスエンドポイント
ほとんどの場合、Amazon DocumentDB に接続するときは、クラスターエンドポイントを使用することをお勧めします。これは、次の図に示すように、クラスター内のプライマリインスタンスをポイントする CNAME です。
SSH トンネルを使用する場合は、クラスターエンドポイントを使用してクラスターに接続することをお勧めします。レプリカセットモード (接続文字列に `replicaSet=rs0` を指定) で接続するとエラーが発生します。
**注記**
Amazon DocumentDB ウェブサイトのエンドポイントの詳細については、「[Amazon DocumentDB エンドポイント](how-it-works.md#how-it-works.endpoints)」を参照してください。
![\[クラスター、リーダー、インスタンスのエンドポイントを含む Amazon DocumentDB エンドポイントを示す図表。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-endpoint-types.png)
クラスターエンドポイントを使用して、レプリカセットモードでクラスターに接続できます。その後、組み込まれた読み込み設定ドライバー機能を使用できます。次の例では、`/?replicaSet=rs0` を指定することで、レプリカセットとして接続することを SDK を示します。`/?replicaSet=rs0'` を省略すると、クライアントはすべてのリクエストをプライマリインスタンスであるクラスターエンドポイントにルーティングします。
```
## Create a MongoDB client, open a connection to Amazon DocumentDB as a
## replica set and specify the read preference as secondary preferred
client = pymongo.MongoClient('mongodb://:@mycluster.node.us-east-1.docdb.amazonaws.com:27017/?replicaSet=rs0')
```
レプリカセットとして接続する利点は、インスタンスがクラスターに対して追加または削除されるタイミングを含め、SDK がクラスタートポグラフィを自動的に検出できることです。その後、レプリカインスタンスに読み込みリクエストをルーティングすることで、クラスターをより効率的に使用できます。
レプリカセットとして接続するときは、接続の `readPreference` を指定できます。`secondaryPreferred` の読み込み設定を指定した場合、クライアントは（以下の図のように）読み取りクエリをレプリカにルーティングし、書き込みクエリをプライマリインスタンスにルーティングします。これにより、クラスターリソースをより適切に利用できます。詳細については、「[読み込み設定のオプション](how-it-works.md#durability-consistency-isolation)」を参照してください。
```
## Create a MongoDB client, open a connection to Amazon DocumentDB as a
## replica set and specify the read preference as secondary preferred
client = pymongo.MongoClient('mongodb://:@mycluster.node.us-east-1.docdb.amazonaws.com:27017/?replicaSet=rs0&readPreference=secondaryPreferred')
```
![\[Amazon DocumentDB readPreference: secondaryPreferred を示す図表。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-readPreference-secondaryPreferred.png)
Amazon DocumentDBレプリカからの読み込みには結果整合性があります。プライマリに書き込まれたのと同じ順序でデータを返し、50 ミリ秒未満のレプリケーション遅延もよくあります。Amazon CloudWatch メトリクス `DBInstanceReplicaLag` と `DBClusterReplicaLagMaximum` を使用して、クラスターのレプリカラグをモニタリングできます。詳細については、「[Amazon DocumentDB と CloudWatch のモニタリング](cloud_watch.md)」を参照してください。
従来のモノリシックデータベースアーキテクチャとは異なり、Amazon DocumentDB はストレージとコンピューティングを分離します。この最新のアーキテクチャでは、レプリカインスタンスの読み取りのスケールをお勧めします。レプリカインスタンスの読み込みは、プライマリインスタンスからレプリケートされる書き込みをブロックしません。クラスターに最大 15 個のリードレプリカインスタンスを追加し、1 秒あたり数百万回の読み込みにスケールアウトできます。
レプリカセットとして接続し、レプリカに読み取りを分散する主な利点は、アプリケーションの作業に利用できるクラスター内のリソース全体が増加することです。ベストプラクティスとして、レプリカセットとして接続することをお勧めします。さらに、以下のシナリオでは最も一般的にお勧めします。
+ プライマリでほぼ 100% の CPU を使用している。
+ バッファキャッシュヒット率がほぼゼロである。
+ 個別のインスタンスで接続またはカーソルの制限に達する。
クラスターインスタンスサイズのスケールアップは 1 つの選択肢であり、場合によっては、これがクラスターをスケーリングするための最良の方法です。ただし、クラスターにすでに存在するレプリカをより適切に使用する方法も考慮する必要があります。これにより、より大きいインスタンスタイプを使用することでコストが増大することなく、スケールを増加できます。また、CloudWatch アラームを使用してこれらの制限（`CPUUtilization`、`DatabaseConnections`、および `BufferCacheHitRatio`）をモニタリングおよびアラートし、リソースが頻繁に使用されているタイミングを把握することをお勧めします。
詳細については、以下の各トピックを参照してください。
+ [Amazon DocumentDB のベストプラクティス](best_practices.md)
+ [Amazon DocumentDB のクォータと制限事項](limits.md)
## クラスター接続の使用
クラスター内のすべての接続を使用するシナリオを検討します。たとえば、`r5.2xlarge` インスタンスの接続は 4,500 個 (および開いているカーソルは 450 個) に制限されています。3 つのインスタンスの Amazon DocumentDB クラスターを作成し、クラスターエンドポイントを使用してプライマリインスタンスにのみ接続する場合、開いている接続とカーソルのクラスター制限はそれぞれ 4,500 と 450 になります。コンテナでスピンアップする多くのワーカーを使用するアプリケーションを構築する場合、これらの制限に達する可能性があります。コンテナは、一度に多数の接続を開き、クラスターを飽和させます。
代わりに、レプリカセットとして Amazon DocumentDB クラスターに接続し、レプリカインスタンスに読み取りを分散できます。その後、クラスターで使用できる接続とカーソルの数をそれぞれ 13,500 と 1,350 に実質的に 3 倍にできます。クラスターにインスタンスを追加すると、読み取りワークロードの接続とカーソルの数が増えるだけです。クラスターへの書き込みの接続数を増やす必要がある場合は、インスタンスサイズを大きくすることをお勧めします。
**注記**
`large` インスタンス、`xlarge` インスタンス、および `2xlarge` インスタンスの接続数は、インスタンスサイズが最大 4,500 に達するまで増加します。`4xlarge` インスタンス以上の場合、インスタンスあたりの最大接続数は 4,500 です。インスタンスタイプごとの制限の詳細については、「[インスタンス制限](limits.md#limits.instance)」を参照してください。
通常、`secondary` の読み込み設定を使用してクラスターに接続することはお勧めしません。これは、クラスターにレプリカインスタンスがない場合、読み込みが失敗するためです。例えば、1 つのプライマリと 1 つのレプリカを持つ 2 つのインスタンスの Amazon DocumentDB クラスターがあるとします。レプリカに問題がある場合、`secondary` に設定されている接続プールからの読み取りリクエストは失敗します。`secondaryPreferred` の利点は、クライアントが接続する適切なレプリカインスタンスを見つけることができない場合、読み取りのためにプライマリにフォールバックすることです。
## 複数の接続プール
シナリオによっては、アプリケーションの読み取りに、書き込み後読み取り整合性が必要です。これは、Amazon DocumentDB のプライマリインスタンスからのみ提供できます。このようなシナリオでは、2 つのクライアント接続プールを作成できます。1 つは書き込み用、もう 1 つは書き込み後読み込み整合性を必要とする読み込み用です。そのためには、コードは次のようになります。
```
## Create a MongoDB client,
## open a connection to Amazon DocumentDB as a replica set and specify the readPreference as primary
clientPrimary = pymongo.MongoClient('mongodb://:@mycluster.node.us-east-1.docdb.amazonaws.com:27017/?replicaSet=rs0&readPreference=primary')
## Create a MongoDB client,
## open a connection to Amazon DocumentDB as a replica set and specify the readPreference as secondaryPreferred
secondaryPreferred = pymongo.MongoClient('mongodb://:@mycluster.node.us-east-1.docdb.amazonaws.com:27017/?replicaSet=rs0&readPreference=secondaryPreferred')
```
もう 1 つのオプションは、1 つの接続プールを作成し、特定のコレクションの読み込み設定を上書きすることです。
```
##Specify the collection and set the read preference level for that collection
col = db.review.with_options(read_preference=ReadPreference.SECONDARY_PREFERRED)
```
## 概要
クラスター内のリソースを有効に使用するために、レプリカセットモードを使用してクラスターに接続することをお勧めします。アプリケーションに適している場合は、レプリカインスタンスに読み取りを分散することで、アプリケーションの読み取りをスケーリングできます。
# Studio 3T から Amazon DocumentDB クラスターに接続する
[Studio 3T](https://studio3t.com/) は、MongoDB で作業するデベロッパーやデータエンジニアにとって人気のある GUI と IDE です。データのツリー、表、および JSON ビュー、CSV、JSON、SQL および BSON/MongoDump での簡単なインポート/エクスポート、柔軟なクエリオプション、視覚的なドラッグアンドドロップ UI、自動補完機能を備えた組み込みの Mongo シェル、集計パイプラインエディタ、および SQL クエリのサポートを提供しています。
## 前提条件
+ Amazon DocumentDB クラスターで Amazon EC2 を「踏み台ホスト」として利用するシステムをまだ構築していないお客様は、「[Amazon EC2 に接続する](https://docs.aws.amazon.com/documentdb/latest/developerguide/connect-ec2.html)」の手順に従ってください。
+ Studio 3T をお持ちでない場合は、[ダウンロードしてインストールします。](https://studio3t.com/download)
## Studio 3T に接続する
1. ツールバーの左上隅にある **接続** を選択します。
![\[左上隅にウェルカム画面と Connect オプションが強調表示されている Studio 3T インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-connect.png)
1. ツールバーの左上隅にある **新規接続** を選択します。
![\[左上隅に新しい接続オプションが強調表示されている接続マネージャーインターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-newconn.png)
1. **サーバー** タブの **サーバー** フィールドに、クラスターエンドポイント情報を入力します。
![\[サーバー入力フィールドが強調表示されている新しい接続インターフェイスのサーバータブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-endpoint.png)
**注記**
クラスターエンドポイントが見つからない場合。[こちらの](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-endpoint-find.html) ステップに従ってください。
1. **認証** タブを選択し、**認証モード** のドロップダウンメニューで **レガシー** を選択します。
![\[レガシー認証モードが選択され、ユーザー名、パスワード、認証 DB 情報が提供された新しい接続インターフェイスの認証タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-auth.png)
1. **ユーザー名** フィールドと **パスワード** フィールドにユーザーネームと資格情報を入力します。
1. **SSL** タブを選択し、**SSLプロトコルを使用して接続する** チェックボックスをオンにします。
![\[[SSL プロトコルを使用して接続する] が選択された新しい接続インターフェイスの SSL タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-ssl.png)
1. **独自のルート CA ファイルを使用する** を選択します。次に、Amazon DocumentDB 証明書を追加します (DocumentDB クラスターで SSL が無効になっている場合は、このステップをスキップできます)。**無効なホスト名** を許可するには、チェックボックスをオンにします。
![\[ルート CA ファイルが入力され、[無効なホスト名を許可する] が選択された新しい接続インターフェイスの SSL タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-ssl.png)
**注記**
証明書を持っていない場合。次のコマンドでダウンロードできます。
`wget https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem `
1. Amazon VPC 外のクライアントマシンから接続する場合は、SSH トンネルを作成する必要があります。**SSH** タブでこれを行います。
1. **SSHトンネルを使用する** のチェックボックスをオンにして、**SSHアドレス** フィールドに SSH アドレスを入力します。これはインスタンスの公開 DNS (IPV4) です。この URL は [Amazon EC2 マネジメントコンソール](https://console.aws.amazon.com/ec2) から取得できます。
1. ユーザーネームを入力します。これは Amazon EC2 インスタンスのユーザーネームです。
1. **SSH 認証モード**で、**プライベートキー** を選択します。**プライベートキー** フィールドで、ファイルファインダーアイコンを選択し、Amazon EC2 インスタンスのプライベートキーを選択します。これは、Amazon EC2 コンソールでインスタンスを作成するときに保存した.pem ファイル（キーペア）です。
1. Linux/macOS クライアントマシンを使用している場合は、次のコマンドを使用してプライベートキーの許可を変更する必要があることがあります。
`chmod 400 /fullPathToYourPemFile/.pem`
![\[SSH トンネル認証情報が入力された新しい接続インターフェイスの SSH タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-ssh.png)
**注記**
この Amazon EC2 インスタンスは、DocumentDB クラスターと同じ Amazon VPC およびセキュリティグループ内に存在する必要があります。SSH アドレス、ユーザーネーム、プライベートキーは、[Amazon EC2 マネジメントコンソール](https://console.aws.amazon.com/ec2) から取得できます。
1. 次に **接続のテスト** ボタンを選択して構成をテストします。
![\[左下隅に [接続のテスト] ボタンが強調表示されている新しい接続インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-testbutton.png)
1. 診断ウィンドウには、テストが成功したことを示す緑色のバーがロードされます。次に **OK** を選択して、診断ウィンドウを閉じます。
![\[接続テストが成功した後に表示される診断ウィンドウ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-testconn.png)
1. **保存** を選択して、将来使用するために接続を保存します。
![\[[保存] ボタンが強調表示されている新しい接続インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-save.png)
1. 次にクラスターを選択し、**接続** を選択します。
![\[[接続] ボタンが強調表示されている [接続マネージャー] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/studio3t/studio3t-finalconnect.png)
お疲れ様でした。Studio 3T を介して Amazon DocumentDB クラスターに正常に接続されました。
# DataGrip を使用して Amazon DocumentDB に接続する
[DataGrip](https://www.jetbrains.com/help/datagrip/documentdb.html) は、Amazon DocumentDB を含むさまざまなデータベースシステムをサポートする強力な統合開発環境 (IDE) です。このセクションでは、DataGrip を使用して Amazon DocumentDB クラスターに接続する手順を説明します。これにより、グラフィカルインターフェイスを使用してデータを簡単に管理およびクエリできます。
## 前提条件
+ DataGrip IDE がマシンにインストールされています。[JetBrains](https://www.jetbrains.com/datagrip/download/#section=windows) からダウンロードできます。
+ Amazon DocumentDB クラスターと同じ VPC で実行中の Amazon EC2 インスタンス。このインスタンスを使用して、ローカルマシンから Amazon DocumentDBCluster までの安全なトンネルを確立します。[Amazon EC2 を使用した接続](connect-ec2.md) 方法に関する指示に従ってください。
+ Amazon EC2 インスタンス、VPN 接続の代替、または安全な VPN AWS を使用してインフラストラクチャに既にアクセスしている場合。このオプションを希望する場合は、指示に従って AWS Client VPN を使用して [Amazon DocumentDB に安全にアクセスしてください](https://aws.amazon.com/blogs/database/securely-access-amazon-documentdb-with-mongodb-compatibility-locally-using-aws-client-vpn/)。
## DataGrip を使用して接続する
1. コンピューターで DataGrip を起動し、**[新しいプロジェクト]**を作成します。
![\[新しいプロジェクトオプションが強調表示された DataGrip ウェルカム画面。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/welcome.png)
1. 以下のいずれかの方法を使用して、新しいデータソースを追加します。
1. メインメニューから** [ファイル]-[新規]-[データソース]** に移動し、**[DocumentDB]** を選択します。
1. **[データベースエクスプローラー]**で、ツールバーの新規アイコン (**\$1**) をクリックします。**[データソース]** に移動し、**[DocumentDB]** を選択します。
![\[+ のドロップダウンリストには、データソースサブメニューが表示されます。DocumentDB はそのサブメニューから選択されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/explorer.png)
1. **[全般]** タブの **[データソース]** ページで、接続設定領域の下部に **[見つからないドライバファイルのダウンロード]** リンクがあるかどうかを確認します。このリンクをクリックして、データベースとの通信に必要なドライバーをダウンロードします。直接ダウンロードリンクについては、[JetBrains JDBC ドライバー](https://www.jetbrains.com/datagrip/jdbc-drivers/)を参照してください。
![\[欠落しているドライバーファイルのリンクが強調表示されたデータソースとドライバーインターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/missing-driver.png)
1. **[一般]** タブで、接続の詳細を指定します。
1. **[ホスト]** フィールドで、Amazon DocumentDB クラスターエンドポイントを指定します。
1. **[ポート]** は既に 27017 に設定されています。クラスターが別のポートにデプロイされている場合は変更してください。
1. **[認証]** で、**[ユーザーとパスワード]** を選択します。
1. 自分のユーザー名とパスワードを入力します。
1. **[データベース]** フィールドはオプションです。接続先のデータベースを指定できます。
1. 上記の詳細を追加すると、**[URL]** フィールドが自動補完されます。
![\[データソースとドライバーインターフェイスの全般タブのホスト、ポート、認証、データベース、URL フィールド。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/connection.png)
1. **[SSH/SSL]** タブで **[SSH トンネルを使用する]** を有効にし、アイコンをクリックして **[SSH 設定]** ダイアログを開きます。次の情報を入力します。
1. **[ホスト]** フィールドに、Amazon EC2 インスタンスのホスト名を入力します。
1. Amazon EC2 インスタンスのユーザーネームとパスワードを入力します。
1. **[認証タイプ]** で、**[キーペア]** を選択します。
1. **[プライベートキーファイル]** を入力します。
**注記**
VPN オプションを使用している場合は、SSH トンネルを設定する必要はありません。
![\[[SSH トンネルの使用] が選択され、SSH 設定アイコンが強調表示されているデータソースとドライバーインターフェイスの SSH/SSL タブ。アイコンをクリックすると、表示された SSH 設定インターフェイスが開きます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ssh-tunnel.png)
1. **[SSH/SSL]** タブで、**[SSL を使用する]** を有効にします。**[CA ファイル]** フィールドに、`global-bundle.pem` コンピューター上のファイルの場所を入力します。**[モード]** は **[必須]** オプションのままにしておきます。
**注記**
証明書は次の場所からダウンロードするか、wget[https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem](https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem) コマンドを使用してダウンロードできます。
**注記**
Amazon DocumentDB エラスティッククラスターに接続する場合、CA ファイルを指定する必要はありません。**[SSLを使用する]** オプションはオンのままにして、他のすべてのオプションはデフォルト値のままにします。
![\[SSL 設定が有効になっているデータソースとドライバーインターフェイスの SSH/SSL タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/use-ssl.png)
1. **[スキーマ]** タブの **[すべてのデータベース]** を選択するか、**[スキーマパターン]** フィールドに「\$1: \$1」というフィルターを入力します。**[接続テスト]** リンクをクリックして接続をテストします。
![\[すべてのデータベースオプションが選択されているデータソースとドライバーインターフェイスのスキーマタブ。テスト接続リンクの上に成功メッセージが表示されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/schemas.png)
1. 接続が正常にテストされたら、**[OK]** をクリックしてデータソース設定を保存します。
## DataGrip の機能
DataGrip には Amazon DocumentDB を使用して効率的に作業するためのさまざまな機能が用意されています。
+ **SQL エディター** — DataGrip の SQL エディターを使用してDocumentDB コレクションに SQL のようなクエリを記述して実行します。
+ **ビジュアルクエリビルダー** — ビジュアルクエリビルダーを使用すると、SQL コードを記述せずにグラフィカルにクエリを作成できます。
+ **スキーマ・マネジメント** — コレクションの作成、変更、削除など、データベーススキーマを簡単に管理できます。
+ **データ・ビジュアライゼーション** — DataGrip のさまざまな視覚化ツールを使用して、データを表示および分析します。
+ **データのエクスポートとインポート** — DataGrip のエクスポートおよびインポート機能を使用して、Amazon DocumentDB と他のデータベース間でデータを転送します。
Amazon DocumentDB やその他のデータベースシステムの操作に関するより高度な機能やヒントについては、公式 [DataGrip ドキュメント](https://www.jetbrains.com/datagrip/features/)を参照してください。
# Amazon EC2 を使用した接続
このセクションでは、Amazon DocumentDB クラスターと Amazon EC2 間の接続を設定し、Amazon EC2 インスタンスから Amazon DocumentDB クラスターにアクセスする方法について説明します。
EC2 接続を設定する方法は複数あります。
+ [EC2 インスタンスを Amazon DocumentDB データベースに自動的に接続する](connect-ec2-auto.md) — EC2 コンソールの自動接続機能を使用して、EC2 インスタンスと新規または既存の Amazon DocumentDB データベース間の接続を自動で設定できます。この接続により、EC2 インスタンスと Amazon DocumentDB データベース間でやり取りされるトラフィックを確立できます。このオプションは通常、新しいセキュリティグループのテストと作成に使用されます。
+ [EC2 インスタンスを Amazon DocumentDB データベースに手動で接続する](connect-ec2-manual.md) — 自動接続機能によって作成されるのと同じ設定を再現することにより、セキュリティグループを手動で設定して割り当て、EC2 インスタンスと Amazon DocumentDB データベース間の接続を設定できます。このオプションは、通常、高度な設定を変更したり、既存のセキュリティグループを使用するために使用されます。
## 前提条件
いずれのオプションを使用する場合でも、最初の Amazon DocumentDB クラスターを作成する前に、以下の操作を行う必要があります。
**Amazon Web Services (AWS) アカウントを作成する**
Amazon DocumentDB を使用する前に、Amazon Web Services (AWS) アカウントを持っている必要があります。 AWS アカウントは無料です。使用しているサービスとリソースに対してのみ料金をお支払いいただきます。
がない場合は AWS アカウント、次の手順を実行して作成します。
**にサインアップするには AWS アカウント**
1. [https://portal.aws.amazon.com/billing/signup](https://portal.aws.amazon.com/billing/signup) を開きます。
1. オンラインの手順に従います。
サインアップ手順の一環として、電話またはテキストメッセージを受け取り、電話キーパッドで検証コードを入力します。
にサインアップすると AWS アカウント、 *AWS アカウントのルートユーザー* が作成されます。ルートユーザーには、アカウントのすべての AWS のサービス とリソースへのアクセス権があります。セキュリティベストプラクティスとして、ユーザーに管理アクセス権を割り当て、[ルートユーザーアクセスが必要なタスク](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks)の実行にはルートユーザーのみを使用するようにしてください。
**必要に応じて、必要な AWS Identity and Access Management (IAM) アクセス許可を設定します。**
クラスター、インスタンス、クラスターパラメータグループなどの Amazon DocumentDB リソースを管理するには、 がリクエストの認証 AWS に使用できる認証情報が必要です。詳細については、「[Amazon DocumentDB の Identity and Access Management](security-iam.md)」を参照してください。
1. の検索バーで AWS マネジメントコンソール、IAM と入力し、表示されるドロップダウンメニューで **IAM** を選択します。
1. IAM コンソールにアクセスしたら、ナビゲーションペインから [**ユーザー**] を選択します。
1. ユーザーネームを選択します。
1. [**アクセス許可の追加**] ボタンをクリックします。
1. [**Attach existing policies directly ( 既存のポリシーを直接アタッチ )**] を選択します。
1. 検索バーに `AmazonDocDBFullAccess` と入力し、検索結果に表示されたら、それを選択します。
1. [**Next: レビュー**] と表示されている青いボタンをクリックします。
1. [**アクセス許可の追加**] となっている下の青いボタンをクリックします。
**Amazon VPC (Amazon Virtual Private Cloud) を作成する**
どの AWS リージョン にあるかによって、デフォルトの VPC が既に作成されているかどうかがわかります。デフォルトの VPC がない場合は、[Amazon VPC のユーザーガイド](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-getting-started.html) の *Amazon VPC の開始方法* のステップ 1 を完了させます。これには 5 分もかかりません。
# Amazon EC2 への自動接続
**Topics**
+ [EC2 インスタンスを新しい Amazon DocumentDB データベースに自動接続する](#auto-connect-ec2.process)
+ [EC2 インスタンスを既存の Amazon DocumentDB データベースに自動的に接続する](#auto-connect-ec2-existing-cluster)
+ [EC2 インスタンスとの自動接続の概要](#auto-connect-ec2.overview)
+ [接続中のコンピューティングリソースを表示する](#auto-connect-ec2.compute)
EC2 インスタンスと新しい Amazon DocumentDB データベース間の接続を設定する前に、「[EC2 インスタンスとの自動接続の概要](#auto-connect-ec2.overview)」に記載される要件を満たしているか確認してください。接続の設定後にこれらのセキュリティグループに変更を加えると、EC2 インスタンスと Amazon DocumentDB データベース間の接続に影響を及ぼす可能性があります。
**注記**
AWS マネジメントコンソールを使用することでのみ、EC2 インスタンスと Amazon DocumentDB データベース間の接続を自動的に設定できます。 AWS CLI または Amazon DocumentDB API を使用して接続を自動的にセットアップすることはできません。
## EC2 インスタンスを新しい Amazon DocumentDB データベースに自動接続する
以下のプロセスは、[前提条件](connect-ec2.md#connect-ec2-prerequisites) トピック記載のステップが完了済みであることを前提としています。
**Topics**
+ [ステップ 1: Amazon EC2 インスタンスを作成する](#auto-connect-ec2.launch-ec2-instance)
+ [ステップ 2: Amazon DocumentDB クラスターを作成する](#auto-connect-ec2.launch-cluster)
+ [ステップ 3: Amazon EC2 インスタンスに接続する](#manual-connect-ec2.connect)
+ [ステップ 4: MongoDB シェルをインストールする](#auto-connect-ec2.install-mongo-shell)
+ [ステップ 5: Amazon DocumentDB TLS の管理](#auto-connect-ec2.tls)
+ [ステップ 6: Amazon DocumentDB クラスターに接続する](#auto-connect-ec2.connect-use)
+ [ステップ 7: データの挿入とクエリ](#auto-cloud9-insert-query)
+ [ステップ 8: 使ってみる](#auto-connect-ec2.explore)
### ステップ 1: Amazon EC2 インスタンスを作成する
このステップでは、後で Amazon DocumentDB クラスターのプロビジョニングに使用するのと同じリージョンと Amazon VPC に Amazon EC2 インスタンスを作成します。
1. Amazon EC2 コンソールで、[**インスタンスを起動**] を選択します。
![\[Amazon EC2 コンソールの [インスタンスを起動] セクション。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/launch-instance.png)
1. **[名前とタグ]** セクション内の **[名前]** フィールドに、名前または識別子を入力します。
1. **[Amazon マシンイメージ (AMI)]** ドロップダウンリストで、**[Amazon Linux 2 AMI]** を選択します。
![\[Amazon Linux 2 AMI オプションが [クイックスタート] セクションで選択された [アプリケーションおよび OS イメージ] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/linux2-ami.png)
1. **[インスタンスタイプ]** のドロップダウンリストで、**[t3.micro]** を選択します。
1. **[キーペア (ログイン)]** セクションで、既存のキーペアの識別子を入力するか、もしくは **[新しいキーペアの作成]** を選択します。
![\[キーペア名フィールドと新しいキーペアの作成オプションを示す [キーペア] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/key-pair.png)
Amazon EC2 キーペアを指定する必要があります。
+ Amazon EC2 のキーペアがある場合 :
1. キーペアを選択し、リストからご自身のキーペアを選択します。
1. Amazon EC2 インスタンスにログインするには、あからじめプライベートキーファイル (.pem もしくは.ppk ファイル) を利用可能にしておく必要があります。
+ Amazon EC2 のキーペアがない場合:
1. **[新しいキーペアの作成]** を選択すると、**[キーペアの作成]** ダイアログボックスが表示されます。
1. **[キーペア名]** フィールドに名前を入力します。
1. **[キーペアタイプ]** と **[プライベートキーファイル形式]** を選択します。
1. [**キーペアの作成**] を選択してください。
![\[キーペア名、タイプ、ファイル形式がある [キーペアの作成] インターフェイス。[キーペアの作成] ボタンは右下隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/create-key-pair.png)
**注記**
セキュリティ上の理由から、SSH とインターネット両方からの EC2 インスタンスへの接続にキーペアを使用することを強くお勧めします。
1. **オプション:** **ネットワーク設定セクション** の **ファイアウォール (セキュリティグループ)** で、[**セキュリティグループの作成**] を選択します。
![\[セキュリティグループを作成するためのオプションを示す [ネットワーク設定] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/firewall.png)
**[セキュリティグループの作成]** を選択します (EC2 接続に適用されるすべてのトラフィック許可ルールを確認します)。
**注記**
既存のセキュリティグループを使用する場合は、「[Amazon EC2 を手動で接続する](connect-ec2-manual.md)」の手順に従います。
1. **[概要]** セクションで、EC2 設定を確認し、問題がなければ **[インスタンスを起動]** を選択します。
### ステップ 2: Amazon DocumentDB クラスターを作成する
Amazon EC2 インスタンスのプロビジョニング中は、Amazon DocumentDB クラスターを作成します。
1. Amazon DocumentDB コンソールに移動し、ナビゲーションペインから **クラスター** を選択します。
1. **[作成]** を選択します。
1. **[クラスタータイプ]** 設定は、デフォルトの **[インスタンスベースのクラスター]** のままにしておきます。
1. **[クラスター設定]** では、一意の **[クラスター名]** を入力します。コンソール操作では、入力方法に関係なくクラスター名のすべての文字が小文字に変換されることにご留意ください。
**[エンジンバージョン]** はデフォルト値の **5.0.0** のままにします。
1. **[クラスターストレージ設定]** では、**Amazon DocumentDB Standard** のデフォルト設定のままにします。
1. **[インスタンスの設定]** で:
+ **[DB インスタンスクラス]** では、**メモリ最適化クラス (r クラスを含む) ** を選択します (デフォルト）。
もう 1 つのインスタンスオプションは **NVMe-backed クラス** です。詳細については [NVMe-backed インスタンス](db-instance-nvme.md) を参照してください。
+ **[インスタンスクラス]** では、ニーズに合ったインスタンスタイプを選択します。インスタンスクラスの詳細については、「[インスタンスクラスの仕様](db-instance-classes.md#db-instance-class-specs)」を参照してください。
+ **[インスタンスの数]** では、ニーズを最も反映する数を選択します。数値が低いほど、コストが低くなり、クラスターで管理できる読み取り/書き込みボリュームが低くなることに注意してください。
![\[インスタンス数が 1 に設定されている、クラスター識別子、エンジンバージョン、およびインスタンスクラスのデフォルト値がある設定インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-cluster/instance-config.png)
1. **[接続]** で、**[EC2 コンピューティングリソースに接続する]** を選択します。これは、ステップ 1 で作成した EC2 インスタンスです。
![\[選択した EC2 コンピューティングリソースへの接続オプションがある接続インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2-connect.png)
**注記**
EC2 コンピューティングリソースに接続すると、Amazon DocumentDB クラスターへの EC2 コンピューティングリソース接続向けセキュリティグループが自動的に作成されます。クラスターの作成完了後、新しく作成したセキュリティグループを確認したい場合は、クラスターリストに移動して該当するクラスター識別子を選択します。**[接続とセキュリティ]** タブ内で **[セキュリティグループ]** に移動して、**[セキュリティグループ名 (ID)]** で見たいグループを見つけます。クラスターの名前と `docdb-ec2-docdb-2023-12-11-21-33-41:i-0e4bb09985d2bbc4c (sg-0238e0b0bf0f73877)` のような内容が表示されます。
1. **[認証]** セクションで、プライマリユーザーのユーザー名を入力し、**[セルフマネージド]** を選択します。パスワードを入力して確認します。
代わりに **Managed in AWS Secrets Manager** を選択した場合、詳細については[Amazon DocumentDB と によるパスワード管理 AWS Secrets Manager](docdb-secrets-manager.md)「」を参照してください。
1. **[クラスターを作成]** を選択します。
### ステップ 3: Amazon EC2 インスタンスに接続する
Mongo Shell をインストールするには、まず Amazon EC2 インスタンスに接続する必要があります。Mongo シェルをインストールすると、Amazon DocumentDB クラスターに接続してクエリを実行できます。以下のステップを実行します。
1. Amazon EC2 コンソールで、インスタンスに移動し、作成したインスタンスが実行中かどうかを確認します。実行されている場合は、インスタンス ID をクリックしてインスタンスを選択します。
![\[Amazon EC2 コンソールで 2 つのインスタンスを一覧表示するインスタンステーブル。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/ec2-instance-table.png)
1. **接続** を選択します。
![\[Amazon EC2 インスタンスのインスタンス概要。[接続] ボタンは右上隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/ec2-instance-summary.png)
1. 接続方法として、Amazon EC2 Instance Connect、セッションマネージャー、SSH クライアント、EC2 シリアルコンソールの 4 つのオプションがタブ形式で表示されます。いずれかを選択し、その指示に従わなければなりません。完了したら、**[接続する]** を選択します。
![\[EC2 Instance Connect の接続方法の設定オプションを示すインターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/connect-options.png)
**注記**
このチュートリアルの開始後に IP アドレスが変更された場合、または後で環境に戻る場合は、`demoEC2` セキュリティグループのインバウンドルールを更新して、新しい API アドレスからのインバウンドトラフィックを有効化します。
### ステップ 4: MongoDB シェルをインストールする
これで、MongoDB シェルをインストールできます。これは、Amazon DocumentDB クラスターに接続してクエリするために使用するコマンドラインのユーティリティです。現在、MongoDB シェルには最新バージョンの mongosh と以前のバージョンの mongo シェルの 2 つのバージョンがあります。
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
以下の手順に従って、オペレーションシステム用の MongoDB シェルをインストールします。
------
#### [ On Amazon Linux ]
**Amazon Linux で MongoDB シェルをインストールするには**
IAM 認証を使用して*おらず*、最新の MongoDB シェル (mongosh) を使用して Amazon DocumentDB クラスターに接続する場合は、次の手順に従います。
1. リポジトリファイルを作成します。作成した EC2 インスタンスのコマンドラインで、次のコマンドを入力します。
```
echo -e "[mongodb-org-5.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/5.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://pgp.mongodb.com/server-5.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-5.0.repo
```
1. 完了したら、コマンドプロンプトで次の 2 つのコマンドオプションのいずれかを使用して mongosh をインストールします。
**オプション 1** — Amazon EC2 の設定中にデフォルトの Amazon Linux 2023 を選択した場合は、次のコマンドを入力します。
```
sudo yum install -y mongodb-mongosh-shared-openssl3
```
**オプション 2** — Amazon EC2 の設定中に Amazon Linux 2 を選択した場合は、次のコマンドを入力します。
```
sudo yum install -y mongodb-mongosh
```
IAM 認証を使用している場合は、以前のバージョンの MongoDB シェル (5.0) を使用して Amazon DocumentDB クラスターに接続する必要があり、次の手順を実行します。
1. リポジトリファイルを作成します。作成した EC2 インスタンスのコマンドラインで、次のコマンドを入力します。
```
echo -e "[mongodb-org-5.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/5.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://pgp.mongodb.com/server-5.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-5.0.repo
```
1. 完了したら、コマンドプロンプトで次のコマンドオプションを使用して mongodb 5.0 シェルをインストールします。
```
sudo yum install -y mongodb-org-shell
```
------
#### [ On Ubuntu ]
**Ubuntu に mongosh をインストールするには**
1. パッケージ管理システムで使用されるパブリックキーをインポートします。
```
curl -fsSL https://pgp.mongodb.com/server-5.0.asc | sudo gpg --dearmor -o /usr/share/keyrings/mongodb-server-5.0.gpg
```
1. Ubuntu のバージョンに適切なコマンドを使用して、MongoDB の リストファイル `mongodb-org-5.0.list` を作成します。
```
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-5.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
```
1. 次のコマンドを使用してローカルパッケージデータベースをインポートして更新します。
```
sudo apt-get update
```
1. mongosh をインストールします。
```
sudo apt-get install -y mongodb-mongosh
```
以前のバージョンの MongoDB の Ubuntu システムへのインストールについては、「 [Install MongoDB Community Edition on Ubuntu](https://docs.mongodb.com/v3.6/tutorial/install-mongodb-on-ubuntu/) 」を参照してください。
------
#### [ On other operating systems ]
mongo シェルを他のオペレーティングシステムにインストールするには、MongoDB ドキュメントの「 [MongoDB Community Edition のインストール](https://www.mongodb.com/docs/manual/administration/install-community/) 」を参照してください。
------
### ステップ 5: Amazon DocumentDB TLS の管理
次のコード `wget https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem` を使用して Amazon DocumentDB の CA 証明書をダウンロードします。
**注記**
全ての新しい Amazon DocumentDB クラスターに対して、デフォルトで Transport Layer Security (TLS) が有効になっています。詳細については、「[Amazon DocumentDB クラスター TLS 設定の管理](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)」を参照してください。
### ステップ 6: Amazon DocumentDB クラスターに接続する
1. Amazon DocumentDB コンソールの **[クラスター]** で、接続したいクラスターを見つけます。そのクラスターの **[クラスター識別子]** をクリックして、作成済みのクラスターを選択します。
1. **[接続とセキュリティ]** タブの **[接続する]** ボックス内で、**[mongo シェルを使用してこのクラスターに接続する]** を見つけます。
![\[Mongo シェルを使用して Amazon DocumentDB クラスターに接続するための Amazon DocumentDB 接続文字列が強調表示されたクラスター接続設定。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/connect-mongosh.png)
表示された接続文字列をコピーし、ターミナルに貼り付けます。
これに以下の変更を加えます。
1. 文字列に正しいユーザー名が含まれているのを確認してください。
1. `` は省略します。これにより、接続時に mongo シェルによりパスワードの入力を求められます。
1. オプション: IAM 認証を使用している場合、または以前のバージョンの MongoDB シェルを使用している場合は、次のように接続文字列を変更します。
`mongo --ssl --host mydocdbcluster.cluster-cozt4xr9xv9b.us-east-1.docdb.amazonaws.com:27017 --sslCAFile global-bundle.pem --username SampleUser1 --password`
`mydocdbcluster.cluster-cozt4xr9xv9b.us-east-1` をクラスターの同じ情報に置き換えます。
1. ターミナル上で Enter キーを押します。ここで、パスワードの入力を求められます。パスワードを入力します。
1. パスワードを入力し、`rs0 [direct: primary] >` プロンプトが表示されたら、Amazon DocumentDB クラスターに正常に接続されています。
接続に問題がありますか。[Amazon DocumentDB のトラブルシューティング](https://docs.aws.amazon.com/documentdb/latest/developerguide/troubleshooting.html) を参照してください。
### ステップ 7: データの挿入とクエリ
クラスターに接続できたので、いくつかのクエリを実行して、ドキュメントデータベースの使用に慣れることができます。
1. 1 つのドキュメントを挿入するには、次のように入力します。
```
db.collection.insertOne({"hello":"DocumentDB"})
```
次の出力が返ります。
```
{
acknowledged: true,
insertedId: ObjectId('673657216bdf6258466b128c')
}
```
1. `findOne()` コマンドで書き込んだドキュメントを読み取ることができます (一つのドキュメントしか返さないため)。以下を入力します。
```
db.collection.findOne()
```
次の出力が返ります。
```
{ "_id" : ObjectId("5e401fe56056fda7321fbd67"), "hello" : "DocumentDB" }
```
1. さらにいくつかのクエリを実行するには、ゲームプロファイルのユースケースを検討してください。まず、「`profiles`」というタイトルのコレクションにエントリをいくつか挿入します。以下を入力します。
```
db.profiles.insertMany([{ _id: 1, name: 'Matt', status: 'active', level: 12, score: 202 },
{ _id: 2, name: 'Frank', status: 'inactive', level: 2, score: 9 },
{ _id: 3, name: 'Karen', status: 'active', level: 7, score: 87 },
{ _id: 4, name: 'Katie', status: 'active', level: 3, score: 27 }
])
```
次の出力が返ります。
```
{ acknowledged: true, insertedIds: { '0': 1, '1': 2, '2': 3, '3': 4 } }
```
1. `find()` コマンドを使用して、プロファイルコレクション内のすべてのドキュメントを返します。以下を入力します。
```
db.profiles.find()
```
ステップ 3 で入力したデータと一致する出力を取得します。
1. フィルターを使用して 1 つのドキュメントに対して1つのクエリを使用します。以下を入力します。
```
db.profiles.find({name: "Katie"})
```
次の出力が返ります。
```
{ "_id" : 4, "name" : "Katie", "status": "active", "level": 3, "score":27}
```
1. それでは、プロファイルを探して、それを `findAndModify` コマンドで変更してみましょう。次のコードを使用して、ユーザー Matt に 10 ポイント追加します。
```
db.profiles.findAndModify({
query: { name: "Matt", status: "active"},
update: { $inc: { score: 10 } }
})
```
次のような出力が得られます (Mattのスコアはまだ上がっていないことに注意してください) 。
```
{
[{_id : 1, name : 'Matt', status: 'active', level: 12, score: 202}]
```
1. 次のクエリを使用して、Matt のスコアが変更されたことを確認できます。
`db.profiles.find({name: "Matt"})`
次の出力が返ります。
```
{ "_id" : 1, "name" : "Matt", "status" : "active", "level" : 12, "score" : 212 }
```
### ステップ 8: 使ってみる
お疲れ様でした。Amazon DocumentDB のクイックスタートガイドを正常に完了しました。
次のステップ この強力なデータベースを一般的な特徴をいくつか使って十分に活用する方法を学びましょう。
+ [Amazon DocumentDB の管理](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-documentdb.html)
+ [スケーリング](https://docs.aws.amazon.com/documentdb/latest/developerguide/operational_tasks.html)
+ [バックアップと復元](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup_restore.html)
**注記**
コストを節約するために、Amazon DocumentDB クラスターを停止してコストを削減するか、クラスターを削除することができます。デフォルトでは、30 分間非アクティブになると、 AWS Cloud9 環境は基盤となる Amazon EC2 インスタンスを停止します。
## EC2 インスタンスを既存の Amazon DocumentDB データベースに自動的に接続する
次の手順では、既存の Amazon DocumentDB クラスターと既存の Amazon EC2 インスタンスを利用できることを前提としています。
**Amazon DocumentDB クラスターにアクセスし、Amazon EC2 接続をセットアップする**
1. Amazon DocumentDB クラスターにアクセスします。
1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで **クラスター** を選択します。
**ヒント**
画面の左側にナビゲーションペインが表示されない場合は、ページの左上隅にあるメニューアイコン (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/docdb-menu-icon.png)) を選択します。
1. クラスター名の左側にあるボタンを選択して、アクセスしたいクラスターを指定します。
1. Amazon EC2 接続を設定します。
1. **[アクション]** をクリックし、**[EC2 接続の設定]** をクリックします。
![\[[EC2 接続のセットアップ] オプションが選択された [アクション] ドロップダウンリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/setup-ec2-connect.png)
**[EC2 接続の設定]** ダイアログが開きます。
1. **[EC2 インスタンス]** フィールドで、クラスターに接続する EC2 インスタンスを選択します。
![\[[EC2 インスタンス] ドロップダウンリストが強調表示された [EC2 接続のセットアップ] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/setup-ec2-connect-dialog.png)
1. [**続行**] をクリックしてください。
**[確認と確定]** ダイアログページが表示されます。
1. 変更内容が正しいことを確認します。続いて、**[接続の設定]** を選択します。
![\[変更の概要を示す [確認と確定] インターフェイス。[接続の設定] ボタンは右下隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/setup-ec2-review-confirm.png)
正常に接続が設定されると、以下の検証結果が表示されます。
![\[Amazon DocumentDB データベースと EC2 インスタンス間の接続設定が成功したことの確認メッセージ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/setup-ec2-connect-success.png)
## EC2 インスタンスとの自動接続の概要
EC2 インスタンスと Amazon DocumentDB データベース間の接続を設定すると、Amazon DocumentDB ではその EC2 インスタンスと Amazon DocumentDB データベース向けの VPC セキュリティグループを自動的に設定します。
EC2 インスタンスと Amazon DocumentDB データベースを接続するための要件は次のとおりです。
+ EC2 インスタンスは、Amazon DocumentDB データベースと同じ VPC 内に存在する必要があります。
同じ VPC に EC2 インスタンスが存在しない場合、コンソールには EC2 インスタンス作成用のリンクが表示されます。
+ 接続を設定するユーザーには、以下の Amazon EC2 オペレーションを実行するアクセス許可が必要です。
+ `ec2:AuthorizeSecurityGroupEgress`
+ `ec2:AuthorizeSecurityGroupIngress`
+ `ec2:CreateSecurityGroup`
+ `ec2:DescribeInstances`
+ `ec2:DescribeNetworkInterfaces`
+ `ec2:DescribeSecurityGroups`
+ `ec2:ModifyNetworkInterfaceAttribute`
+ `ec2:RevokeSecurityGroupEgress`
DB インスタンスと EC2 インスタンスが異なるアベイラビリティーゾーンにある場合、アベイラビリティーゾーン間のコストが発生する可能性があります。
EC2 インスタンスへの接続を設定すると、Amazon DocumentDB は、次の表に示すように、その Amazon DocumentDB データベースと EC2 インスタンスに関連付けられているセキュリティグループの現在の設定に従って動作します。
| 現在の Amazon DocumentDB セキュリティグループ設定 | 現在の EC2 セキュリティグループの設定 | Amazon DocumentDB の動作 |
| --- | --- | --- |
| パターン DocumentDB-ec2-n に一致する名前をもつ Amazon DocumentDB データベースに関連付けられたセキュリティグループが 1 つ以上存在します。パターンに一致するセキュリティグループは変更されていません。このセキュリティグループには、EC2 インスタンスの VPC セキュリティグループをソースとするインバウンドルールが 1 つのみ存在します。 | パターン DocumentDB-ec2-n (n は数字) に一致する名前の EC2 インスタンスに関連付けられたセキュリティグループが 1 つ以上存在します。パターンに一致するセキュリティグループは変更されていません。このセキュリティグループには、Amazon DocumentDB データベースの VPC セキュリティグループをソースとするアウトバウンドルールが 1 つのみ存在します。 | Amazon DocumentDB はアクションを実行しません。EC2 インスタンスと Amazon DocumentDB データベース間の接続は、既に自動で設定されています。EC2 インスタンスと Amazon DocumentDB データベース間には既に接続が存在するため、セキュリティグループの変更は行われません。 |
| 次の条件のいずれかが適用されます。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/connect-ec2-auto.html) | 次の条件のいずれかが適用されます。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/connect-ec2-auto.html) | Amazon DocumentDB アクション: 新しいセキュリティグループを作成する |
| パターン DocumentDB-ec2-n に一致する名前をもつ Amazon DocumentDB データベースに関連付けられたセキュリティグループが 1 つ以上存在します。パターンに一致するセキュリティグループは変更されていません。このセキュリティグループには、EC2 インスタンスの VPC セキュリティグループをソースとするインバウンドルールが 1 つのみ存在します。 | EC2 インスタンスに関連付けられた、パターン ec2-DocumentDB-n に一致する名前のセキュリティグループが 1 つまたは複数存在します。ただし、Amazon DocumentDB は、これらのセキュリティグループのいずれも、Amazon DocumentDB データベースとの接続には使用できません。Amazon DocumentDB は、Amazon DocumentDB データベースの VPC セキュリティグループをソースとするアウトバウンドルールが 1 つもないセキュリティグループを使用できません。また、Amazon DocumentDB は、変更が加えられたセキュリティグループを使用できません。 | Amazon DocumentDB アクション: 新しいセキュリティグループを作成する |
| パターン DocumentDB-ec2-n に一致する名前をもつ Amazon DocumentDB データベースに関連付けられたセキュリティグループが 1 つ以上存在します。パターンに一致するセキュリティグループは変更されていません。このセキュリティグループには、EC2 インスタンスの VPC セキュリティグループをソースとするインバウンドルールが 1 つのみ存在します。 | 接続に有効な EC2 セキュリティグループは存在しますが、EC2 インスタンスに関連付けられていません。このセキュリティグループには、パターン DocumentDB-ec2-n に一致する名前が付いています。このセキュリティグループには変更が加えられていません。このセキュリティグループには、Amazon DocumentDB データベースの VPC セキュリティグループをソースとするアウトバウンドルールが 1 つのみ存在します。 | Amazon DocumentDB アクション: EC2 セキュリティグループを関連付ける |
| 次の条件のいずれかが適用されます。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/connect-ec2-auto.html) | EC2 インスタンスに関連付けられた、パターン DocumentDB-ec2-n に一致する名前のセキュリティグループが 1 つまたは複数存在します。パターンに一致するセキュリティグループは変更されていません。このセキュリティグループには、Amazon DocumentDB データベースの VPC セキュリティグループをソースとするアウトバウンドルールが 1 つのみ存在します。 | Amazon DocumentDB アクション: 新しいセキュリティグループを作成する |
**Amazon DocumentDB アクション: 新しいセキュリティグループを作成する**
Amazon DocumentDB は以下のアクションを実行します。
+ パターン `DocumentDB-ec2-n` に一致する新しいセキュリティグループを作成します。このセキュリティグループには、EC2 インスタンスの VPC セキュリティグループをソースとするインバウンドルールが存在します。このセキュリティグループは Amazon DocumentDB データベースに関連付けられており、EC2 インスタンスが Amazon DocumentDB データベースにアクセスするのを許可します。
+ パターン `ec2-DocumentDB-n` に一致する新しいセキュリティグループを作成します。このセキュリティグループには、Amazon DocumentDB データベースの VPC セキュリティグループをソースとするアウトバウンドルールが存在します。このセキュリティグループには EC2 インスタンスに関連付けられており、EC2 インスタンスが Amazon DocumentDB データベースにトラフィックを送信するのを許可します。
**Amazon DocumentDB アクション: EC2 セキュリティグループを関連付ける**
Amazon DocumentDB は、有効な既存の EC2 セキュリティグループを EC2 インスタンスに関連付けます。このセキュリティグループは、EC2 インスタンスが Amazon DocumentDB データベース にトラフィックを送信するのを許可します。
## 接続中のコンピューティングリソースを表示する
を使用して AWS マネジメントコンソール 、Amazon DocumentDB データベースに接続されているコンピューティングリソースを表示できます。表示されるリソースには、自動的に設定されたコンピューティングリソース接続が含まれます。コンピューティングリソースとの接続は、次の方法で自動的に設定できます。
+ データベースを作成するときに、コンピューティングリソースを選択できます。詳細については、「[Amazon DocumentDB クラスターの作成](db-cluster-create.md)」および「マルチ AZ DB クラスターの作成」を参照してください。
+ 既存のデータベースとコンピューティングリソース間の接続を設定できます。詳細については、「[Amazon EC2 への自動接続](#connect-ec2-auto)」を参照してください。
コンピューティングリソースリストには、手動でデータベースに接続されたものは含まれていません。例えば、データベースに関連付けられた VPC セキュリティグループにルールを追加することで、コンピューティングリソースがデータベースに手動でアクセスできるようになります。
コンピューティングリソースをリスト化するには、次の条件を満たしている必要があります。
+ コンピューティングリソースに関連付けられているセキュリティグループの名前がパターン `ec2-DocumentDB-n` (n は数字) と一致する。
+ コンピューティングリソースに関連付けられたセキュリティグループには、Amazon DocumentDB データベースが使用するポート向けに設定されたポート範囲を持つアウトバウンドルールがある。
+ コンピューティングリソースに関連付けられたセキュリティグループには、Amazon DocumentDB データベースに関連付けられたセキュリティグループをソースとするアウトバウンドルールがある。
+ Amazon DocumentDB データベースに関連付けられたセキュリティグループの名前が、パターン `DocumentDB-ec2-n` (n は数字) に一致する。
+ Amazon DocumentDB データベースに関連付けられたセキュリティグループには、Amazon DocumentDB データベースが使用するポート向けに設定されたポート範囲を持つインバウンドルールがある。
+ Amazon DocumentDB データベースに関連付けられたセキュリティグループには、コンピューティングリソースに関連付けられたセキュリティグループをソースとするインバウンドルールがある。
**Amazon DocumentDB データベースに接続されているコンピューティングリソースを確認するには**
1. にサインインし AWS マネジメントコンソール、[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) で Amazon DocumentDB コンソールを開きます。
1. ナビゲーションペインで、**[データベース]** を選択し、確認したい Amazon DocumentDB データベースの名前を選択します。
1. **[接続とセキュリティ]** タブ内の **[接続されたコンピューティングリソース]** で、接続されているコンピューティングリソースを確認します。
# Amazon EC2 を手動で接続する
**Topics**
+ [ステップ 1: Amazon EC2 インスタンスを作成する](#manual-connect-ec2.launch-ec2-instance)
+ [ステップ 2: セキュリティグループを作成する](#manual-connect-ec2.security-group)
+ [ステップ 3: Amazon DocumentDB クラスターを作成する](#manual-connect-ec2.launch-cluster)
+ [ステップ 4: Amazon EC2 インスタンスに接続します](#manual-connect-ec2.connect)
+ [ステップ 5: MongoDB シェルをインストールする](#manual-connect-ec2.install-mongo-shell)
+ [ステップ 6: Amazon DocumentDB TLS の管理](#manual-connect-ec2.tls)
+ [ステップ 7: Amazon DocumentDB クラスターに接続する](#manual-connect-ec2.connect-use)
+ [ステップ 8: データの挿入とクエリ](#manual-cloud9-insert-query)
+ [ステップ 9: 環境情報の確認](#manual-connect-ec2.explore)
以下の手順は、「[前提条件](connect-ec2.md#connect-ec2-prerequisites)」トピックに記載されるステップが完了済みであることを前提としています。
## ステップ 1: Amazon EC2 インスタンスを作成する
このステップでは、後で Amazon DocumentDB クラスターのプロビジョニングに使用するのと同じリージョンと Amazon VPC に Amazon EC2 インスタンスを作成します。
1. Amazon EC2 コンソールで、[**インスタンスを起動**] を選択します。
![\[Amazon EC2 コンソールの [インスタンスを起動] セクション。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/launch-instance.png)
1. **[名前とタグ]** セクション内の **[名前]** フィールドに、名前または識別子を入力します。
1. **[Amazon マシンイメージ (AMI)]** ドロップダウンリストで、**[Amazon Linux 2 AMI]** を選択します。
![\[Amazon Linux 2 AMI オプションが [クイックスタート] セクションで選択された [アプリケーションおよび OS イメージ] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/linux2-ami.png)
1. **[インスタンスタイプ]** のドロップダウンリストで、**[t3.micro]** を選択します。
1. **[キーペア (ログイン)]** セクションで、既存のキーペアの識別子を入力するか、もしくは **[新しいキーペアの作成]** を選択します。
![\[キーペア名フィールドと新しいキーペアの作成オプションを示す [キーペア] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/key-pair.png)
Amazon EC2 キーペアを指定する必要があります。
+ Amazon EC2 のキーペアがある場合 :
1. キーペアを選択し、リストからご自身のキーペアを選択します。
1. Amazon EC2 インスタンスにログインするには、あからじめプライベートキーファイル (.pem もしくは.ppk ファイル) を利用可能にしておく必要があります。
+ Amazon EC2 のキーペアがない場合:
1. **[新しいキーペアの作成]** を選択すると、**[キーペアの作成]** ダイアログボックスが表示されます。
1. **[キーペア名]** フィールドに名前を入力します。
1. **[キーペアタイプ]** と **[プライベートキーファイル形式]** を選択します。
1. [**キーペアの作成**] を選択してください。
![\[キーペア名、タイプ、ファイル形式がある [キーペアの作成] インターフェイス。[キーペアの作成] ボタンは右下隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/create-key-pair.png)
**注記**
セキュリティ上の理由から、SSH とインターネット両方からの EC2 インスタンスへの接続にキーペアを使用することを強くお勧めします。
1. **[ネットワーク設定]** セクションの **[ファイアウォール (セキュリティグループ)]** で、**[セキュリティグループの作成]** または **[既存のセキュリティグループを選択する]** を選択します。
![\[セキュリティグループを作成するためのオプションを示す [ネットワーク設定] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/firewall.png)
既存のセキュリティグループを選択する場合は、**[共通セキュリティグループ]** ドロップダウンリストから選択します。
新しいセキュリティグループの作成を選択する場合は、以下を実行します。
1. EC2 への接続に適用されるすべてのトラフィック許可ルールを確認します。
1. [IP] フィールドで、**[マイ IP]** または **[カスタム]** を選択して、CIDR ブロックのリスト、プレフィックスリスト、もしくはセキュリティグループのいずれかを選択します。ここで **[Anywhere]** を選択するとどの IP アドレスからでも EC2 インスタンス へのアクセスが可能になるため、EC2 インスタンスが分離されたネットワーク上にある場合を除き、[Anywhere] を選択することはお勧めしません。
![\[My IP ドロップダウン。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/ip-field.png)
1. **[概要]** セクションで、EC2 設定を確認し、問題がなければ **[インスタンスを起動]** を選択します。
## ステップ 2: セキュリティグループを作成する
次に、デフォルトの Amazon VPC に新しいセキュリティグループを作成します。セキュリティグループ `demoDocDB` では、Amazon EC2 インスタンスからポート 27017 (Amazon DocumentDB のデフォルトポート) で Amazon DocumentDB クラスターに接続できます。
1. [Amazon EC2 マネジメントコンソール](https://console.aws.amazon.com/ec2) で、[**ネットワークとセキュリティ**] の下にある [**セキュリティグループ**] を選択します。
![\[[ネットワークとセキュリティ] ドロップダウンで [セキュリティグループ] オプションが選択された Amazon DocumentDB コンソールのナビゲーションペイン。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/nav-security-groups.png)
1. **[セキュリティグループの作成]** を選択してください。
![\[[セキュリティグループの作成] ボタンを選択します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/create-sg-btn-2.png)
1. **[基本的な詳細]** セクションで、次の操作を行います。
1. [**Security group name (セキュリティグループ名)**] に「 `demoDocDB` 」と入力します。
1. [**説明**] に説明を入力します。
1. **VPC** については、デフォルトの VPC の使用を受け入れます。
1. [**インバウンドルール**] セクションで、[**ルールの追加**] を選択します。
1. [**タイプ**] で [**カスタム TCP ルール**] を選択します (デフォルト)。
1. **[ポート範囲]** に `27017` と入力します。
1. **[ソース]** で **[カスタム]** を選択します。その横にあるフィールドで、先ほどステップ 1 で作成したセキュリティグループを検索します。 のソース名を自動入力するには、Amazon EC2 コンソールでブラウザを更新することが必要な場合があります。
![\[タイプ、プロトコル、ポート範囲、ソース、および説明のフィールドを示す [インバウンドルール] セクション。[ルールの追加] ボタンは左下隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/inbound-rules.png)
1. 他のすべてのデフォルトを受け入れ、[**セキュリティグループの作成**] を選択します。
![\[[セキュリティグループの作成] ボタンを選択します。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/create-sg-btn-2.png)
## ステップ 3: Amazon DocumentDB クラスターを作成する
Amazon EC2 インスタンスのプロビジョニング中は、Amazon DocumentDB クラスターを作成します。
1. Amazon DocumentDB コンソールに移動し、ナビゲーションペインから **クラスター** を選択します。
1. **[作成]** を選択します。
1. **[クラスタータイプ]** 設定は、デフォルトの **[インスタンスベースのクラスター]** のままにしておきます。
1. **[クラスター設定]** では、一意の **[クラスター名]** を入力します。コンソール操作では、入力方法に関係なくクラスター名のすべての文字が小文字に変換されることにご留意ください。
**[エンジンバージョン]** はデフォルト値の **5.0.0** のままにします。
1. **[クラスターストレージ設定]** では、**Amazon DocumentDB Standard** のデフォルト設定のままにします。
1. **[インスタンスの設定]** で:
+ **[DB インスタンスクラス]** では、**メモリ最適化クラス (r クラスを含む) ** を選択します (デフォルト）。
もう 1 つのインスタンスオプションは **NVMe-backed クラス** です。詳細については [NVMe-backed インスタンス](db-instance-nvme.md) を参照してください。
+ **[インスタンスクラス]** では、ニーズに合ったインスタンスタイプを選択します。インスタンスクラスの詳細については、「[インスタンスクラスの仕様](db-instance-classes.md#db-instance-class-specs)」を参照してください。
+ **[インスタンスの数]** では、ニーズを最も反映する数を選択します。数値が低いほど、コストが低くなり、クラスターで管理できる読み取り/書き込みボリュームが低くなることに注意してください。
![\[インスタンス数が 1 に設定されている、クラスター識別子、エンジンバージョン、およびインスタンスクラスのデフォルト値がある設定インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/create-cluster/instance-config.png)
1. **[接続]** は、デフォルト設定の **[EC2 コンピューティングリソースに接続しない]** のままにしておきます。
**注記**
EC2 コンピューティングリソースに接続すると、お使いのクラスターへの接続向けセキュリティグループが自動的に作成されます。前のステップでセキュリティグループを既に手動で作成しているため、追加のセキュリティグループのセットが作成されないように、**[EC2 コンピューティングリソースに接続しない]** を選択しておく必要があります。
1. **[認証]** セクションで、プライマリユーザーのユーザー名を入力し、**[セルフマネージド]** を選択します。パスワードを入力して確認します。
代わりに **Managed in AWS Secrets Manager** を選択した場合、詳細については[Amazon DocumentDB と によるパスワード管理 AWS Secrets Manager](docdb-secrets-manager.md)「」を参照してください。
1. **[クラスターを作成]** を選択します。
## ステップ 4: Amazon EC2 インスタンスに接続します
Amazon EC2 インスタンスに接続すると、MongoDB シェルをインストールできるようになります。Mongo シェルをインストールすると、Amazon DocumentDB クラスターに接続してクエリを実行できます。以下のステップを実行します。
1. Amazon EC2 コンソールで、インスタンスに移動し、作成したインスタンスが実行中かどうかを確認します。実行されている場合は、インスタンス ID をクリックしてインスタンスを選択します。
![\[Amazon EC2 コンソールで 2 つのインスタンスを一覧表示するインスタンステーブル。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/ec2-instance-table.png)
1. **接続** を選択します。
![\[Amazon EC2 インスタンスのインスタンス概要。[接続] ボタンは右上隅にあります。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/ec2-instance-summary.png)
1. 接続方法として、Amazon EC2 Instance Connect、セッションマネージャー、SSH クライアント、EC2 シリアルコンソールの 4 つのオプションがタブ形式で表示されます。いずれかを選択し、その指示に従わなければなりません。完了したら、**[接続する]** を選択します。
![\[EC2 Instance Connect の接続方法の設定オプションを示すインターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/ec2/connect-options.png)
**注記**
このチュートリアルの開始後に IP アドレスが変更された場合、または後で環境に戻る場合は、`demoEC2` セキュリティグループのインバウンドルールを更新して、新しい API アドレスからのインバウンドトラフィックを有効化します。
## ステップ 5: MongoDB シェルをインストールする
これで、MongoDB シェルをインストールできます。これは、Amazon DocumentDB クラスターに接続してクエリするために使用するコマンドラインのユーティリティです。現在、MongoDB シェルには最新バージョンの mongosh と以前のバージョンの mongo シェルの 2 つのバージョンがあります。
**重要**
なお、バージョン 6.13.1 より前の Node.js ドライバーには既知の制限事項があり、現在 Amazon DocumentDB の IAM ID 認証ではサポートされていません。Node.js ドライバーを使用する Node.js ドライバーとツール (例えば、mongosh) は、Node.js ドライバーバージョン 6.13.1 以降を使用するようにアップグレードする必要があります。
以下の手順に従って、オペレーションシステム用の MongoDB シェルをインストールします。
------
#### [ On Amazon Linux ]
**Amazon Linux で MongoDB シェルをインストールするには**
IAM を使用して*おらず*、最新の MongoDB シェル (mongosh) を使用して Amazon DocumentDB クラスターに接続する場合は、次の手順に従います。
1. リポジトリファイルを作成します。作成した EC2 インスタンスのコマンドラインで、次のコマンドを入力します。
```
echo -e "[mongodb-org-5.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/5.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://pgp.mongodb.com/server-5.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-5.0.repo
```
1. 完了したら、コマンドプロンプトで次の 2 つのコマンドオプションのいずれかを使用して mongosh をインストールします。
**オプション 1** — Amazon EC2 の設定中にデフォルトの Amazon Linux 2023 を選択した場合は、次のコマンドを入力します。
```
sudo yum install -y mongodb-mongosh-shared-openssl3
```
**オプション 2** — Amazon EC2 の設定中に Amazon Linux 2 を選択した場合は、次のコマンドを入力します。
```
sudo yum install -y mongodb-mongosh
```
IAM を使用している場合は、以前のバージョンの MongoDB シェル (5.0) を使用して Amazon DocumentDB クラスターに接続する必要があり、次の手順を実行します。
1. リポジトリファイルを作成します。作成した EC2 インスタンスのコマンドラインで、次のコマンドを入力します。
```
echo -e "[mongodb-org-5.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/5.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://pgp.mongodb.com/server-5.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-5.0.repo
```
1. 完了したら、コマンドプロンプトで次のコマンドオプションを使用して mongodb 5.0 シェルをインストールします。
```
sudo yum install -y mongodb-org-shell
```
------
#### [ On Ubuntu ]
**Ubuntu に mongosh をインストールするには**
1. パッケージ管理システムで使用されるパブリックキーをインポートします。
```
curl -fsSL https://pgp.mongodb.com/server-5.0.asc | sudo gpg --dearmor -o /usr/share/keyrings/mongodb-server-5.0.gpg
```
1. Ubuntu のバージョンに適切なコマンドを使用して、MongoDB の リストファイル `mongodb-org-5.0.list` を作成します。
```
echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-5.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
```
1. 次のコマンドを使用してローカルパッケージデータベースをインポートして更新します。
```
sudo apt-get update
```
1. mongosh をインストールします。
```
sudo apt-get install -y mongodb-mongosh
```
以前のバージョンの MongoDB の Ubuntu システムへのインストールについては、「 [Install MongoDB Community Edition on Ubuntu](https://docs.mongodb.com/v3.6/tutorial/install-mongodb-on-ubuntu/) 」を参照してください。
------
#### [ On other operating systems ]
mongo シェルを他のオペレーティングシステムにインストールするには、MongoDB ドキュメントの「 [MongoDB Community Edition のインストール](https://www.mongodb.com/docs/manual/administration/install-community/) 」を参照してください。
------
## ステップ 6: Amazon DocumentDB TLS の管理
次のコード `wget https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem` を使用して Amazon DocumentDB の CA 証明書をダウンロードします。
**注記**
全ての新しい Amazon DocumentDB クラスターに対して、デフォルトで Transport Layer Security (TLS) が有効になっています。詳細については、「[Amazon DocumentDB クラスター TLS 設定の管理](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)」を参照してください。
## ステップ 7: Amazon DocumentDB クラスターに接続する
1. Amazon DocumentDB コンソールの **[クラスター]** で、接続したいクラスターを見つけます。そのクラスターの **[クラスター識別子]** をクリックして、作成済みのクラスターを選択します。
![\[プライマリインスタンスの詳細を含むリージョンクラスターを示す Amazon DocumentDB クラスターリスト。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/cluster-connect-choose.png)
1. **[接続とセキュリティ]** タブの **[接続する]** ボックス内で、**[mongo シェルを使用してこのクラスターに接続する]** を見つけます。
![\[Mongo シェルを使用して Amazon DocumentDB クラスターに接続するための Amazon DocumentDB 接続文字列が強調表示されたクラスター接続設定。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/connect-mongosh.png)
表示された接続文字列をコピーし、ターミナルに貼り付けます。
これに以下の変更を加えます。
1. 文字列に正しいユーザー名が含まれているのを確認してください。
1. `` は省略します。これにより、接続時に mongo シェルによりパスワードの入力を求められます。
1. オプション: IAM 認証を使用している場合、または以前のバージョンの MongoDB シェルを使用している場合は、次のように接続文字列を変更します。
`mongo --ssl --host mydocdbcluster.cluster-cozt4xr9xv9b.us-east-1.docdb.amazonaws.com:27017 --sslCAFile global-bundle.pem --username SampleUser1 --password`
`mydocdbcluster.cluster-cozt4xr9xv9b.us-east-1` をクラスターの同じ情報に置き換えます。
1. ターミナル上で Enter キーを押します。ここで、パスワードの入力を求められます。パスワードを入力します。
1. パスワードを入力し、`rs0 [direct: primary] >` プロンプトが表示されたら、Amazon DocumentDB クラスターに正常に接続されています。
接続に問題がありますか。[Amazon DocumentDB のトラブルシューティング](https://docs.aws.amazon.com/documentdb/latest/developerguide/troubleshooting.html) を参照してください。
## ステップ 8: データの挿入とクエリ
クラスターに接続できたので、いくつかのクエリを実行して、ドキュメントデータベースの使用に慣れることができます。
1. 1 つのドキュメントを挿入するには、次のように入力します。
```
db.collection.insertOne({"hello":"DocumentDB"})
```
次の出力が返ります。
```
{
acknowledged: true,
insertedId: ObjectId('673657216bdf6258466b128c')
}
```
1. `findOne()` コマンドで書き込んだドキュメントを読み取ることができます (一つのドキュメントしか返さないため)。以下を入力します。
```
db.collection.findOne()
```
次の出力が返ります。
```
{ "_id" : ObjectId("5e401fe56056fda7321fbd67"), "hello" : "DocumentDB" }
```
1. さらにいくつかのクエリを実行するには、ゲームプロファイルのユースケースを検討してください。まず、「`profiles`」というタイトルのコレクションにエントリをいくつか挿入します。以下を入力します。
```
db.profiles.insertMany([{ _id: 1, name: 'Matt', status: 'active', level: 12, score: 202 },
{ _id: 2, name: 'Frank', status: 'inactive', level: 2, score: 9 },
{ _id: 3, name: 'Karen', status: 'active', level: 7, score: 87 },
{ _id: 4, name: 'Katie', status: 'active', level: 3, score: 27 }
])
```
次の出力が返ります。
```
{ acknowledged: true, insertedIds: { '0': 1, '1': 2, '2': 3, '3': 4 } }
```
1. `find()` コマンドを使用して、プロファイルコレクション内のすべてのドキュメントを返します。以下を入力します。
```
db.profiles.find()
```
ステップ 3 で入力したデータと一致する出力を取得します。
1. フィルターを使用して 1 つのドキュメントに対して1つのクエリを使用します。以下を入力します。
```
db.profiles.find({name: "Katie"})
```
次の出力が返ります。
```
{ "_id" : 4, "name" : "Katie", "status": "active", "level": 3, "score":27}
```
1. それでは、プロファイルを探して、それを `findAndModify` コマンドで変更してみましょう。次のコードを使用して、ユーザー Matt に 10 ポイント追加します。
```
db.profiles.findAndModify({
query: { name: "Matt", status: "active"},
update: { $inc: { score: 10 } }
})
```
次のような出力が得られます (Mattのスコアはまだ上がっていないことに注意してください) 。
```
{
[{_id : 1, name : 'Matt', status: 'active', level: 12, score: 202}]
```
1. 次のクエリを使用して、Matt のスコアが変更されたことを確認できます。
`db.profiles.find({name: "Matt"})`
次の出力が返ります。
```
{ "_id" : 1, "name" : "Matt", "status" : "active", "level" : 12, "score" : 212 }
```
## ステップ 9: 環境情報の確認
お疲れ様でした。Amazon DocumentDB のクイックスタートガイドを正常に完了しました。
次のステップ この強力なデータベースを一般的な特徴をいくつか使って十分に活用する方法を学びましょう。
+ [Amazon DocumentDB の管理](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-documentdb.html)
+ [スケーリング](https://docs.aws.amazon.com/documentdb/latest/developerguide/operational_tasks.html)
+ [バックアップと復元](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup_restore.html)
**注記**
コストを節約するために、Amazon DocumentDB クラスターを停止してコストを削減するか、クラスターを削除することができます。デフォルトでは、30 分間非アクティブになると、 AWS Cloud9 環境は基盤となる Amazon EC2 インスタンスを停止します。
# Amazon DocumentDB JDBC ドライバーを使用して接続する
Amazon DocumentDB 用の JDBC ドライバーは、デベロッパーのための SQL リレーショナルインターフェイスを提供し、Tableau や DBVisualizer などの BI ツールからの接続を可能にします。
詳細については、[GitHub 上の Amazon DocumentDB JDBC ドライバーのドキュメント](https://github.com/aws/amazon-documentdb-jdbc-driver/blob/develop/src/markdown/index.md) を参照してください。
**Topics**
+ [開始方法](#connect-jdbc-gettingstarted)
+ [Tableau デスクトップから Amazon DocumentDB に接続する](connect-jdbc-tableau.md)
+ [DbVisualizer から Amazon DocumentDB に接続する](connect-jdbc-DbVisualizer.md)
+ [JDBC スキーマの自動生成](connect-jdbc-autoschemagen.md)
+ [SQL サポートと制限](connect-jdbc-sqlandlimits.md)
+ [トラブルシューティング](connect-jdbc-troubleshooting.md)
## 開始方法
**ステップ 1. Amazon DocumentDB クラスターの作成**
Amazon DocumentDB クラスターが作成されていない場合は、Amazon DocumentDB デベロッパーガイドの [開始方法](https://docs.aws.amazon.com/documentdb/latest/developerguide/get-started-guide.html) のセクションの手順を使用してクラスターを作成します。
Amazon DocumentDB は仮想プライベートクラウド (VPC) 専用サービスです。クラスターの VPC 外にあるローカルマシンから接続する場合は、Amazon EC2 インスタンスへの SSH 接続を作成する必要があります。この場合、[EC2 を使用して接続](https://docs.aws.amazon.com/documentdb/latest/developerguide/connect-ec2.html) の手順に従ってクラスターを起動します。SSH トンネリングおよび必要な場合の詳細については、[SSH トンネルを使って Amazon DocumentDB に接続する](https://github.com/aws/amazon-documentdb-jdbc-driver/blob/develop/src/markdown/setup/setup.md#using-an-ssh-tunnel-to-connect-to-amazon-documentdb) を参照してください。
**ステップ 2. JRE または JDK インストール**
BI アプリケーションによっては、64 ビット JRE または JDK インストールバージョン 8 以降がコンピュータにインストールされていることを確認する必要がある場合があります。Java SE ランタイム環境 8 をダウンロードは [こちら](https://www.oracle.com/ca-en/java/technologies/javase-jre8-downloads.html)。
**ステップ 3. DocumentDB JDBC ドライバーのダウンロード**
[here( こちら )](https://github.com/aws/amazon-documentdb-jdbc-driver/releases) からのDocumentDB JDBC ドライバーのダウンロード ドライバーは単一の JAR ファイルとしてパッケージ化されています (例: documentdb-jdbc-1.0.0-all.jar)。
**ステップ 4. SSH トンネルを使用して Amazon DocumentDB に接続する**
Amazon DocumentDB (MongoDB との互換性) クラスターは、Amazon Virtual Private Cloud (Amazon VPC) 内にデプロイされます。これらは、Amazon EC2 インスタンス、または同じ Amazon VPC にデプロイされている他の AWS サービスから直接アクセスできます。さらに、Amazon DocumentDB は、VPC ピアリングを介して、同じ AWS リージョンまたは他のリージョンの異なる VPCs 内の EC2a インスタンスまたは他の AWS サービスからアクセスできます。
SSH トンネリング (ポート転送とも呼ばれます) を使用して、クラスターの VPC 外部から Amazon DocumentDB リソースにアクセスできます。これは、ほとんどのユーザーが DocumentDB クラスターと同じ VPC 内の仮想マシンでアプリケーションを実行していない場合です。
SSH トンネルを作成するには、Amazon DocumentDB クラスターと同じ Amazon VPC で実行中の Amazon EC2 インスタンスが必要です。クラスターと同じ VPC で既存の EC2 インスタンスを使用するか、新しい EC2 インスタンスを作成できます。その場合、ローカルコンピュータで以下のコマンドを実行することにより Amazon DocumentDB クラスター `sample-cluster.node.us-east-1.docdb.amazonaws.com` に SSH トンネルを設定できます。
```
ssh -i "ec2Access.pem" -L 27017:sample-cluster.node.us-east-1.docdb.amazonaws.com:27017 ubuntu@ec2-34-229-221-164.compute-1.amazonaws.com -N
```
ローカルポートの転送を行う場合は、-L フラグを使用します。これは、VPC 外のクライアントで実行されている BI ツールに接続するための前提条件です。上記のステップを実行したら、選択した BI ツールの次のステップに進むことができます。
SSH トンネリングの詳細については、[SSH トンネルを使用して Amazon DocumentDB に接続する](https://github.com/aws/amazon-documentdb-jdbc-driver/blob/develop/src/markdown/setup/setup.md#using-an-ssh-tunnel-to-connect-to-amazon-documentdb ) のドキュメントを参照してください。
# Tableau デスクトップから Amazon DocumentDB に接続する
**Topics**
+ [Amazon DocumentDB JDBC ドライバーの追加](#connect-jdbc-tableau-adddriver)
+ [Tableau を使用して Amazon DocumentDB に接続する - SSH トンネル](#connect-jdbc-tableau-ssh)
## Amazon DocumentDB JDBC ドライバーの追加
Tableau デスクトップから Amazon DocumentDB に接続するには、DocumentDB JDBC ドライバーと DocumentDB Tableau コネクタをダウンロードしてインストールする必要があります。
1. Amazon DocumentDB JDBC ドライバー JAR ファイルを [Amazon DocumentDB JDBC ドライバーレポジトリ](https://github.com/aws/amazon-documentdb-jdbc-driver/releases) からダウンロードし、ご使用のオペレーティングシステムに応じて次のいずれかのディレクトリにコピーします。
+ *Windows* – `C:\Program Files\Tableau\Drivers`
+ *MacOS* – `~/Library/Tableau/Drivers`
1. DocumentDB Tableau コネクタ (TACO ファイル) を [Tableau Exchange ウェブサイト](https://exchange.tableau.com/products/821) からダウンロードし、*My Tableau リポジトリ/コネクタディレクトリ* にコピーします。
+ *Windows* – `C:\Users\[user]\Documents\My Tableau Repository\Connectors`
+ *MacOS* – `/Users/[user]/Documents/My Tableau Repository/Connectors`
詳細 (追加情報) については、[Tableau のドキュメント](https://tableau.github.io/connector-plugin-sdk/docs/run-taco) を参照してください。
**注記**
新しい CA 証明書を使用している場合は、JDBC ドライバーを v1.4.5 (この AWS [GitHub リポジトリ](https://github.com/aws/amazon-documentdb-jdbc-driver/releases/tag/v1.4.5)で利用可能) にアップグレードしてください。
## Tableau を使用して Amazon DocumentDB に接続する - SSH トンネル
DocumentDB クラスターの VPC 外のクライアントマシンから Tableau に接続するには、以下のステップを実行する前に SSH トンネルを設定する必要があります。
1. Tableau デスクトップアプリケーションを起動します。
1. **Connect** > **To A Server** > **More** に移動します。
1. **[インストールされたコネクタ]** で **Amazon Web Services の Amazon DocumentDB** を選択します。
![\[Tableau Desktop の [接続] インターフェイスには、[サーバーへ] セクションの [さらに...] サブメニューが表示されます。Amazon DocumentDB オプションは、[インストール済みコネクタ] サブメニューで強調表示されます。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-choose-docdb.png)
**Tableau を使用して Amazon DocumentDB に接続する - 外部 SSH トンネル**
1. 必要な接続パラメータを入力します。**Hostname**、**ポート**、**データベース**、**ユーザーネーム**、**パスワード** です。以下の例の接続パラメータは、JDBC 接続文字列に相当します。
ユーザーネームとパスワードのパラメータを伴う `jdbc:documentdb://localhost:27019/test? tls=true&tlsAllowInvalidHostnames=true&scanMethod=random&scanLimit=1000&loginTimeoutSec=0&readPreference=primary&retryReads=true&schemaName=_default` は、プロパティコレクションで別々に渡されました。接続文字列パラメータの詳細については、[Amazon DocumentDB JDBC ドライバー github ドキュメント](https://github.com/aws/amazon-documentdb-jdbc-driver/blob/develop/src/markdown/setup/connection-string.md) を参照してください。
![\[ホスト名、ポート、データベース、ユーザー名、パスワードフィールドを示す [Amazon DocumentDB コネクタ] インターフェイスの [全般] タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-connect.png)
1. (オプション) より高度なオプションは、**アドバンスト** タブで見つけることができます。
![\[[追加の接続] オプションを示す [Amazon DocumentDB コネクタ] インターフェイスの [詳細設定] タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-advanced.png)
1. [**サインイン**] を選択します。
**Tableau を使用して Amazon DocumentDB に接続する - SSH トンネル**
**注記**
端末を使用して SSH トンネルをセットアップしたくない場合は、Tableau GUI を使用して、JDBC ドライバーが本質的に SSH トンネルの作成に使用する EC2 インスタンスの詳細を指定できます。
1. **アドバンスト** タブで、**SSH トンネルオプションを有効にする** を選択して、その他のプロパティを確認します。
![\[[SSH トンネルオプションを有効にする] が選択され、追加の SSH 入力フィールドが表示された Amazon DocumentDB コネクタインターフェイスの [詳細設定] タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-advanced-Enablessh.png)
1. **SSH ユーザー**、**SSH ホスト名**、**SSH プライベートキーファイル** を入力します。
1. (オプション) **SSH 厳密ホストキーチェック** オプションを無効にできます。これを使用すると、既知のホストファイルに対するホストキーのチェックをバイパスします。
**注記**
このオプションを無効にすると、[中間者](https://en.wikipedia.org/wiki/Man-in-the-middle_attack) 攻撃につながり得るので、安全性が低くなります。
![\[[SSH 厳密ホストキーチェック] オプションが無効になっている Amazon DocumentDB コネクタインターフェイスの [詳細設定] タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-advanced-sshhostkeycheck.png)
1. 必要な接続パラメータを入力します。**Hostname**、**ポート**、**データベース**、**ユーザーネーム**、**パスワード** です。
**注記**
内部 SSH トンネルオプションを使用する場合は、ローカルホストではなく DocumentDB クラスターエンドポイントを確実に使用してください。
![\[ホスト名、ポート、データベース、ユーザー名、パスワードフィールドを示す [Amazon DocumentDB コネクタ] インターフェイスの [全般] タブ。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/tableau-hostname.png)
1. **[サインイン]** を選択します。
# DbVisualizer から Amazon DocumentDB に接続する
**Topics**
+ [Amazon DocumentDB JDBC ドライバーの追加](#connect-jdbc-DbVisualizer-adddriver)
+ [DBVisualizer を使用して Amazon DocumentDB に接続する](#connect-jdbc-DbVisualizer-connect)
## Amazon DocumentDB JDBC ドライバーの追加
DbVisualizer から Amazon DocumentDB に接続するには、まずAmazon DocumentDB JDBC ドライバーをインポートする必要があります。
1. DbVisualizer アプリケーションをスタートし、メニューパスに移動します : **ツール > ドライバーマネージャー...**
1. **\$1** を選択します (またはメニューで、**ドライバ ー> ドライバーを作成** を選択) 。
1. [**Name**] を [`DocumentDB`] に設定します。
1. **URL 形式** を `jdbc:documentdb://[:port]/[?option=value[&option=value[...]]]` に設定
1. **フォルダ** ボタンを選択し、Amazon DocumentDB JDBC ドライバー JAR ファイルを選択し、**オープン** ボタンを選択します。
1. **ドライバークラス** フィールドが `software.amazon.documentdb.jdbc.DocumentDbDriver` になっていることを確認します。**DocumentDB** のドライバーマネージャの設定は、次の例のようになります。
![\[Amazon DocumentDB 名、URL 形式、およびドライバークラス設定が入力された DbVisualizer の [ドライバー設定] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/DbVisualizer-adddriver.jpg)
1. ダイアログを閉じます。Amazon DocumentDB JDBC ドライバーがセットアップされ、使用できる状態になります。
## DBVisualizer を使用して Amazon DocumentDB に接続する
DBVisualizer を使用して Amazon DocumentDB に接続する
1. Amazon DocumentDB クラスターの VPC の外部から接続する場合は、SSH トンネルが設定されていることを確認してください。
1. トップレベルメニューから、**データベース > データベース接続の作成** を選択します。
1. **名前** フィールドに、わかりやすい名前を入力します。
1. **ドライバー (JDBC)** を前のセクションで作成した DocumentDB ドライバーに設定します。
1. **データベース URL** を JDBC 接続文字列に設定します。
例: `jdbc:documentdb://localhost:27017/database?tlsAllowInvalidHostnames=true`
1. **データベースユーザー ID** を Amazon DocumentDB ユーザー ID に設定します。
1. **データベースパスワード** を、ユーザー ID に対応するパスワードに設定します。
データベース接続ダイアログは、次のダイアログのようになります。
![\[DocumentDB 設定を使用した [データベース接続] インターフェイス。\]](http://docs.aws.amazon.com/ja_jp/documentdb/latest/developerguide/images/jdbc/DbVisualizer-connect.jpg)
1. **接続** を選択します。
# JDBC スキーマの自動生成
Amazon DocumentDB はドキュメントデータベースであるため、テーブルとスキーマの概念はありません。ただし、Tableau などの BI ツールは、データベースがスキーマを提示することを期待します。具体的には、JDBC ドライバー接続でデータベース内のコレクションのスキーマを取得する必要がある場合は、データベース内のすべてのコレクションをポーリングします。ドライバーは、そのコレクションのスキーマのキャッシュバージョンがすでに存在するかどうかを判別します。キャッシュされたバージョンが存在しない場合は、ドキュメントのコレクションをサンプリングし、次の動作に基づいてスキーマを作成します。
**Topics**
+ [スキーマ生成の制限](#connect-jdbc-autoschemagen-limits)
+ [スキャン方法のオプション](#connect-jdbc-autoschemagen-scanningoptions)
+ [Amazon DocumentDB データ型](#connect-jdbc-autoschemagen-datatypes)
+ [スカラードキュメントフィールドのマッピング](#connect-jdbc-autoschemagen-scalarfields)
+ [オブジェクトと配列のデータ型の処理](#connect-jdbc-autoschemagen-objectandarray)
## スキーマ生成の制限
DocumentDB JDBC ドライバーは識別子の長さに 128 文字の制限を課しています。スキーマジェネレータは、生成された識別子 (テーブル名とカラム名) の長さを切り捨てて、その制限に適合するようにします。
## スキャン方法のオプション
サンプリング動作は、接続文字列またはデータソースオプションを使用して変更できます。
+ *scanMethod=*