Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
251 lines (209 sloc) 14.2 KB

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

{
  "Type" : "AWS::DMS::Endpoint",
  "Properties" : {
      "[CertificateArn](#cfn-dms-endpoint-certificatearn)" : String,
      "[DatabaseName](#cfn-dms-endpoint-databasename)" : String,
      "[DynamoDbSettings](#cfn-dms-endpoint-dynamodbsettings)" : [DynamoDbSettings](aws-properties-dms-endpoint-dynamodbsettings.md),
      "[ElasticsearchSettings](#cfn-dms-endpoint-elasticsearchsettings)" : [ElasticsearchSettings](aws-properties-dms-endpoint-elasticsearchsettings.md),
      "[EndpointIdentifier](#cfn-dms-endpoint-endpointidentifier)" : String,
      "[EndpointType](#cfn-dms-endpoint-endpointtype)" : String,
      "[EngineName](#cfn-dms-endpoint-enginename)" : String,
      "[ExtraConnectionAttributes](#cfn-dms-endpoint-extraconnectionattributes)" : String,
      "[KinesisSettings](#cfn-dms-endpoint-kinesissettings)" : [KinesisSettings](aws-properties-dms-endpoint-kinesissettings.md),
      "[KmsKeyId](#cfn-dms-endpoint-kmskeyid)" : String,
      "[MongoDbSettings](#cfn-dms-endpoint-mongodbsettings)" : [MongoDbSettings](aws-properties-dms-endpoint-mongodbsettings.md),
      "[Password](#cfn-dms-endpoint-password)" : String,
      "[Port](#cfn-dms-endpoint-port)" : Integer,
      "[S3Settings](#cfn-dms-endpoint-s3settings)" : [S3Settings](aws-properties-dms-endpoint-s3settings.md),
      "[ServerName](#cfn-dms-endpoint-servername)" : String,
      "[SslMode](#cfn-dms-endpoint-sslmode)" : String,
      "[Tags](#cfn-dms-endpoint-tags)" : [ [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html), ... ],
      "[Username](#cfn-dms-endpoint-username)" : String
    }
}

YAML

Type: AWS::DMS::Endpoint
Properties: 
  [CertificateArn](#cfn-dms-endpoint-certificatearn): String
  [DatabaseName](#cfn-dms-endpoint-databasename): String
  [DynamoDbSettings](#cfn-dms-endpoint-dynamodbsettings): 
    [DynamoDbSettings](aws-properties-dms-endpoint-dynamodbsettings.md)
  [ElasticsearchSettings](#cfn-dms-endpoint-elasticsearchsettings): 
    [ElasticsearchSettings](aws-properties-dms-endpoint-elasticsearchsettings.md)
  [EndpointIdentifier](#cfn-dms-endpoint-endpointidentifier): String
  [EndpointType](#cfn-dms-endpoint-endpointtype): String
  [EngineName](#cfn-dms-endpoint-enginename): String
  [ExtraConnectionAttributes](#cfn-dms-endpoint-extraconnectionattributes): String
  [KinesisSettings](#cfn-dms-endpoint-kinesissettings): 
    [KinesisSettings](aws-properties-dms-endpoint-kinesissettings.md)
  [KmsKeyId](#cfn-dms-endpoint-kmskeyid): String
  [MongoDbSettings](#cfn-dms-endpoint-mongodbsettings): 
    [MongoDbSettings](aws-properties-dms-endpoint-mongodbsettings.md)
  [Password](#cfn-dms-endpoint-password): String
  [Port](#cfn-dms-endpoint-port): Integer
  [S3Settings](#cfn-dms-endpoint-s3settings): 
    [S3Settings](aws-properties-dms-endpoint-s3settings.md)
  [ServerName](#cfn-dms-endpoint-servername): String
  [SslMode](#cfn-dms-endpoint-sslmode): String
  [Tags](#cfn-dms-endpoint-tags): 
    - [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
  [Username](#cfn-dms-endpoint-username): String

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.
Required: No
Type: String
Update requires: No interruption

DynamoDbSettings Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the 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 Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.
Required: No
Type: ElasticsearchSettings
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.
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, redshift, s3, db2, azuredb, 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

KinesisSettings Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.
Required: No
Type: KinesisSettings
Update requires: No interruption

KmsKeyId The AWS KMS key identifier to use to encrypt the connection parameters. 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

MongoDbSettings Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
Required: No
Type: MongoDbSettings
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

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 SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.
Required: No
Type: String
Allowed Values: none | require | verify-ca | verify-full
Update requires: No interruption

Tags Tags to be added 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

You can’t perform that action at this time.