TypeScriptの主なメリット
1.型安全性の向上
TypeScriptには型システムがあり、変数、関数、引数、戻り値などの型を定義できます。これにより、開発者はコードを実行する前に型エラーを検出でき、実行時のエラーを減らすことができます。
2.IDEのサポート
TypeScriptは静的型付け言語であるため、IDEが開発者に対して正確な補完やリファクタリング、デバッグのサポートを提供できます。
3.可読性と保守性の向上
TypeScriptには明確な型があるため、コードの意図を理解しやすくなり、保守性が向上します。また、型アノテーションを使用することで、ドキュメント化されたAPIを提供することもできます。
4.JavaScriptとの互換性
TypeScriptはJavaScriptの上に構築されているため、既存のJavaScriptコードをTypeScriptに移植することが容易で、JavaScriptのライブラリやフレームワークを使用できます。
5.開発速度の向上
TypeScriptは開発者が作成するコードの品質を向上させ、開発速度を向上させることができます。また、TypeScriptにはJavaScriptのような動的言語のような柔軟性もあり、開発者が必要に応じて型を明示的に定義することもできます。
AWS TypeScript SDKを使用するメリット
1). 型安全性の向上
AWS TypeScript SDKは、TypeScriptの型システムを活用して、AWSサービスのAPI呼び出しに関する型定義を提供します。これにより、開発者はAPI呼び出し時に必要なパラメーターやレスポンスの形式を正確に理解し、より型安全なコードを書くことができます。
2). IDEのサポート
TypeScriptの静的型付けにより、開発者はIDEの補完やエラー検出機能を活用することができます。これにより、API呼び出しの間違いや、パラメーターの不足などの問題を事前に検知できます。
3). コードの品質向上
AWS TypeScript SDKは、AWSサービスのAPI呼び出しを抽象化しています。このため、開発者はAPI呼び出しに必要なコードを書く代わりに、より高次元の抽象化されたメソッドを使用することができます。これにより、コードの品質が向上し、可読性や保守性が高くなります。
4). AWSサービスへのアクセスの簡素化
AWS TypeScript SDKを使用することで、AWSサービスにアクセスするための複雑な手順や、エラー処理を自分で書く必要がなくなります。SDKがこれらの処理を自動的に処理するため、開発者はAPI呼び出しに集中することができます。
5). AWSサービスの更新に対する柔軟性
AWS TypeScript SDKは、AWSサービスの更新に対応しています。AWSがAPIを更新するたびに、SDKも更新され、最新のAPIへのアクセスを維持します。開発者は、SDKを更新するだけで、最新のAWSサービスにアクセスできます。
目次
AWS TypeScript SDKを使う方法
データ型
Intersection types(交差型)
Union types(合併型)
typeof演算子
keyofキーワード
Enum(列挙型)
型の互換性
ジェネリック(Generics)
【関数の定義】
【クラスの定義】
【クラスの承継】
タプルの例
例).AWS Lake Formation CDK(Cloud Development Kit)を使用して、AWS Lake Formationサービスの構成を定義するTypeScript
例).CloudWatchから取得したApacheプロセス数が200を超えた場合にSlackに通知する
TypeScriptの一般的な環境構築手順
TypeScriptでLambda関数を作成する方法
AWS TypeScript SDKを使う方法
1.AWS SDK for TypeScriptのインストール
最初に、AWS SDK for TypeScriptをインストールする必要があります。
必要なパッケージをインストールします。
npm install aws-sdk
2. TypeScript用の型定義ファイルのインストール
次に、TypeScript用の型定義ファイルをインストールします。
npm install @types/aws-sdk
3.AWS SDKの初期化
AWS SDKを使用する前に、AWS SDKを初期化する必要があります。以下は、AWS SDKを初期化するサンプルコードです。
import AWS from 'aws-sdk';
AWS.config.update({ region: 'us-west-2', credentials: { accessKeyId: 'ACCESS_KEY_ID', secretAccessKey: 'SECRET_ACCESS_KEY' } });
ここで、regionには使用するリージョンを、accessKeyIdとsecretAccessKeyにはAWSのアクセスキーとシークレットキーを設定します。
4.AWSサービスの呼び出し
認証情報が設定されたら、AWS SDKを使用してAWSサービスを呼び出すことができます。
Amazon S3バケットからオブジェクトのリストを取得する方法を示します。
import AWS from 'aws-sdk';
const s3 = new AWS.S3({ apiVersion: '2006-03-01' });
const bucketName = 'my-bucket-name';
s3.listObjectsV2({ Bucket: bucketName }, (err, data) => {
if (err) {
console.error(err);
} else {
console.log(data);
}
});
上記の例では、AWS.S3クラスを使用してS3サービスを呼び出しています。
listObjectsV2メソッドを使用して、指定されたバケット内のオブジェクトのリストを取得しています。
S3バケットの一覧を取得するサンプルコード
AWS.S3を使用し、listBucketsメソッドを呼び出して、S3バケットの一覧を取得しています。
import AWS from 'aws-sdk';
const s3 = new AWS.S3();
s3.listBuckets((err, data) => {
if (err) {
console.log('Error:', err);
} else {
console.log('Bucket List:', data.Buckets);
}
});
以上が、AWS TypeScript SDKを使用するための基本的な手順です。
必要に応じて、AWS SDKを使用して他のAWSサービスを呼び出すことができます。
データ型
プリミティブ型
number: 数値を表す。
string: 文字列を表す。
boolean: 真偽値を表す。
null: nullを表す。
undefined: undefinedを表す。
symbol: ES6で追加されたシンボルを表す。
オブジェクト型
object: オブジェクトを表す。{}で空のオブジェクトを表すこともできる。
Array: 配列を表す。number[]やstring[]など、配列の要素の型を指定することもできる。
Tuple: 固定長の配列を表す。[number, string]など、要素の型と数を指定することができる。
Function: 関数を表す。引数と戻り値の型を指定することができる。
Class: クラスを表す。メンバ変数とメソッドの型を指定することができる。
その他の型
any: どのような型でも受け付ける。
unknown: あらゆる型と互換性があるが、安全な型チェックのためには型アサーションが必要。
void: 戻り値がないことを表す。
never: 決して戻らない関数の戻り値の型を表す。また、例外が発生することが明らかな場合などにも使用される。
Intersection types(交差型)
複数の型を結合することができる型です。2つ以上の型を&演算子でつなぐことで、新しい型を定義できます。
例えば、以下のように、Person型とSerializable型の両方のメンバーを持つSerializablePerson型を定義できます。
type Person = {
name: string;
age: number;
};
type Serializable = {
serialize: () => string;
};
type SerializablePerson = Person & Serializable;
SerializablePerson型は、Person型とSerializable型のメンバーを両方持っているため、以下のように定義できます。
const person: SerializablePerson = {
name: 'Alice',
age: 30,
serialize: () => JSON.stringify({ name: 'Alice', age: 30 })
};
intersection typesは、複数の型を結合することで、新しい型を作成することができるため、柔軟性の高い型定義が可能になります。例えば、オブジェクト型と関数型を結合して、オブジェクトにメソッドを持たせることができます。また、ジェネリクスと組み合わせて、より複雑な型を定義することもできます。
Union types(合併型)
複数の型のいずれか1つを表現する型です。2つ以上の型を|演算子でつなぐことで、新しい型を定義できます。
例えば、以下のように、number型とstring型を合併したNumOrStr型を定義できます。
type NumOrStr = number | string;
NumOrStr型は、number型かstring型のいずれかであるため、以下のような変数の定義が可能です。
const num: NumOrStr = 42;
const str: NumOrStr = 'hello';
union typesは、複数の型を結合することで、柔軟な型定義が可能になります。例えば、以下のように、複数の型を持つオブジェクトのプロパティを定義できます。
type Person = {
name: string;
age: number;
};
type Product = {
name: string;
price: number;
};
type Item = Person | Product;
const item1: Item = {
name: 'Alice',
age: 30
};
const item2: Item = {
name: 'Book',
price: 2000
};
union typesは、nullやundefinedを含むこともできます。この場合、nullableな型として扱われます。
type NullableString = string | null | undefined;
上記の例では、NullableString型は、string型、null、undefinedのいずれかであるため、文字列またはnull、またはundefinedを代入できます。
TypeScriptにおけるliteral types(リテラル型)は、具体的な値を表す型です。stringやnumberなどのプリミティブ型を、その値であるリテラル値として定義できます。
例えば、以下のように、string型のリテラル型である'hello'を定義できます。
const greeting: 'hello' = 'hello';
このように、greeting変数には、リテラル値'hello'しか代入できません。同様に、number型のリテラル型や、boolean型のリテラル型も定義できます。
const num: 42 = 42;
const isTrue: true = true;
また、リテラル型は、union typesと組み合わせることができます。例えば、以下のように、'hello'または'world'のいずれかであるHelloOrWorld型を定義できます。
type HelloOrWorld = 'hello' | 'world';
リテラル型は、具体的な値を表現するため、型の制約が強くなります。そのため、開発者が意図しない値を代入することを防ぐことができます。また、リテラル型を使用することで、コードの可読性が向上し、エラーの発生を防ぐことができます。
typeof演算子
実行時の値の型を取得するために使用されます。JavaScriptにもtypeof演算子があり、TypeScriptでも同様に使用できます。
typeof演算子は、次のように使用できます。
1.typeofキーワードとともに変数名を使用する方法
let foo = 42;
let bar = typeof foo; // barには、文字列"number"が代入される
2.typeof演算子とともに式を使用する方法
function foo() {
return "hello";
}
let bar = typeof foo; // barには、文字列"function"が代入される
この演算子は、プログラムの実行中に型のチェックを実行する場合や、ジェネリック型で使用される場合など、TypeScriptの多くの場面で役立ちます。
例えば、typeof演算子を使用して、オブジェクトの型をチェックし、必要に応じてそれに応じた処理を実行することができます。また、typeof演算子を使用することで、変数が期待される型と一致しない場合に、エラーを防止することができます。これにより、TypeScriptのより安全なコーディングを行うことができます。
keyofキーワード
オブジェクトのキーの型を取得するために使用されます。つまり、オブジェクトのプロパティ名を取得し、そのプロパティ名の型を返します。
以下は、keyofキーワードを使用してオブジェクトのキーの型を取得する例です。
interface Person {
name: string;
age: number;
gender: "male" | "female" | "other";
}
type PersonKeys = keyof Person; // "name" | "age" | "gender"
この例では、Personインターフェイスのプロパティ名を取得するために、keyofキーワードを使用しています。PersonKeys型は、"name"、"age"、および"gender"のリテラル型のユニオン型であり、Personインターフェースのキーの型を表します。
keyofキーワードは、ジェネリック型を定義する場合や、オブジェクトのプロパティを動的にアクセスする必要がある場合に特に役立ちます。また、keyofキーワードを使用して、TypeScriptの型安全性を高めることができます。例えば、以下のようなコードを書くことで、オブジェクトのプロパティ名のスペルミスを防ぐことができます。
function getProperty<T, K extends keyof T>(obj: T, key: K) {
return obj[key];
}
const person: Person = { name: "Alice", age: 30, gender: "female" };
const name = getProperty(person, "name"); // OK
const unknownKey = "foo";
const error = getProperty(person, unknownKey);
// Error: Argument of type 'string' is not assignable to parameter of type '"name" | "age" | "gender"'
この例では、getProperty関数は、オブジェクトobjとキーkeyを受け取り、objのkeyプロパティを返します。K extends keyof Tという型制約により、key引数はTオブジェクトのプロパティ名でなければなりません。この制約により、getProperty関数を呼び出すときに、オブジェクトのプロパティ名のスペルミスを防止することができます。
Enum(列挙型)
固定された一連の定数値を表す列挙型を定義するための機能です。
列挙型は、JavaScriptで数値や文字列などの定数を表現するための一般的な方法ですが、TypeScriptのEnumは、より強力な型安全性を提供します。Enumを使用することで、コンパイル時に値の妥当性を検証することができ、コードの読みやすさや保守性を向上させることができます。
例えば、以下のようにEnumを定義できます。
enum Color {
Red,
Green,
Blue,
}
この場合、Colorという列挙型が定義され、3つの要素(Red、Green、Blue)が含まれています。要素にはデフォルトで0から始まる連続した整数値が割り当てられます。この列挙型を使用すると、以下のようにコードを書くことができます。
let backgroundColor = Color.Red;
この場合、backgroundColorにはRedという名前に対応する数値0が割り当てられます。また、以下のように列挙型の要素を使用することもできます。
if (backgroundColor === Color.Green) {
console.log("The background color is green");
} else {
console.log("The background color is not green");
}
このように、列挙型を使用すると、コードをより読みやすく、保守性が高く、バグの発生を減らすことができます。
型の互換性
2つの型が互いに互換性があるかどうかを判断するルールです。これは、TypeScriptコンパイラがコードを検証する際に使用されます。
TypeScriptにおいて、ある型が別の型に互換性があると判断されるためには、次のルールに従う必要があります。
- 型Aが型Bに代入可能である場合、型Bは型Aと互換性があると判断されます。
- 型Aと型Bが同じ型である場合、型Aと型Bは互換性があると判断されます。
- 型Aが型Bのサブタイプである場合、型Aと型Bは互換性があると判断されます。これは、型Aが型Bで定義されているすべてのメンバーを含む場合に発生します。
- 関数の場合、引数リストの型が同じである場合、または引数リストの各引数の型が対応する位置で互換性がある場合、2つの関数型は互換性があると判断されます。
以下は、これらのルールに従って、いくつかの型が互換性があるかどうかを判断する例です。
let x: string;
let y: "foo" | "bar";
// string型は"foo" | "bar"型のサブタイプであるため、代入可能
y = x;
// "foo"型は"foo" | "bar"型に代入可能
let z: "foo" = y;
type Func = (x: number) => void;
function foo(callback: Func) {
callback(1);
}
// 引数の型が一致するため、以下の2つの関数型は互換性がある
foo((x: number) => console.log(x));
foo((y: number) => console.log(y));
型の互換性は、TypeScriptが静的型付けの恩恵を受けることができる一方で、柔軟性も提供します。このため、TypeScriptの型システムは、プログラマーにとって非常に有用な機能です。
ジェネリック(Generics)
複数の型に対して動作するように設計された汎用的なコードを作成するための機能です。
ジェネリックは、関数やクラスを定義する際に使用することができます。具体的には、関数やクラスに型パラメータを追加することで、汎用的なコードを作成することができます。
以下は、ジェネリックを使用して、配列の要素を反転する関数を定義する例です。
function reverse<T>(arr: T[]): T[] {
return arr.reverse();
}
let arr1 = [1, 2, 3, 4];
let arr2 = ["hello", "world"];
let reversedArr1 = reverse(arr1); // [4, 3, 2, 1]
let reversedArr2 = reverse(arr2); // ["world", "hello"]
この例では、reverse関数の引数にT[]という型パラメータを指定しています。これにより、関数が受け取る配列の型が汎用的になります。
このように、ジェネリックを使用することで、型に依存しない汎用的なコードを作成することができます。
ジェネリックは、TypeScriptで高度な型安全性を実現するためにも使用されます。
ジェネリックを使用することで、型推論や型制約などの機能を利用して、コンパイラがコードをより安全に検証できるようになります。
ジェネリックを使用することで、より柔軟なコードを作成することができ、
TypeScriptの強力な静的型付けシステムを活用することができます。
ジェネリックスを使用して、stringまたはnumber型のみを受け入れる関数の例
function processStringOrNumber<T extends string | number>(value: T): void {
// valueの処理
}
この例では、Tをstringまたはnumberのいずれかの型に制限することにより、
processStringOrNumber関数が引数としてstringまたはnumberのいずれかの型のみを受け入れることができます。
例えば、以下のような呼び出しが可能です。
processStringOrNumber("hello"); // OK
processStringOrNumber(42); // OK
processStringOrNumber(true); // コンパイルエラー: 'boolean'型は'string'または'number'型ではありません。
このように、ジェネリックスを使用することで、特定の型のみを受け入れる関数を定義できます。
JSON型推論
JSONデータを解析し、そのデータに基づいて型を推論することを指します。
具体的には、TypeScriptはJSONデータを解析し、そのデータの構造に基づいて、型定義を自動的に作成することができます。これにより、開発者は手動で型定義を記述する必要がなくなり、コードの書きやすさと保守性が向上します。
例えば、以下のようなJSONデータがあるとします。
{
"name": "John Smith",
"age": 30,
"isMarried": true
}
TypeScriptは、このデータを解析し、次のような型定義を推論することができます。
type Data = {
name: string;
age: number;
isMarried: boolean;
}
これにより、開発者はData型を使用して、このJSONデータに対する型安全なコードを書くことができます。
【関数の定義】
1.基本的な書き方
TypeScriptでの関数の書き方は、JavaScriptと同様に「function」キーワードを用います。ただし、引数や戻り値の型を指定することができます。
function add(a: number, b: number): number {
return a + b;
}
この例では、引数「a」と「b」はともに「number」型であり、戻り値も「number」型であることが指定されています。
2.デフォルト引数の指定
TypeScriptでは、デフォルト引数を指定することができます。これにより、引数を省略した場合にデフォルト値が代入されます。
function greet(name: string = 'World'): void {
console.log(`Hello, ${name}!`);
}
この例では、引数「name」のデフォルト値を「'World'」と指定しています。引数を省略した場合には、「name」に「'World'」が代入されます。
【クラスの定義】
1.基本的な書き方
TypeScriptでのクラスの書き方は、JavaScriptと同様に「class」キーワードを用います。クラスの中には、メソッドやプロパティを定義することができます。例えば、以下のように書くことができます。
class Person {
private name: string;
constructor(name: string) {
this.name = name;
}
public greet(): void {
console.log(`Hello, my name is ${this.name}.`);
}
}
この例では、「Person」というクラスを定義しています。このクラスには、「name」というプライベートなプロパティと、「greet」というパブリックなメソッドが定義されています。そして、「constructor」メソッドを使ってインスタンスを作成することができます。
const person = new Person('John');
person.greet(); // "Hello, my name is John."
この例では、Personクラスからインスタンスを作成し、そのインスタンスの「greet」メソッドを呼び出しています。この呼び出しによって、「Hello, my name is John.」というメッセージがコンソールに出力されます。
補足
classキーワードを使ってクラスを定義し、中括弧 {} 内にプロパティやメソッドを定義します。クラス名、プロパティ名、メソッド名は、キャメルケースで書きます。
プロパティの定義では、プロパティ名の後ろにコロン : を付け、その後にプロパティの型を指定します。プロパティの型は、JavaScriptのプリミティブ型(number、string、boolean、null、undefined)、オブジェクト型(object)、配列型(Array)、または他のクラス型などが使えます。
コンストラクターの定義では、constructorキーワードを使ってコンストラクターを定義します。引数を受け取る場合は、引数の型を指定します。コンストラクター内では、インスタンスを初期化する処理を書きます。
メソッドの定義では、メソッド名の後ろに括弧 () を付け、その後に引数の型を指定します。引数を受け取らない場合は、空の括弧 () を付けます。また、メソッドの戻り値の型を指定することができます。メソッド内では、処理を書き、戻り値を返すことができます。
class クラス名 {
// プロパティの定義
プロパティ名: プロパティの型;
// コンストラクターの定義
constructor(引数: 引数の型) {
// 初期化処理
}
// メソッドの定義
メソッド名(引数: 引数の型): 戻り値の型 {
// 処理
return 戻り値;
}
}
クラス定義を行った後は、このクラスをインスタンス化して利用することができます。例えば、以下のように書くことでインスタンスを生成できます。
const インスタンス名 = new クラス名(引数);
このようにして生成されたインスタンスは、クラス内で定義されたメソッドやプロパティにアクセスすることができます。
【クラスの承継】
親クラスと子クラスを定義し、子クラスが親クラスのプロパティやメソッドを利用できるようにします。
MyClassという名前のクラスを定義しています。クラス内には、propertyという文字列型のプロパティ、constructorという引数を受け取るコンストラクタ、methodという戻り値のないメソッドを定義しています。クラス内のプロパティやメソッドには、アクセス修飾子を付けることもできます。
class MyClass {
property: string;
constructor(arg: string) {
this.property = arg;
}
method(): void {
console.log(`This is ${this.property}.`);
}
}
クラスには継承という機能があります。継承とは、あるクラスから他のクラスを作成することで、元のクラスのプロパティやメソッドを受け継ぐことができます。継承を利用する場合の基本的な書き方は以下の通りです。
class ParentClass {
parentMethod(): void {
console.log("This is parent method.");
}
}
class ChildClass extends ParentClass {
childMethod(): void {
console.log("This is child method.");
}
}
const instance = new ChildClass();
instance.parentMethod(); // This is parent method.
instance.childMethod(); // This is child method.
ParentClassという親クラスを定義し、ChildClassという子クラスを定義しています。子クラスの定義にはextendsキーワードを使用します。そして、ChildClassはParentClassを継承するため、親クラスのparentMethod()メソッドを利用することができます。
サンプル
Animalという親クラスを定義しています。Animalクラスには、nameというプロパティと、move()というメソッドがあります。そして、Dogという子クラスを定義しています。DogクラスはextendsキーワードでAnimalクラスを継承し、Animalクラスのプロパティとメソッドを利用することができます。Dogクラスには、bark()というメソッドが追加されています。
class Animal {
name: string;
constructor(name: string) {
this.name = name;
}
move(distanceInMeters: number = 0) {
console.log(`${this.name} moved ${distanceInMeters}m.`);
}
}
class Dog extends Animal {
constructor(name: string) {
super(name);
}
bark() {
console.log('Woof! Woof!');
}
}
const myDog = new Dog('Pochi');
myDog.bark(); // "Woof! Woof!"
myDog.move(10); // "Pochi moved 10m."
まず、Animalクラスが定義されています。Animalクラスにはnameプロパティとmoveメソッドがあります。moveメソッドは、動物が移動した距離をコンソールに出力するためのものです。
次に、Dogクラスが定義されています。Dogクラスは、Animalクラスを継承しています。Dogクラスはbarkメソッドを持っていますが、Animalクラスのmoveメソッドは継承されます。
最後に、myDogという変数が定義されています。これは、Dogクラスのインスタンスであり、Pochiという名前で作成されます。myDog.bark()が呼び出されると、Woof! Woof!という文字列が出力されます。また、myDog.move(10)が呼び出されると、Pochi moved 10m.という文字列が出力されます。
これにより、DogクラスがAnimalクラスから継承されたmoveメソッドを持っていることがわかります。そして、Dogクラスにはbarkメソッドが追加されています。
子クラスで親クラスのメソッドをオーバーライドすることもできます。以下のように、Dogクラスのmove()メソッドをオーバーライドしています。super.move()とすることで、親クラスのmove()メソッドを呼び出すことができます。また、引数としてdistanceInMetersを受け取っていますが、デフォルト値を5にしています。
class Dog extends Animal {
// ...
move(distanceInMeters: number = 5) {
console.log('Running...');
super.move(distanceInMeters);
}
}
このコードでは、DogクラスがAnimalクラスを継承しています。そして、Dogクラスにはmoveメソッドが定義されています。
moveメソッドは、引数としてdistanceInMetersを受け取り、デフォルト値として5が指定されています。moveメソッドの中で、まずconsole.logで"Running..."という文字列が出力されます。そして、super.move(distanceInMeters)という文が実行され、親クラスであるAnimalクラスのmoveメソッドが呼び出されます。superキーワードは、親クラスを参照するために使用されます。super.move(distanceInMeters)では、AnimalクラスのmoveメソッドにdistanceInMetersを渡して呼び出しています。
このように、DogクラスはAnimalクラスのメソッドを再利用しつつ、独自の機能を追加することができます。親クラスにあるメソッドの振る舞いを変更したい場合は、子クラスで同じ名前のメソッドを再定義し、その中でsuperを使って親クラスのメソッドを呼び出すことができます。
タプルの例
TypeScriptにおけるタプルは、固定長で構成される複数の異なる型の値を持つ配列のようなデータ構造です。
let person: [string, number] = ['Alice', 30];
この例では、personという名前のタプルが宣言されています。このタプルは、1つ目の要素にstring型の'Alice'、2つ目の要素にnumber型の30を持ちます。タプルの要素の型と順序は宣言時に固定されます。
タプルの要素には、配列と同様にインデックスを用いてアクセスすることができます。以下は、タプルの要素にアクセスする例です。
console.log(person[0]); // 'Alice'
console.log(person[1]); // 30
また、タプルは配列と同様に分割代入が可能です。以下は、タプルの分割代入の例です。
let [name, age] = person;
console.log(name); // 'Alice'
console.log(age); // 30
配列やオブジェクトの中の値を取り出して、それぞれ別々の変数に代入するための構文です。
この例では、配列personの最初の要素がnameに、2番目の要素がageにそれぞれ代入されています。配列の要素には、それぞれ型が定義されているため、nameには文字列型の値'Alice'が、ageには数値型の値30が代入されます。
このように、タプルは複数の異なる型の値を持つ固定長の配列のようなデータ構造であり、要素の型と順序が宣言時に固定されます。
例).AWS Lake Formation CDK(Cloud Development Kit)を使用して、AWS Lake Formationサービスの構成を定義するTypeScript
AWS Lake Formationサービスによって管理されるGlueのジョブを定義する
import * as cdk from 'aws-cdk-lib';
import * as lakeformation from 'aws-cdk-lib/aws-lakeformation';
import * as iam from 'aws-cdk-lib/aws-iam';
import * as glue from 'aws-cdk-lib/aws-glue';
const app = new cdk.App();
// AWS Lake Formationのデータベースを作成
const database = new lakeformation.CfnDataLakeSettings(app, 'Database', {
adminResourceRole: 'arn:aws:iam::123456789012:role/lakeformation-admin-role',
trustedResourceOwners: ['123456789012'],
});
// AWS Lake Formationのリソースアクセスを制御するIAMロールを作成
const lakeFormationRole = new iam.Role(app, 'LakeFormationRole', {
assumedBy: new iam.ServicePrincipal('lakeformation.amazonaws.com'),
});
// IAMロールにポリシーを追加して、AWS Lake FormationサービスのAPIへのアクセスを許可
lakeFormationRole.addToPolicy(new iam.PolicyStatement({
effect: iam.Effect.ALLOW,
resources: ['*'],
actions: [
'lakeformation:GetDataLakeSettings',
'lakeformation:GetEffectivePermissionsForPath',
'lakeformation:GrantPermissions',
'lakeformation:RevokePermissions',
],
}));
// AWS Glueのジョブを作成
const glueJob = new glue.CfnJob(app, 'GlueJob', {
command: {
name: 'glueetl',
scriptLocation: 's3://my-bucket/my-script.py',
},
defaultArguments: {
'--job-bookmark-option': 'job-bookmark-enable',
'--enable-continuous-cloudwatch-log': 'true',
},
});
// AWS Lake Formationサービスを使用して、AWS Glueのジョブにアクセスを許可
const permission = new lakeformation.CfnPermissions(app, 'GlueJobPermissions', {
principal: 'arn:aws:iam::123456789012:role/lakeformation-role',
resource: glueJob.attrArn,
permissions: ['ALL'],
});
// CDKスタックをデプロイ
cdk.Tags.of(app).add('Stack', 'LakeFormationCDKExample');
app.synth();
この例では、AWS Lake Formationのデータベース、リソースアクセスを制御するIAMロール、AWS Glueのジョブを定義しています。また、AWS Lake FormationサービスによってAWS Glueのジョブにアクセスを許可するための許可を定義しています。
AWS Lake Formationサービスによって管理されるデータベースとテーブルを定義する
import * as cdk from 'aws-cdk-lib';
import * as lakeformation from 'aws-cdk-lib/aws-lakeformation';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as glue from 'aws-cdk-lib/aws-glue';
const app = new cdk.App();
// S3バケットを作成
const bucket = new s3.Bucket(app, 'Bucket');
// AWS Lake Formationのデータベースを作成
const database = new lakeformation.CfnDataLakeSettings(app, 'Database', {
adminResourceRole: 'arn:aws:iam::123456789012:role/lakeformation-admin-role',
trustedResourceOwners: ['123456789012'],
});
// AWS Glueのデータベースを作成
const glueDatabase = new glue.Database(app, 'GlueDatabase', {
databaseName: 'my-database',
});
// AWS Lake Formationサービスを使用して、AWS Glueのデータベースにアクセスを許可
const permission = new lakeformation.CfnPermissions(app, 'DatabasePermissions', {
principal: 'arn:aws:iam::123456789012:role/lakeformation-role',
resource: glueDatabase.databaseArn,
permissions: ['ALL'],
});
// AWS Glueのテーブルを作成
const glueTable = new glue.CfnTable(app, 'GlueTable', {
databaseName: glueDatabase.databaseName,
catalogId: '123456789012',
tableInput: {
name: 'my-table',
storageDescriptor: {
columns: [
{ name: 'id', type: 'bigint' },
{ name: 'name', type: 'string' },
{ name: 'age', type: 'int' },
],
location: `s3://${bucket.bucketName}/my-table`,
inputFormat: 'org.apache.hadoop.mapred.TextInputFormat',
outputFormat: 'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat',
compressed: false,
serdeInfo: {
serializationLibrary: 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe',
parameters: { 'serialization.format': '1' },
},
},
},
});
// AWS Lake Formationサービスを使用して、AWS Glueのテーブルにアクセスを許可
const tablePermission = new lakeformation.CfnPermissions(app, 'TablePermissions', {
principal: 'arn:aws:iam::123456789012:role/lakeformation-role',
resource: `arn:aws:glue:${cdk.Aws.REGION}:${cdk.Aws.ACCOUNT_ID}:table/${glueDatabase.databaseName}/${glueTable.tableName}`,
permissions: ['ALL'],
});
// CDKスタックをデプロイ
cdk.Tags.of(app).add('Stack', 'LakeFormationCDKExample');
app.synth();
AWS CDKとAWS Lake Formation、AWS S3、AWS Glueのライブラリをインポートします。次に、AWS S3バケット、AWS Lake Formationデータベース、AWS Glueデータベースを作成します。AWS Lake Formationサービスを使用して、AWS Glueデータベースとテーブルにアクセスするためのアクセス許可を設定します。最後に、AWS CDKを使用してスタックをデプロイします。
この例では、AWS Lake Formationサービスを使用して、AWS Glueデータベースとテーブルにアクセス許可を設定しています。これにより、AWS Lake Formationサービスを使用して、AWS Glueデータベースとテーブルのアクセスをより制御的に管理できます。
例).CloudWatchから取得したApacheプロセス数が200を超えた場合にSlackに通知する
//必要なモジュールをインポート
import { CloudWatch } from 'aws-sdk';
import { IncomingWebhook } from '@slack/webhook';
import { ScheduledEvent } from 'aws-lambda';
//初期化
const cloudwatch = new CloudWatch();
const webhook = new IncomingWebhook('https://hooks.slack.com/services/XXXXXXXX');
//Lambda関数の本体を定義
export const handler = async (event: ScheduledEvent) => {
const metrics = await cloudwatch.getMetricStatistics({
Namespace: 'AWS/EC2',
MetricName: 'HTTPD Processes',
Dimensions: [
{
Name: 'InstanceId',
Value: 'i-1234567890abcdef0'
}
],
StartTime: new Date(new Date().getTime() - 600000),
EndTime: new Date(),
Period: 60,
Statistics: ['Maximum']
}).promise();
const maxProcesses = metrics.Datapoints[0].Maximum;
console.log(`Maximum number of Apache processes: ${maxProcesses}`);
if (maxProcesses >= 200) {
await webhook.send({
text: `The number of Apache processes has exceeded 200: ${maxProcesses}`
});
}
};
この例では、CloudWatchメトリックスからApacheのプロセス数を取得し、200以上であればSlack通知を送信するようになっています。
'https://hooks.slack.com/services/XXXXXXXX'の部分には、SlackのWebhook URLを指定する必要があります。
また、'i-1234567890abcdef0'の部分には、Apacheが実行されているEC2インスタンスのIDを指定する必要があります。
export const handlerでLambda関数の本体を定義しています。引数には、ScheduledEventを指定しています。
このLambda関数は、CloudWatchのメトリックスからApacheのプロセス数を取得し、200以上であればSlack通知を送信するようになっています。
具体的には、cloudwatch.getMetricStatistics()でCloudWatchのメトリックスを取得し、
const maxProcesses = metrics.Datapoints[0].Maximumで最大プロセス数を取得しています。
そして、if (maxProcesses >= 200)でプロセス数が200以上であれば、Slack通知を送信するようになっています。
Slack通知は、webhook.send()で送信されます。
TypeScriptの一般的な環境構築手順
Node.jsのインストール
TypeScriptは、Node.jsの上で動作するため、Node.jsのインストールが必要。
Node.jsのインストール手順
Node.jsのダウンロード
Node.jsの公式サイト(https://nodejs.org/)から、自分のOSに合ったインストーラーをダウンロードしてください。Windowsの場合は「Windows Installer (.msi)」を、Macの場合は「macOS Installer (.pkg)」をダウンロードします。
インストールの実行
ダウンロードしたインストーラーを実行して、指示に従ってインストールを進めます。通常はデフォルトの設定で問題ありませんが、必要に応じてカスタマイズすることもできます。
インストールの確認
インストールが完了したら、以下のコマンドを実行してバージョンを確認します。
node -v
バージョンが表示されれば、Node.jsのインストールが正しく行われています。
TypeScriptのインストール
npmコマンドを使用して、TypeScriptをインストールします。コマンドラインで以下のコマンドを実行してください。
npm install -g typescript
プロジェクトの作成
任意のディレクトリで、以下のコマンドを実行して、新しいプロジェクトを作成してください。
mkdir my-project
cd my-project
tsconfig.jsonの作成
TypeScriptのコンパイルオプションを設定するために、tsconfig.jsonファイルを作成します。以下のコマンドを実行して、tsconfig.jsonファイルを作成してください。
tsc --init
コンパイルの実行
TypeScriptファイルを作成し、以下のコマンドを実行することで、JavaScriptファイルにコンパイルすることができます。
tsc your-file.ts
このようにして、TypeScriptの環境を構築することができます。
また、Visual Studio Codeなどのエディタを使用する場合は、TypeScriptの拡張機能をインストールすることで、開発効率を向上させることができます。
TypeScriptでLambda関数を作成する方法
1. AWS CLIを使用して、Lambda関数を作成するために必要な基本的な構成要素を設定します。
AWS CLIを使用して、Lambda関数を作成するために必要なIAMロールを作成することもできます。
2. TypeScriptでLambda関数を作成する場合は、AWS SDK for JavaScriptを使用して、
必要なLambda関数用のパッケージをインストールする必要があります。
npm install aws-sdk
npm install aws-lambda
3. TypeScriptでLambda関数を書くために、handler.tsのようなファイルを作成し、以下のようなコードを記述します。
import { APIGatewayProxyEvent, APIGatewayProxyResult, Context } from 'aws-lambda';
export async function handler(event: APIGatewayProxyEvent, context: Context): Promise<APIGatewayProxyResult> {
// ハンドラーの処理
return {
statusCode: 200,
body: JSON.stringify({ message: 'Hello, TypeScript Lambda!' })
};
}
最初の行は、aws-lambdaパッケージから必要な型をインポートしています。これにより、ハンドラーに渡されるイベント、コンテキスト、およびレスポンスの型を指定できます。
次の行は、handler関数を宣言しています。この関数は、APIGatewayProxyEventとContextの2つのパラメータを受け取り、Promiseを返します。APIGatewayProxyEventは、API GatewayからLambda関数に送信されるHTTPリクエストの詳細を含みます。Contextは、Lambda関数の実行環境に関する情報を提供します。
この関数内の実際の処理は、Lambda関数が実行されたときに実行されるコードになります。上記の例では、Lambda関数がHTTP 200ステータスコードとJSON形式のメッセージを返すようになっています。
最後に、exportキーワードを使用して、この関数を外部に公開しています。これにより、AWS Lambdaがこの関数を呼び出すことができるようになります。
4. TypeScriptのビルドプロセスを設定します。これには、TypeScriptコンパイラを使用して、.tsファイルを.jsファイルに変換する必要があります。
TypeScriptコンパイラを使用して、.tsファイルを.jsファイルに変換する手順
TypeScriptコンパイラをインストールするために、Node.jsのパッケージマネージャーであるnpmを使用します。
npmをインストールしていない場合は、Node.jsの公式ウェブサイトからインストールできます。
-
コンパイルしたいTypeScriptファイルを用意します。例えば、app.tsというファイルを用意します。
-
TypeScriptコンパイラを使用して、.tsファイルを.jsファイルに変換します。以下のコマンドを使用します。
tsc app.ts
このコマンドは、TypeScriptコンパイラを呼び出して、app.tsファイルをJavaScriptのapp.jsファイルに変換します。
tscコマンドは、TypeScriptコンパイラのバイナリファイルをインストールしている必要があります。
- TypeScriptコンパイラが出力するJavaScriptファイルを実行します。例えば、以下のコマンドを使用して、app.jsファイルを実行します。
node app.js
5. Lambda関数をデプロイします。これには、AWS CLIまたはAWS Consoleを使用して、Lambda関数をパッケージ化し、AWS Lambdaにアップロードする必要があります。
AWS CLIを使用した方法
- パッケージ化
Lambda関数のコードをzipにパッケージ化します。
zip function.zip index.js
ここで、index.jsはLambda関数のエントリーポイントファイルです。
パッケージ化するファイルが複数ある場合は、index.jsの部分を適宜変更してください。
- アップロード
zipファイルをAWS Lambdaにアップロードします。
aws lambda create-function --function-name my-function --runtime nodejs14.x --role arn:aws:iam::123456789012:role/lambda-role --handler index.handler --zip-file fileb://function.zip
ここで、my-functionはLambda関数の名前、nodejs14.xはランタイム、arn:aws:iam::123456789012:role/lambda-roleはLambda関数にアクセス権限を付与するIAMロールのARN、index.handlerはエントリーポイント関数、function.zipはパッケージ化されたzipファイルのパスを指定しています。
AWS Consoleを使用した方法
-
パッケージ化
AWS ConsoleからLambda関数の画面にアクセスし、コードエディタを開きます。
必要なファイルをアップロードするか、エディタに直接貼り付けて編集します。 -
アップロード
コードエディタの左上にある「保存」ボタンをクリックし、保存します。
「保存してデプロイ」ボタンをクリックして、Lambda関数をデプロイします。