接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
| プロパティ | 説明 |
| AuthScheme | Amazon DynamoDB に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| Domain | AWS のドメイン名を指定します。組織がAWS にドメイン名を関連付けている場合、このプロパティを使用してカスタムドメイン名を設定します。 |
| DynamoDBVPCEndpoint | Specifies the Amazon DynamoDB VPC endpoint to use when connecting through AWS PrivateLink. |
| AWSAccessKey | AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
| AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
| AWSSessionToken | AWS のセッショントークン。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
| MFAToken | 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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheProvider | ADO.NET プロバイダーの名前空間。指定されたプロバイダーは、すべてのキャッシュ操作のターゲットデータベースとして使用されます。 |
| CacheConnection | 指定されたキャッシュデータベースの接続文字列を指定します。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間（秒単位）を指定します。AutoCache がTrue に設定されている必要があります。 |
| Offline | ライブAmazon DynamoDB データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AutoDetectIndex | Specifies whether the provider should automatically detect and use secondary indexes based on the query criteria. |
| FlattenArrays | このプロパティは、ネスト配列の要素を個々のカラムにフラット化します。デフォルトでは、ネスト配列はJSON 文字列として返されます。このプロパティを、ネスト配列から抽出する要素の数に設定します。 |
| FlattenObjects | ネストされたオブジェクトプロパティを個々のカラムにフラット化するかどうかを指定します。 |
| FlexibleSchema | Specifies whether the provider should dynamically scan query result sets for additional metadata. Set to true to enable scanning or false to use a static metadata structure. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| IgnoreTypes | 無視され、文字列として報告されるデータ型を指定します。 |
| MaximumRequestRetries | 一時的な問題が検出された場合にprovider がリクエストを再試行する最大回数を指定します。一時的な問題には、ネットワークの中断、一過性のエラー、運用上のしきい値を超えることなどを含みます。 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対する追加の隠しプロパティを指定します。特定の問題に対処するため、サポートチームが推奨する場合にのみ使用してください。詳細は備考を参照してください。 |
| Pagesize | Specifies the maximum number of items provider evaluates per API request. The default value, -1, allows the server to calculate the page size automatically. |
| QueryMode | Specifies the mode used by the provider to retrieve results from Amazon DynamoDB. |
| Readonly | provider からAmazon DynamoDB への読み取り専用アクセスを切り替えます。 |
| RetryWaitTime | リクエストを再試行する前にprovider が待機する最小時間（ミリ秒数）を指定します。再試行するたびに待機時間は2倍になります。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| SeparatorCharacter | DynamoDB のMaps 属性やList 属性など、フラット化された構造の階層を示すために使用する記号を指定します。 |
| ThreadCount | データ選択時の並列スキャンに割り当てるスレッド数を指定します。値が1であれば並列スキャンは無効になり、値が大きければ並列性が高まります。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TypeDetectionScheme | カラムのデータ型を決定するために使用される方法を指定します。 |
| UseBatchWriteItemOperation | Specifies the use of the BatchWriteItem operation for updates and inserts. This is required for handling binary or binary-set data, as the default operations (ExecuteStatement/BatchExecuteStatement) do not support these field types. |
| UseConsistentReads | Specifies whether consistent reads should always be used when querying DynamoDB. Consistent reads provide the most up-to-date data, but consume more read capacity. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |