Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::DMS::Endpoint

The AWS::DMS::Endpoint resource creates an AWS DMS endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

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

Properties

CertificateArn

The Amazon Resource Number (ARN) for the certificate.

Required: No

Type: String

Update requires: No interruption

DatabaseName

The name of the endpoint database.

Required: No

Type: String

Update requires: No interruption

DynamoDbSettings

Settings in JSON format for the target DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Required: No

Type: AWS DMS Endpoint DynamoDBSettings

Update requires: No interruption

EndpointIdentifier

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Required: No

Type: String

Update requires: No interruption

EndpointType

The type of endpoint. Valid values are source and target.

Required: Yes

Type: String

Update requires: No interruption

EngineName

The type of engine for the endpoint. Valid values depend on the EndPointType and include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Required: Yes

Type: String

Update requires: No interruption

ExtraConnectionAttributes

Additional attributes associated with the connection.

Required: No

Type: String

Update requires: No interruption

KmsKeyId

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

Required: No

Type: String

Update requires: Replacement

MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Required: No

Type: AWS DMS Endpoint MongoDbSettings

Update requires: No interruption

Password

The password to be used to login to the endpoint database. Do not use this parameter directly. Use Password as an input parameter with noEcho as shown in the Parameters. For best practices information, see Do Not Embed Credentials in Your Templates.

Required: No

Type: String

Update requires: No interruption

Port

The port used by the endpoint database.

Required: No

Type: Integer

Update requires: No interruption

S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

Required: No

Type: AWS DMS Endpoint S3Settings

Update requires: No interruption

ServerName

The name of the server where the endpoint database resides.

Required: No

Type: String

Update requires: No interruption

SslMode

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.

Required: No

Type: String

Update requires: No interruption

Tags

The tags that you want to attach to the DMS endpoint.

Required: No

Type: List of resource tags in key-value format

Update requires: Replacement

Username

The user name to be used to login to the endpoint database.

Required: Yes

Type: String

Update requires: No interruption

Return Value

Ref

When you pass the logical ID of an AWS::DMS::Endpoint resource to the intrinsic Ref function, the function returns the ARN of the endpoint.

For more information about using the Ref function, see Ref.

Example

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"

See Also