AWS SDK for JavaScript V3 APIリファレンスガイドでは、バージョン 3 (V3) のすべてのAPIオペレーション AWS SDK for JavaScript について詳しく説明します。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon Redshiftの例
この例では、一連の Node.js モジュールを使用して、パラメーターの作成、変更、記述をします。次の Redshift
クライアントクラス方法を使ってAmazon Redshift クラスターを削除します。
Amazon Redshift ユーザーの詳細については、「 Amazon Redshift getting started guide 」を参照下さい。
前提条件タスク
この例をセットアップして実行するには、まず次のタスクを完了する必要があります。
-
これらの Node TypeScript 例を実行するようにプロジェクト環境を設定し、必要な AWS SDK for JavaScript モジュールとサードパーティーモジュールをインストールします。の指示に従います GitHub
。 -
ユーザーの認証情報を使用して、共有設定ファイルを作成します。共有認証情報ファイルの提供の詳細については、「」およびAWS SDKsツールリファレンスガイドの「共有設定ファイルと認証情報ファイル」を参照してください。
重要
これらの例は、 ECMAScript6 () を使用してクライアントサービスオブジェクトとコマンドをインポート/エクスポートする方法を示していますES6。
これには Node.js バージョン 13.x 以降が必要です。Node.js の最新バージョンをダウンロードしてインストールするには、「Node.js ダウンロード
」を参照してください。 CommonJS 構文を使用する場合は、「JavaScript ES6/CommonJS 構文」を参照してください。
Amazon Redshift クラスターを作成します。
この例では AWS SDK for JavaScriptを使用して Amazon Redshift クラスターを作成する方法を示しています。詳細については、「」を参照してくださいCreateCluster。
重要
ここで作成するクラスターはライブです (サンドボックスで実行されるわけではありません)。クラスターを削除するまで、そのクラスターについて Amazon Redshift 標準使用料が発生します。クラスターを作成したときと同じ設定のクラスターを削除すれば、課金される合計金額は最小限になります。
libs
ディレクトリを作成し、ファイル名redshiftClient.js
でNode.js モジュールを作成します。以下のコードをコピーし、ペーストしてAmazon Redshift クライアントオブジェクトを作成します。置換 REGION
AWS リージョンを使用します。
import { RedshiftClient } from "@aws-sdk/client-redshift"; // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create Redshift service object. const redshiftClient = new RedshiftClient({ region: REGION }); export { redshiftClient };
このサンプルコードは、 で GitHub
redshift-create-cluster.js
というファイル名で Node.js モジュールを作成します。必要なクライアントとパッケージのインストールを含め、前述のSDKように を設定してください。パラメータオブジェクトを作成し、プロビジョニングするノードタイプ、およびクラスターに自動的に作成されるデータベースインスタンスのマスターサインイン認証情報、最後にクラスタタイプを指定します。
注記
置換 CLUSTER_NAME
クラスターの名前。[ NODE_TYPE
例えば、「dc2.large」など、プロビジョニングするノードタイプを指定します。MASTER_USERNAME
また、MASTER_USER_PASSWORD
は、クラスター内の DB インスタンスのマスターユーザーのサインイン認証情報です。[ CLUSTER_TYPE
、クラスターのタイプを入力します。single-node
を指定した場合、 NumberOfNodes
パラメータは必要ありません。残りのパラメータはオプションです。
// Import required AWS SDK clients and commands for Node.js import { CreateClusterCommand } from "@aws-sdk/client-redshift"; import { redshiftClient } from "./libs/redshiftClient.js"; const params = { ClusterIdentifier: "CLUSTER_NAME", // Required NodeType: "NODE_TYPE", //Required MasterUsername: "MASTER_USER_NAME", // Required - must be lowercase MasterUserPassword: "MASTER_USER_PASSWORD", // Required - must contain at least one uppercase letter, and one number ClusterType: "CLUSTER_TYPE", // Required IAMRoleARN: "IAM_ROLE_ARN", // Optional - the ARN of an IAM role with permissions your cluster needs to access other AWS services on your behalf, such as Amazon S3. ClusterSubnetGroupName: "CLUSTER_SUBNET_GROUPNAME", //Optional - the name of a cluster subnet group to be associated with this cluster. Defaults to 'default' if not specified. DBName: "DATABASE_NAME", // Optional - defaults to 'dev' if not specified Port: "PORT_NUMBER", // Optional - defaults to '5439' if not specified }; const run = async () => { try { const data = await redshiftClient.send(new CreateClusterCommand(params)); console.log( `Cluster ${data.Cluster.ClusterIdentifier} successfully created`, ); return data; // For unit tests. } catch (err) { console.log("Error", err); } }; run();
この例を実行するには、コマンドプロンプトで以下を入力します。
node redshift-create-cluster.js
このサンプルコードは、 で GitHub
Amazon Redshift クラスターを変更する
この例では、 AWS SDK for JavaScriptを使用して Amazon Redshift クラスターのマスターユーザーパスワードを変更する方法を示します。変更できる他の設定の詳細については、「」を参照してくださいModifyCluster。
libs
ディレクトリを作成し、ファイル名redshiftClient.js
でNode.js モジュールを作成します。以下のコードをコピーし、ペーストしてAmazon Redshift クライアントオブジェクトを作成します。置換 REGION
AWS リージョンを使用します。
import { RedshiftClient } from "@aws-sdk/client-redshift"; // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create Redshift service object. const redshiftClient = new RedshiftClient({ region: REGION }); export { redshiftClient };
このサンプルコードは、 で GitHub
redshift-modify-cluster.js
というファイル名で Node.js モジュールを作成します。必要なクライアントとパッケージのインストールを含め、前述のSDKように を設定してください。 AWS リージョン、変更するクラスターの名前、新しいマスターユーザーパスワードを指定します。
注記
置換 CLUSTER_NAME
クラスターの名前、および MASTER_USER_PASSWORD
新しいマスターユーザーパスワードを使用します。
// Import required AWS SDK clients and commands for Node.js import { ModifyClusterCommand } from "@aws-sdk/client-redshift"; import { redshiftClient } from "./libs/redshiftClient.js"; // Set the parameters const params = { ClusterIdentifier: "CLUSTER_NAME", MasterUserPassword: "NEW_MASTER_USER_PASSWORD", }; const run = async () => { try { const data = await redshiftClient.send(new ModifyClusterCommand(params)); console.log("Success was modified.", data); return data; // For unit tests. } catch (err) { console.log("Error", err); } }; run();
この例を実行するには、コマンドプロンプトで以下を入力します。
node redshift-modify-cluster.js
このサンプルコードは、 で GitHub
Amazon Redshift クラスターの詳細を表示します
この例では、 AWS SDK for JavaScriptを使用してAmazon Redshift クラスターの詳細を表示する方法を示しています。オプションの詳細については、「」を参照してくださいDescribeClusters。
libs
ディレクトリを作成し、ファイル名redshiftClient.js
でNode.js モジュールを作成します。以下のコードをコピーし、ペーストしてAmazon Redshift クライアントオブジェクトを作成します。置換 REGION
AWS リージョンを使用します。
import { RedshiftClient } from "@aws-sdk/client-redshift"; // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create Redshift service object. const redshiftClient = new RedshiftClient({ region: REGION }); export { redshiftClient };
このサンプルコードは、 で GitHub
redshift-describe-clusters.js
というファイル名で Node.js モジュールを作成します。必要なクライアントとパッケージのインストールを含め、前述のSDKように を設定してください。 AWS リージョン、変更するクラスターの名前、新しいマスターユーザーパスワードを指定します。
注記
置換 CLUSTER_NAME
クラスターの名前。
// Import required AWS SDK clients and commands for Node.js import { DescribeClustersCommand } from "@aws-sdk/client-redshift"; import { redshiftClient } from "./libs/redshiftClient.js"; const params = { ClusterIdentifier: "CLUSTER_NAME", }; const run = async () => { try { const data = await redshiftClient.send(new DescribeClustersCommand(params)); console.log("Success", data); return data; // For unit tests. } catch (err) { console.log("Error", err); } }; run();
この例を実行するには、コマンドプロンプトで以下を入力します。
node redshift-describe-clusters.js
このサンプルコードは、 で GitHub
Amazon Redshift クラスターを削除します
この例では、 AWS SDK for JavaScriptを使用してAmazon Redshift クラスターの詳細を表示する方法を示しています。変更できる他の設定の詳細については、「」を参照してくださいDeleteCluster。
libs
ディレクトリを作成し、ファイル名redshiftClient.js
でNode.js モジュールを作成します。以下のコードをコピーし、ペーストしてAmazon Redshift クライアントオブジェクトを作成します。置換 REGION
AWS リージョンを使用します。
import { RedshiftClient } from "@aws-sdk/client-redshift"; // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create Redshift service object. const redshiftClient = new RedshiftClient({ region: REGION }); export { redshiftClient };
このサンプルコードは、 で GitHub
redshift-delete-clusters.js
というファイル名で Node.js モジュールを作成します。必要なクライアントとパッケージのインストールを含め、前述のSDKように を設定してください。 AWS リージョン、変更するクラスターの名前、新しいマスターユーザーパスワードを指定します。削除前にクラスターの最終スナップショットを保存したい場合、そうする場合は、スナップショットのID を指定します。
注記
置換 CLUSTER_NAME
クラスターの名前。向けの SkipFinalClusterSnapshot
、クラスターを削除する前に、クラスターの最終スナップショットを作成するかどうかを指定します。「false」を指定する場合は、 で最終的なクラスタースナップショットの ID を指定します。CLUSTER_SNAPSHOT_ID
。 この ID を取得するには、クラスターダッシュボードのクラスターのスナップショット列のリンクをクリックし、スナップショットペインにスクロールダウンします。rs:
ステムはスナップショットID の一部でないことに注意してください。
// Import required AWS SDK clients and commands for Node.js import { DeleteClusterCommand } from "@aws-sdk/client-redshift"; import { redshiftClient } from "./libs/redshiftClient.js"; const params = { ClusterIdentifier: "CLUSTER_NAME", SkipFinalClusterSnapshot: false, FinalClusterSnapshotIdentifier: "CLUSTER_SNAPSHOT_ID", }; const run = async () => { try { const data = await redshiftClient.send(new DeleteClusterCommand(params)); console.log("Success, cluster deleted. ", data); return data; // For unit tests. } catch (err) { console.log("Error", err); } }; run();
この例を実行するには、コマンドプロンプトで以下を入力します。
node redshift-delete-cluster.js
このサンプルコードは、 で GitHub