メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::DMS::Endpoint

AWS::DMS::Endpoint リソースは AWS DMS エンドポイントを作成します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type": "AWS::DMS::Endpoint", "Properties": { "CertificateArn": String, "DatabaseName": String, "DynamoDbSettings": DynamoDbSettings, "EndpointIdentifier": String, "EndpointType": String, "EngineName": String, "ExtraConnectionAttributes": String, "KmsKeyId": String, "MongoDbSettings": MongoDbSettings, "Password": String, "Port": Integer, "S3Settings": S3Settings, "ServerName": String, "SslMode": String, "Tags": [ Resource Tag, ... ], "Username": String } }

YAML

Copy
Type: "AWS::DMS::Endpoint" Properties: CertificateArn: String DatabaseName: String DynamoDbSettings: DynamoDbSettings EndpointIdentifier: String EndpointType: String EngineName: String ExtraConnectionAttributes: String KmsKeyId: String MongoDbSettings: MongoDbSettings Password: String Port: Integer S3Settings: S3Settings ServerName: String SslMode: String Tags: - Resource Tag Username: String

プロパティ

CertificateArn

証明書の Amazon リソースナンバー (ARN) です。

Required: No

Type: String

更新に伴う要件: 中断はありません。

DatabaseName

エンドポイントデータベースの名前です。

Required: No

Type: String

更新に伴う要件: 中断はありません。

DynamoDbSettings

ターゲット DynamoDB エンドポイントの JSON フォーマットでの設定。利用可能な設定に関する詳細については、「AWS Database Migration Service で Amazon DynamoDB データベースをターゲットとして使用する」の「DynamoDB にデータを移行するためのオブジェクトマッピングの使用」セクションを参照してください。

Required: No

タイプ: AWS DMS エンドポイント DynamoDBSettings

更新に伴う要件: 中断はありません。

EndpointIdentifier

データベースエンドポイント識別子です。識別子は文字で開始し、ASCII 文字、数字、ハイフンのみを使用できます。最後の文字をハイフンにすることはできず、ハイフンを 2 つ続けて使用することもできません。

Required: No

Type: String

更新に伴う要件: 中断はありません。

EndpointType

エンドポイントの種類です。有効な値は、source および target です。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

EngineName

エンドポイントのエンジンタイプ。有効な値は、EndPointType に依存し、MYSQLORACLEPOSTGRESMARIADBAURORAREDSHIFTS3SYBASEDYNAMODBMONGODB、および SQLSERVER があります。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

ExtraConnectionAttributes

接続に関連付けられた追加の属性です。

Required: No

Type: String

更新に伴う要件: 中断はありません。

KmsKeyId

接続パラメータの暗号化に使用される KMS キー識別子です。KmsKeyId パラメータに値を指定しない場合、AWS DMS はデフォルトの暗号化キーを使用します。AWS KMS は、AWS アカウント用にデフォルトの暗号化キーを作成します。AWS アカウントには、AWS のリージョンごとにデフォルトの暗号化キーがあります。

Required: No

Type: String

更新に伴う要件: 置換

MongoDbSettings

ソース MongoDB エンドポイントの JSON フォーマットでの設定。利用可能な設定に関する詳細については、「AWS Database Migration Service のターゲットとして Amazon S3 を使用する」の「MongoDB を AWS Database Migration Service のソースとして使用する場合の設定プロパティ」を参照してください。

Required: No

タイプ: AWS DMS エンドポイント MongoDbSettings

更新に伴う要件: 中断はありません。

Password

エンドポイントデータベースへのログインに使用するパスワードです。このパラメータは直接使用しないでください。「パラメータ」で示されている通り、Password を入力パラメータとして noEcho と使用します。ベストプラクティス情報については、「テンプレートに認証情報を埋め込まない」を参照してください。

Required: No

Type: String

更新に伴う要件: 中断はありません。

Port

エンドポイントデータベースが使用するポートです。

Required: No

Type: Integer

更新に伴う要件: 中断はありません。

S3Settings

ターゲット Amazon S3 エンドポイントの JSON フォーマットでの設定。利用可能な設定に関する詳細については、AWS Database Migration Service ユーザーガイド の「AWS Database Migration Service のターゲットとして Amazon S3 を使用する」にある「追加の接続属性」を参照してください。

Required: No

タイプ: AWS DMS エンドポイントの S3 設定

更新に伴う要件: 中断はありません。

ServerName

エンドポイントデータベースが存在するサーバー名です。

Required: No

Type: String

更新に伴う要件: 中断はありません。

SslMode

SSL 接続に使用する SSL モードです。

SSL モードは、nonerequireverify-caverify-full の 4 つの値のいずれかになります。デフォルト値は none です。

Required: No

Type: String

更新に伴う要件: 中断はありません。

Tags

DMS エンドポイントにアタッチするタグ。

Required: No

タイプ: キーと値の形式の「リソースタグ」のリスト。

更新に伴う要件: 置換

Username

エンドポイントデータベースへのログインに使用するユーザー名です。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

戻り値

参照番号

AWS::DMS::Endpoint リソースの論理 ID を組み込み Ref 関数に渡すと、関数はエンドポイントの ARN を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

JSON

Copy
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "myBasicEndpoint": { "Type": "AWS::DMS::Endpoint", "Properties": { "EngineName": "mysql", "EndpointType": "source", "Username": "username", "Password": { "Ref": "PasswordParameter" }, "ServerName": "source.db.amazon.com", "Port": 1234, "DatabaseName": "source-db" } } } }

YAML

Copy
AWSTemplateFormatVersion: 2010-09-09 Description: "Endpoint test" Resources: BasicEndpoint: Type: "AWS::DMS::Endpoint" Properties: EngineName: "mysql" EndpointType: "target" Username: "username" Password: !Ref PasswordParameter ServerName: "server.db.amazon.com" Port: 1234 DatabaseName: "my-db" Tags: - Key: "type" Value: "new"

以下の資料も参照してください。