接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続の方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
| プロパティ | 説明 |
| AuthScheme | 認証で使用されるスキーム。許容されるエンティティは、AwsRootKeys 、AwsIAMRoles 、AwsEC2Roles 、ADFS、Okta、PingFederate 、AwsCredentialsFile 、AwsCognitoBasic 、AwsCognitoSrpです。 |
| Domain | AWS のドメイン名。オプションでドメイン名をAWS と関連付けることができます。 |
| AWSAccessKey | AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
| AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
| AWSSessionToken | AWS のセッショントークン。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
| MFAToken | MFA デバイスから利用できる一時トークン。 |
| CredentialsLocation | MFA クレデンシャルが保存される設定ファイルの場所。 |
| TemporaryTokenDuration | 一時トークンが持続する時間（秒単位）。 |
| AWSCognitoRegion | AWS Cognito のホスティングリージョン。 |
| AWSUserPoolId | ユーザープールのID。 |
| AWSUserPoolClientAppId | ユーザープールのアプリクライアントID。 |
| AWSUserPoolClientAppSecret | ユーザープールのアプリクライアントシークレット。（オプション） |
| AWSIdentityPoolId | ID プールのID。 |
| AWSWebIdentityToken | ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。 |
| プロパティ | 説明 |
| User | SSO 経由でIDP の認証に使用するIDP ユーザー。 |
| Password | SSO 経由でIDP ユーザーの認証に使用するパスワード。 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
| SSOExchangeUrl | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | プロキシサーバー（ ProxyServer 接続プロパティで指定）が起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AutoDetectIndex | A boolean indicating if secondary indexes should be automatically detected based on the query used. |
| BatchSize | 送信する各バッチ処理の最大サイズ。 |
| ConnectionLifeTime | 接続の最大有効期間（秒単位）。その時間が経過すると、接続オブジェクトは削除されます。 |
| FlattenArrays | デフォルトで、ネスト配列はJSON 文字列として返されます。 FlattenArrays プロパティはネスト配列のエレメントをフラット化してそれぞれのカラムとするために使われます。ネスト配列から返すエレメントの数に FlattenArrays を設定します。 |
| FlattenObjects | フラット化されたオブジェクトプロパティとしてカラムを表示するには、 FlattenObjects をtrue に設定します。そうでなければ、配列にネストされたオブジェクトはJSON 文字列として返されます。 |
| FlexibleSchema | クエリ結果セットの追加のメタデータをスキャンするには、 FlexibleSchema をtrue に設定します。それ以外の場合、メタデータはそのままです。 |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| IgnoreTypes | 指定された型のサポートを削除します。例えば、Time です。これらの型は、代わりに文字列として報告されます。 |
| MaximumRequestRetries | リクエストをリトライする最大回数。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Configures the maximum number of items that Amazon DynamoDB evaluates per API request. |
| PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
| PoolMaxSize | プールの最大接続数。 |
| PoolMinSize | プール内の最小接続数。 |
| PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
| PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
| QueryMode | This property indicates how the driver will retrieve the results. |
| Readonly | このプロパティを使用して、provider からAmazon DynamoDB へのアクセスを読み取り専用に設定できます。 |
| RetryWaitTime | リクエストを再試行するためにprovider が待機する最小時間（ミリ秒数）。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| SeparatorCharacter | 階層を示すために使用する記号。 |
| ThreadCount | 並列スキャンでデータを選択するときに使用するスレッドの数。ThreadCount を1 に設定すると、並列スキャンは無効になります。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| TypeDetectionScheme | カラムのデータ型を決定するための方法を指定します。 |
| UseBatchWriteItemOperation | When enabled the provider will use BatchWriteItem operation for handling updates and INSERTs. By default, the provider uses ExecuteStatement/BatchExecuteStatement operation. You need to enable BatchWriteItem only when inserting/updating binary/binary-set data. ExecuteStatement/BatchExecuteStatement doesn't support manipulating binary fields. |
| UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
| UseConsistentReads | Whether to alyways use Consistent Reads or not when querying DynamoDb |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |