ODBC ドライバーの接続文字列の構文とオプション

ODBC ドライバーの接続文字列オプションを指定するための構文は次のとおりです。


Driver={AWS IoT SiteWise ODBC Driver};(option)=(value);

使用できるオプションは以下のとおりです。

ドライバー接続オプション

Driver (必須) – ODBC で使用されているドライバー。

デフォルトは AWS IoT SiteWiseです。
DSN – 接続の設定に使用するデータソース名 (DSN)。

デフォルトは NONE です。
Auth – 認証モード。これは、次のいずれかである必要があります。
- AWS_PROFILE – デフォルトの認証情報チェーンを使用します。
- IAM – IAM AWS 認証情報を使用します。
- AAD – Azure Active Directory (AD) ID プロバイダーを使用します。
- OKTA – Okta ID プロバイダーを使用します。
デフォルトは AWS_PROFILE です。

エンドポイント設定オプション

EndpointOverride – AWS IoT SiteWise サービスのエンドポイントオーバーライド。これは、リージョンを上書きする高度なオプションです。例:
```
iotsitewise.us-east-1.amazonaws.com
```
Region – AWS IoT SiteWise サービスエンドポイントの署名リージョン。

デフォルトは us-east-1 です。

認証情報プロバイダーオプション

ProfileName – AWS 設定ファイルのプロファイル名。

デフォルトは NONE です。

AWS IAM 認証オプション

UID または AccessKeyId – AWS ユーザーアクセスキー ID。UID との両方AccessKeyIdが接続文字列で指定されている場合、UID値は空でない限り使用されます。

デフォルトは NONE です。
PWD または SecretKey – AWS ユーザーシークレットアクセスキー。接続文字列で PWDとの両方SecretKeyが指定されている場合、空でない限り、 PWDの値が使用されます。

デフォルトは NONE です。
SessionToken – 多要素認証 (MFA) が有効になっているデータベースにアクセスするために必要な一時的なセッショントークン。 = 入力に末尾を含めないでください。

デフォルトは NONE です。

Okta の SAML ベースの認証オプション

IdPHost – 指定された IdP のホスト名。

デフォルトは NONE です。
UID または IdPUserName – 指定された IdP アカウントのユーザー名。接続文字列で UIDとの両方IdPUserNameが指定されている場合、値が空でない限り、UID値が使用されます。

デフォルトは NONE です。
PWD または IdPPassword – 指定された IdP アカウントのパスワード。接続文字列で PWDとの両方IdPPasswordが指定されている場合、PWD値は空でない限り使用されます。

デフォルトは NONE です。
OktaApplicationID – AWS IoT SiteWise アプリケーションに関連付けられた一意の Okta 提供 ID。アプリケーション ID (AppId) を検索する場所は、アプリケーションメタデータで指定された entityIDフィールドにあります。以下に例を示します。
```
entityID="http://www.okta.com//(IdPAppID)
```
デフォルトは NONE です。
RoleARN – 発信者が引き受けるロールの Amazon リソースネーム (ARN)。

デフォルトは NONE です。
IdPARN – IdP を記述する IAM の SAML プロバイダーの Amazon リソースネーム (ARN)。

デフォルトは NONE です。

Azure Active Directory の SAML ベースの認証オプション

UID または IdPUserName – 指定された IdP アカウントのユーザー名。

デフォルトは NONE です。
PWD または IdPPassword – 指定された IdP アカウントのパスワード。

デフォルトは NONE です。
AADApplicationID – Azure AD に登録されたアプリケーションの一意の ID。

デフォルトは NONE です。
AADClientSecret – トークンの取得を承認するために使用される Azure AD の登録済みアプリケーションに関連付けられたクライアントシークレット。

デフォルトは NONE です。
AADTenant – Azure AD テナント ID。

デフォルトは NONE です。
RoleARN – 呼び出し元が引き受けるロールの Amazon リソースネーム (ARN)。

デフォルトは NONE です。
IdPARN – IdP を記述する IAM の SAML プロバイダーの Amazon リソースネーム (ARN)。

デフォルトは NONE です。

AWS SDK (アドバンスド) オプション

RequestTimeout – AWS SDK がタイムアウトする前にクエリリクエストを待機するミリ秒単位の時間。正以外の値を指定すると、リクエストのタイムアウトは無効になります。

デフォルトは 3000 です。
ConnectionTimeout – AWS SDK がタイムアウトする前にオープン接続経由でデータを転送するのを待機するミリ秒単位の時間。値が 0 の場合、接続タイムアウトは無効になります。この値は負にすることはできません。

デフォルトは 1000 です。
MaxRetryCountClient – SDK の 5xx エラーコードによる再試行可能なエラーの最大再試行回数。値は負にすることはできません。

デフォルトは 0 です。
MaxConnections – AWS IoT SiteWise サービスへの同時オープン可能な HTTP 接続の最大数。値は正である必要があります。

デフォルトは 25 です。

ODBC ドライバーのログ記録オプション

LogLevel – ドライバーログ記録のログレベル。次のいずれかにする必要があります。
- 0 (オフ）。
- 1 (ERROR)。
- 2 (警告）。
- 3 (INFO)。
- 4 (デバッグ）。
デフォルトは 1 (ERROR) です。

警告: DEBUG ログ記録モードを使用すると、ドライバーが個人情報を記録する可能性があります。
LogOutput – ログファイルを保存するフォルダ。

デフォルトは次のとおりです。
- Windows: %USERPROFILE%、または利用できない場合は %HOMEDRIVE%%HOMEPATH%。
- macOS と Linux: $HOME、または使用できない場合は、関数pw_dirのフィールドから値getpwuid(getuid())を返します。

SDK ログ記録オプション

AWS SDK ログレベルは ODBC AWS IoT SiteWise ドライバーログレベルとは別です。一方を設定しても、他方には影響しません。

SDK ログレベルは、環境変数を使用して設定されますSW_AWS_LOG_LEVEL。次の値を指定できます。

OFF
ERROR
WARN
INFO
DEBUG
TRACE
FATAL

が設定されSW_AWS_LOG_LEVELていない場合、SDK ログレベルはデフォルトに設定されますWARN。

プロキシを介した接続

ODBC ドライバーは、プロキシ AWS IoT SiteWise を介したへの接続をサポートします。この機能を使用するには、プロキシ設定に基づいて次の環境変数を設定します。

SW_PROXY_HOST – プロキシホスト。
SW_PROXY_PORT – プロキシポート番号。
SW_PROXY_SCHEME – プロキシスキーム、 httpまたは https。
SW_PROXY_USER – プロキシ認証のユーザー名。
SW_PROXY_PASSWORD – プロキシ認証のユーザーパスワード。
SW_PROXY_SSL_CERT_PATH – HTTPS プロキシへの接続に使用する SSL 証明書ファイル。
SW_PROXY_SSL_CERT_TYPE – プロキシクライアント SSL 証明書のタイプ。
SW_PROXY_SSL_KEY_PATH – HTTPS プロキシへの接続に使用するプライベートキーファイル。
SW_PROXY_SSL_KEY_TYPE – HTTPS プロキシへの接続に使用されるプライベートキーファイルのタイプ。
SW_PROXY_SSL_KEY_PASSWORD – HTTPS プロキシへの接続に使用されるプライベートキーファイルへのパスフレーズ。

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

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

ドキュメントの表記規則

ODBC

接続文字列の例