AWS::DMS::Endpoint - AWS CloudFormation

AWS::DMS::Endpoint

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

Currently, the only endpoint setting types that AWS CloudFormation supports are DynamoDBSettings, ElasticSearchSettings, and NeptuneSettings.

Syntax

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

Properties

CertificateArn

The Amazon Resource Name (ARN) for the certificate.

Required: No

Type: String

Update requires: No interruption

DatabaseName

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

Required: No

Type: String

Update requires: No interruption

DocDbSettings

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

Required: No

Type: DocDbSettings

Update requires: No interruption

DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

Required: No

Type: DynamoDbSettings

Update requires: No interruption

ElasticsearchSettings

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

Required: No

Type: ElasticsearchSettings

Update requires: No interruption

EndpointIdentifier

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't 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

Allowed values: source | target

Update requires: No interruption

EngineName

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".

Required: Yes

Type: String

Update requires: No interruption

ExtraConnectionAttributes

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.

Required: No

Type: String

Update requires: No interruption

IbmDb2Settings

Not currently supported by AWS CloudFormation.

Required: No

Type: IbmDb2Settings

Update requires: No interruption

KafkaSettings

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide.

Required: No

Type: KafkaSettings

Update requires: No interruption

KinesisSettings

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

Required: No

Type: KinesisSettings

Update requires: No interruption

KmsKeyId

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses 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

MicrosoftSqlServerSettings

Not currently supported by AWS CloudFormation.

Required: No

Type: MicrosoftSqlServerSettings

Update requires: No interruption

MongoDbSettings

Not currently supported by AWS CloudFormation.

Required: No

Type: MongoDbSettings

Update requires: No interruption

MySqlSettings

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.

Required: No

Type: MySqlSettings

Update requires: No interruption

NeptuneSettings

Not currently supported by AWS CloudFormation.

Required: No

Type: NeptuneSettings

Update requires: No interruption

OracleSettings

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.

Required: No

Type: OracleSettings

Update requires: No interruption

Password

The password to be used to log in to the endpoint database.

Required: No

Type: String

Update requires: No interruption

Port

The port used by the endpoint database.

Required: No

Type: Integer

Update requires: No interruption

PostgreSqlSettings

Not currently supported by AWS CloudFormation.

Required: No

Type: PostgreSqlSettings

Update requires: No interruption

RedshiftSettings

Not currently supported by AWS CloudFormation.

Required: No

Type: RedshiftSettings

Update requires: No interruption

ResourceIdentifier

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn.

Required: No

Type: String

Update requires: Replacement

S3Settings

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

Required: No

Type: 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 Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.

Note

When engine_name is set to S3, then the only allowed value is none.

Required: No

Type: String

Allowed values: none | require | verify-ca | verify-full

Update requires: No interruption

SybaseSettings

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.

Required: No

Type: SybaseSettings

Update requires: No interruption

Tags

One or more tags to be assigned to the endpoint.

Required: No

Type: List of Tag

Update requires: Replacement

Username

The user name to be used to log in to the endpoint database.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the endpoint.

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

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ExternalId

A value that can be used for cross-account validation.

Examples

JSON

{ "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

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

See also