AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

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 格式)。有关可用设置的更多信息,请参阅将 Amazon DynamoDB 数据库用作 AWS Database Migration Service 的目标中的使用对象映射将数据迁移到 DynamoDB 部分。

Required: No

Type: AWS DMS 终端节点 DynamoDBSettings

更新要求无需中断

EndpointIdentifier

数据库终端节点标识符。标识符必须以字母开头,只能包含 ASCII 字母、数字和连字符,并且不能以连字符结尾或包含两个连续的连字符。

Required: No

Type: String

更新要求无需中断

EndpointType

终端节点的类型。有效值为 sourcetarget

Required: Yes

Type: String

更新要求无需中断

EngineName

终端节点的引擎的类型。有效值取决于 EndPointType,包括 MYSQLORACLEPOSTGRESMARIADBAURORAREDSHIFTS3SYBASEDYNAMODBMONGODBSQLSERVER

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 格式)。有关可用设置的更多信息,请参阅将 Amazon S3 用作 AWS Database Migration Service 的目标中的使用 MongoDB 作为 AWS Database Migration Service 的源时的配置属性部分。

Required: No

Type: AWS DMS 终端节点 MongoDbSettings

更新要求无需中断

Password

用于登录终端节点数据库的密码。请不要直接使用此参数。使用 Password 作为带 noEcho 的输入参数,如参数中所示。有关最佳实践信息,请参阅请不要将凭证嵌入您的模板中

Required: No

Type: String

更新要求无需中断

Port

终端节点数据库所使用的端口。

Required: No

Type: Integer

更新要求无需中断

S3Settings

目标 Amazon S3 终端节点的设置 (JSON 格式)。有关可用设置的更多信息,请参阅 AWS Database Migration Service 用户指南 中的将 Amazon S3 用作 AWS Database Migration Service 的目标中的额外的连接属性部分。

Required: No

Type: AWS DMS 终端节点 S3Settings

更新要求无需中断

ServerName

终端节点数据库驻留于的服务器的名称。

Required: No

Type: String

更新要求无需中断

SslMode

要用于 SSL 连接的 SSL 模式。

SSL 模式可以是以下四个值之一:nonerequireverify-caverify-full。默认值为 none

Required: No

Type: String

更新要求无需中断

Tags

要附加到 DMS 终端节点的标签。

Required: No

类型资源标签 (键/值格式) 的列表

更新要求替换

Username

要用于登录终端节点数据库的用户名。

Required: Yes

Type: String

更新要求无需中断

返回值

Ref

当您将 AWS::DMS::Endpoint 资源的逻辑 ID 传递给内部 Ref 函数时,此函数将返回终端节点的 ARN。

有关使用 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"

另请参阅