Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dms ]

modify-endpoint

Description

Modifies the specified endpoint.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  modify-endpoint
--endpoint-arn <value>
[--endpoint-identifier <value>]
[--endpoint-type <value>]
[--engine-name <value>]
[--username <value>]
[--password <value>]
[--server-name <value>]
[--port <value>]
[--database-name <value>]
[--extra-connection-attributes <value>]
[--certificate-arn <value>]
[--ssl-mode <value>]
[--service-access-role-arn <value>]
[--external-table-definition <value>]
[--dynamo-db-settings <value>]
[--s3-settings <value>]
[--dms-transfer-settings <value>]
[--mongo-db-settings <value>]
[--kinesis-settings <value>]
[--elasticsearch-settings <value>]
[--redshift-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--endpoint-arn (string)

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

--endpoint-identifier (string)

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.

--endpoint-type (string)

The type of endpoint.

Possible values:

  • source
  • target

--engine-name (string)

The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

--username (string)

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

--password (string)

The password to be used to login to the endpoint database.

--server-name (string)

The name of the server where the endpoint database resides.

--port (integer)

The port used by the endpoint database.

--database-name (string)

The name of the endpoint database.

--extra-connection-attributes (string)

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

--certificate-arn (string)

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

--ssl-mode (string)

The SSL mode to be used.

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

The default value is none.

Possible values:

  • none
  • require
  • verify-ca
  • verify-full

--service-access-role-arn (string)

The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.

--external-table-definition (string)

The external table definition.

--dynamo-db-settings (structure)

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.

Shorthand Syntax:

ServiceAccessRoleArn=string

JSON Syntax:

{
  "ServiceAccessRoleArn": "string"
}

--s3-settings (structure)

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.

Shorthand Syntax:

ServiceAccessRoleArn=string,ExternalTableDefinition=string,CsvRowDelimiter=string,CsvDelimiter=string,BucketFolder=string,BucketName=string,CompressionType=string,EncryptionMode=string,ServerSideEncryptionKmsKeyId=string,DataFormat=string,EncodingType=string,DictPageSizeLimit=integer,RowGroupLength=integer,DataPageSize=integer,ParquetVersion=string,EnableStatistics=boolean,CdcInsertsOnly=boolean

JSON Syntax:

{
  "ServiceAccessRoleArn": "string",
  "ExternalTableDefinition": "string",
  "CsvRowDelimiter": "string",
  "CsvDelimiter": "string",
  "BucketFolder": "string",
  "BucketName": "string",
  "CompressionType": "none"|"gzip",
  "EncryptionMode": "sse-s3"|"sse-kms",
  "ServerSideEncryptionKmsKeyId": "string",
  "DataFormat": "csv"|"parquet",
  "EncodingType": "plain"|"plain-dictionary"|"rle-dictionary",
  "DictPageSizeLimit": integer,
  "RowGroupLength": integer,
  "DataPageSize": integer,
  "ParquetVersion": "parquet-1-0"|"parquet-2-0",
  "EnableStatistics": true|false,
  "CdcInsertsOnly": true|false
}

--dms-transfer-settings (structure)

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

  • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
  • BucketName - The name of the S3 bucket to use.
  • compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

Shorthand Syntax:

ServiceAccessRoleArn=string,BucketName=string

JSON Syntax:

{
  "ServiceAccessRoleArn": "string",
  "BucketName": "string"
}

--mongo-db-settings (structure)

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.

Shorthand Syntax:

Username=string,Password=string,ServerName=string,Port=integer,DatabaseName=string,AuthType=string,AuthMechanism=string,NestingLevel=string,ExtractDocId=string,DocsToInvestigate=string,AuthSource=string,KmsKeyId=string

JSON Syntax:

{
  "Username": "string",
  "Password": "string",
  "ServerName": "string",
  "Port": integer,
  "DatabaseName": "string",
  "AuthType": "no"|"password",
  "AuthMechanism": "default"|"mongodb_cr"|"scram_sha_1",
  "NestingLevel": "none"|"one",
  "ExtractDocId": "string",
  "DocsToInvestigate": "string",
  "AuthSource": "string",
  "KmsKeyId": "string"
}

--kinesis-settings (structure)

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 <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping >`__ in the AWS Database Migration User Guide.

Shorthand Syntax:

StreamArn=string,MessageFormat=string,ServiceAccessRoleArn=string

JSON Syntax:

{
  "StreamArn": "string",
  "MessageFormat": "json",
  "ServiceAccessRoleArn": "string"
}

--elasticsearch-settings (structure)

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.

Shorthand Syntax:

ServiceAccessRoleArn=string,EndpointUri=string,FullLoadErrorPercentage=integer,ErrorRetryDuration=integer

JSON Syntax:

{
  "ServiceAccessRoleArn": "string",
  "EndpointUri": "string",
  "FullLoadErrorPercentage": integer,
  "ErrorRetryDuration": integer
}

--redshift-settings (structure)

Shorthand Syntax:

AcceptAnyDate=boolean,AfterConnectScript=string,BucketFolder=string,BucketName=string,ConnectionTimeout=integer,DatabaseName=string,DateFormat=string,EmptyAsNull=boolean,EncryptionMode=string,FileTransferUploadStreams=integer,LoadTimeout=integer,MaxFileSize=integer,Password=string,Port=integer,RemoveQuotes=boolean,ReplaceInvalidChars=string,ReplaceChars=string,ServerName=string,ServiceAccessRoleArn=string,ServerSideEncryptionKmsKeyId=string,TimeFormat=string,TrimBlanks=boolean,TruncateColumns=boolean,Username=string,WriteBufferSize=integer

JSON Syntax:

{
  "AcceptAnyDate": true|false,
  "AfterConnectScript": "string",
  "BucketFolder": "string",
  "BucketName": "string",
  "ConnectionTimeout": integer,
  "DatabaseName": "string",
  "DateFormat": "string",
  "EmptyAsNull": true|false,
  "EncryptionMode": "sse-s3"|"sse-kms",
  "FileTransferUploadStreams": integer,
  "LoadTimeout": integer,
  "MaxFileSize": integer,
  "Password": "string",
  "Port": integer,
  "RemoveQuotes": true|false,
  "ReplaceInvalidChars": "string",
  "ReplaceChars": "string",
  "ServerName": "string",
  "ServiceAccessRoleArn": "string",
  "ServerSideEncryptionKmsKeyId": "string",
  "TimeFormat": "string",
  "TrimBlanks": true|false,
  "TruncateColumns": true|false,
  "Username": "string",
  "WriteBufferSize": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Endpoint -> (structure)

The modified endpoint.

EndpointIdentifier -> (string)

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.

EndpointType -> (string)

The type of endpoint.

EngineName -> (string)

The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.

EngineDisplayName -> (string)

The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."

Username -> (string)

The user name used to connect to the endpoint.

ServerName -> (string)

The name of the server at the endpoint.

Port -> (integer)

The port value used to access the endpoint.

DatabaseName -> (string)

The name of the database at the endpoint.

ExtraConnectionAttributes -> (string)

Additional connection attributes used to connect to the endpoint.

Status -> (string)

The status of the endpoint.

KmsKeyId -> (string)

The AWS KMS key identifier that is used to encrypt the content on the replication instance. 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.

EndpointArn -> (string)

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

CertificateArn -> (string)

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

SslMode -> (string)

The SSL mode used to connect to the endpoint.

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

The default value is none.

ServiceAccessRoleArn -> (string)

The Amazon Resource Name (ARN) used by the service access IAM role.

ExternalTableDefinition -> (string)

The external table definition.

ExternalId -> (string)

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

DynamoDbSettings -> (structure)

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

ServiceAccessRoleArn -> (string)

The Amazon Resource Name (ARN) used by the service access IAM role.

S3Settings -> (structure)

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

ServiceAccessRoleArn -> (string)

The Amazon Resource Name (ARN) used by the service access IAM role.

ExternalTableDefinition -> (string)

The external table definition.

CsvRowDelimiter -> (string)

The delimiter used to separate rows in the source files. The default is a carriage return (\n ).

CsvDelimiter -> (string)

The delimiter used to separate columns in the source files. The default is a comma.

BucketFolder -> (string)

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path bucketFolder/schema_name/table_name/ . If this parameter is not specified, then the path used is schema_name/table_name/ .

BucketName -> (string)

The name of the S3 bucket.

CompressionType -> (string)

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both CSV and PARQUET data formats.

EncryptionMode -> (string)

The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS . To use SSE_S3 , you need an IAM role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:

  • s3:CreateBucket
  • s3:ListBucket
  • s3:DeleteBucket
  • s3:GetBucketLocation
  • s3:GetObject
  • s3:PutObject
  • s3:DeleteObject
  • s3:GetObjectVersion
  • s3:GetBucketPolicy
  • s3:PutBucketPolicy
  • s3:DeleteBucketPolicy

ServerSideEncryptionKmsKeyId -> (string)

If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

Here is a CLI example: aws dms create-endpoint --endpoint-identifier value--endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value

DataFormat -> (string)

The format of the data which you want to use for output. You can choose one of the following:

  • CSV : This is a row-based format with comma-separated values.
  • PARQUET : Apache Parquet is a columnar storage format that features efficient compression and provides faster query response.

EncodingType -> (string)

The type of encoding you are using: RLE_DICTIONARY (default), PLAIN , or PLAIN_DICTIONARY .

  • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently.
  • PLAIN does not use encoding at all. Values are stored as they are.
  • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

DictPageSizeLimit -> (integer)

The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN . Defaults to 1024 * 1024 bytes (1MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. For PARQUET format only.

RowGroupLength -> (integer)

The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. Defaults to 10,000 (ten thousand) rows. For PARQUET format only.

If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

DataPageSize -> (integer)

The size of one data page in bytes. Defaults to 1024 * 1024 bytes (1MiB). For PARQUET format only.

ParquetVersion -> (string)

The version of Apache Parquet format you want to use: PARQUET_1_0 (default) or PARQUET_2_0 .

EnableStatistics -> (boolean)

Enables statistics for Parquet pages and rowGroups. Choose TRUE to enable statistics, choose FALSE to disable. Statistics include NULL , DISTINCT , MAX , and MIN values. Defaults to TRUE . For PARQUET format only.

CdcInsertsOnly -> (boolean)

Option to write only INSERT operations to the comma-separated value (CSV) output files. By default, the first field in a CSV record contains the letter I (insert), U (update) or D (delete) to indicate whether the row was inserted, updated, or deleted at the source database. If cdcInsertsOnly is set to true, then only INSERT s are recorded in the CSV file, without the I annotation on each line. Valid values are TRUE and FALSE .

DmsTransferSettings -> (structure)

The settings in JSON format for the DMS transfer type of source endpoint.

Possible attributes include the following:

  • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
  • bucketName - The name of the S3 bucket to use.
  • compressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

ServiceAccessRoleArn -> (string)

The IAM role that has permission to access the Amazon S3 bucket.

BucketName -> (string)

The name of the S3 bucket to use.

MongoDbSettings -> (structure)

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Username -> (string)

The user name you use to access the MongoDB source endpoint.

Password -> (string)

The password for the user account you use to access the MongoDB source endpoint.

ServerName -> (string)

The name of the server on the MongoDB source endpoint.

Port -> (integer)

The port value for the MongoDB source endpoint.

DatabaseName -> (string)

The database name on the MongoDB source endpoint.

AuthType -> (string)

The authentication type you use to access the MongoDB source endpoint.

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.

AuthMechanism -> (string)

The authentication mechanism you use to access the MongoDB source endpoint.

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.

NestingLevel -> (string)

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

ExtractDocId -> (string)

Specifies the document ID. Use this attribute when NestingLevel is set to NONE.

Default value is false.

DocsToInvestigate -> (string)

Indicates the number of documents to preview to determine the document organization. Use this attribute when NestingLevel is set to ONE.

Must be a positive value greater than 0. Default value is 1000.

AuthSource -> (string)

The MongoDB database name. This attribute is not used when authType=NO .

The default is admin.

KmsKeyId -> (string)

The AWS KMS key identifier that is used to encrypt the content on the replication instance. 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.

KinesisSettings -> (structure)

The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

StreamArn -> (string)

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

MessageFormat -> (string)

The output format for the records created on the endpoint. The message format is JSON .

ServiceAccessRoleArn -> (string)

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

ElasticsearchSettings -> (structure)

The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

ServiceAccessRoleArn -> (string)

The Amazon Resource Name (ARN) used by service to access the IAM role.

EndpointUri -> (string)

The endpoint for the ElasticSearch cluster.

FullLoadErrorPercentage -> (integer)

The maximum percentage of records that can fail to be written before a full load operation stops.

ErrorRetryDuration -> (integer)

The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

RedshiftSettings -> (structure)

Settings for the Amazon Redshift endpoint

AcceptAnyDate -> (boolean)

Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).

This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

AfterConnectScript -> (string)

Code to run after connecting. This should be the code, not a filename.

BucketFolder -> (string)

The location where the CSV files are stored before being uploaded to the S3 bucket.

BucketName -> (string)

The name of the S3 bucket you want to use

ConnectionTimeout -> (integer)

Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

DatabaseName -> (string)

The name of the Amazon Redshift data warehouse (service) you are working with.

DateFormat -> (string)

The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.

If your date and time values use formats different from each other, set this to auto .

EmptyAsNull -> (boolean)

Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.

EncryptionMode -> (string)

The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket" .

FileTransferUploadStreams -> (integer)

Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.

LoadTimeout -> (integer)

Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

MaxFileSize -> (integer)

Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).

Password -> (string)

The password for the user named in the username property.

Port -> (integer)

The port number for Amazon Redshift. The default value is 5439.

RemoveQuotes -> (boolean)

Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.

ReplaceInvalidChars -> (string)

A list of chars you want to replace. Use with ReplaceChars .

ReplaceChars -> (string)

Replaces invalid characters specified in ReplaceInvalidChars , substituting the specified value instead. The default is "?".

ServerName -> (string)

The name of the Amazon Redshift cluster you are using.

ServiceAccessRoleArn -> (string)

The ARN of the role that has access to the Redshift service.

ServerSideEncryptionKmsKeyId -> (string)

If you are using SSE_KMS for the EncryptionMode , provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.

TimeFormat -> (string)

The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.

If your date and time values use formats different from each other, set this to auto .

TrimBlanks -> (boolean)

Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.

TruncateColumns -> (boolean)

Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.

Username -> (string)

An Amazon Redshift user name for a registered user.

WriteBufferSize -> (integer)

The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.