AWS::DMS::Endpoint

DMS Endpoint

Resource Type definition for AWS::DMS::Endpoint

Properties

31 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`EndpointType`	`string`	Required
`EngineName`	`string`	Required
`CertificateArn`	`string`
`DatabaseName`	`string`
`DocDbSettings`	`DocDbSettings`
`DynamoDbSettings`	`DynamoDbSettings`
`ElasticsearchSettings`	`ElasticsearchSettings`
`EndpointIdentifier`	`string`
`ExtraConnectionAttributes`	`string`
`GcpMySQLSettings`	`GcpMySQLSettings`
`IbmDb2Settings`	`IbmDb2Settings`
`KafkaSettings`	`KafkaSettings`
`KinesisSettings`	`KinesisSettings`
`KmsKeyId`	`string`	Create-only
`MicrosoftSqlServerSettings`	`MicrosoftSqlServerSettings`
`MongoDbSettings`	`MongoDbSettings`
`MySqlSettings`	`MySqlSettings`
`NeptuneSettings`	`NeptuneSettings`
`OracleSettings`	`OracleSettings`
`Password`	`string`
`Port`	`integer`
`PostgreSqlSettings`	`PostgreSqlSettings`
`RedisSettings`	`RedisSettings`
`RedshiftSettings`	`RedshiftSettings`
`ResourceIdentifier`	`string`	Create-only
`S3Settings`	`S3Settings`
`ServerName`	`string`
`SslMode`	`string`
`SybaseSettings`	`SybaseSettings`
`Tags`	`Array<Tag>`
`Username`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ExternalId`	`string`	-
`Id`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DMS::Endpoint

Resources:
  MyResource:
    Type: AWS::DMS::Endpoint
    Properties:
      EndpointType: "value"
      EngineName: "my-enginename"
      Tags:
        - Key: Environment
          Value: Production

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDMS

Properties33

Required2

TaggingNot supported

Primary IDId

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

KmsKeyIdResourceIdentifier

Related Resources

External Links

AWS Documentation