--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_dms_endpoint{% #aws_dms_endpoint %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `aws_external_id`{% #aws_external_id %} **Type**: `STRING`**Provider name**: `ExternalId`**Description**: 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. ## `certificate_arn`{% #certificate_arn %} **Type**: `STRING`**Provider name**: `CertificateArn`**Description**: The Amazon Resource Name (ARN) used for SSL connection to the endpoint. ## `database_name`{% #database_name %} **Type**: `STRING`**Provider name**: `DatabaseName`**Description**: The name of the database at the endpoint. ## `dms_transfer_settings`{% #dms_transfer_settings %} **Type**: `STRUCT`**Provider name**: `DmsTransferSettings`**Description**: The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure. - `bucket_name`**Type**: `STRING`**Provider name**: `BucketName`**Description**: The name of the S3 bucket to use. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the `iam:PassRole` action. ## `doc_db_settings`{% #doc_db_settings %} **Type**: `STRUCT`**Provider name**: `DocDbSettings` - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: The database name on the DocumentDB source endpoint. - `docs_to_investigate`**Type**: `INT32`**Provider name**: `DocsToInvestigate`**Description**: Indicates the number of documents to preview to determine the document organization. Use this setting when `NestingLevel` is set to `"one"`. Must be a positive value greater than `0`. Default value is `1000`. - `extract_doc_id`**Type**: `BOOLEAN`**Provider name**: `ExtractDocId`**Description**: Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"`. Default value is `"false"`. - `kms_key_id`**Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: The 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 DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region. - `nesting_level`**Type**: `STRING`**Provider name**: `NestingLevel`**Description**: Specifies either document or table mode. Default value is `"none"`. Specify `"none"` to use document mode. Specify `"one"` to use table mode. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: The password for the user account you use to access the DocumentDB source endpoint. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: The port value for the DocumentDB source endpoint. - `replicate_shard_collections`**Type**: `BOOLEAN`**Provider name**: `ReplicateShardCollections`**Description**: If `true`, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster. When this setting is `true`, note the following: - You must set `TargetTablePrepMode` to `nothing`. - DMS automatically sets `useUpdateLookup` to `false`. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The name of the server on the DocumentDB source endpoint. - `use_update_look_up`**Type**: `BOOLEAN`**Provider name**: `UseUpdateLookUp`**Description**: If `true`, DMS retrieves the entire document from the DocumentDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to `false`. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: The user name you use to access the DocumentDB source endpoint. ## `dynamo_db_settings`{% #dynamo_db_settings %} **Type**: `STRUCT`**Provider name**: `DynamoDbSettings`**Description**: The settings for the DynamoDB target endpoint. For more information, see the `DynamoDBSettings` structure. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the `iam:PassRole` action. ## `elasticsearch_settings`{% #elasticsearch_settings %} **Type**: `STRUCT`**Provider name**: `ElasticsearchSettings`**Description**: The settings for the OpenSearch source endpoint. For more information, see the `ElasticsearchSettings` structure. - `endpoint_uri`**Type**: `STRING`**Provider name**: `EndpointUri`**Description**: The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified. - `error_retry_duration`**Type**: `INT32`**Provider name**: `ErrorRetryDuration`**Description**: The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster. - `full_load_error_percentage`**Type**: `INT32`**Provider name**: `FullLoadErrorPercentage`**Description**: The maximum percentage of records that can fail to be written before a full load operation stops. To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the `iam:PassRole` action. - `use_new_mapping_type`**Type**: `BOOLEAN`**Provider name**: `UseNewMappingType`**Description**: Set this option to `true` for DMS to migrate documentation using the documentation type `_doc`. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is `false`. ## `endpoint_arn`{% #endpoint_arn %} **Type**: `STRING`**Provider name**: `EndpointArn`**Description**: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. ## `endpoint_identifier`{% #endpoint_identifier %} **Type**: `STRING`**Provider name**: `EndpointIdentifier`**Description**: 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. ## `endpoint_type`{% #endpoint_type %} **Type**: `STRING`**Provider name**: `EndpointType`**Description**: The type of endpoint. Valid values are `source` and `target`. ## `engine_display_name`{% #engine_display_name %} **Type**: `STRING`**Provider name**: `EngineDisplayName`**Description**: The expanded name for the engine name. For example, if the `EngineName` parameter is "aurora", this value would be "Amazon Aurora MySQL". ## `engine_name`{% #engine_name %} **Type**: `STRING`**Provider name**: `EngineName`**Description**: The database engine name. Valid values, depending on the EndpointType, include `"mysql"`, `"oracle"`, `"postgres"`, `"mariadb"`, `"aurora"`, `"aurora-postgresql"`, `"redshift"`, `"redshift-serverless"`, `"s3"`, `"db2"`, `"db2-zos"`, `"azuredb"`, `"sybase"`, `"dynamodb"`, `"mongodb"`, `"kinesis"`, `"kafka"`, `"elasticsearch"`, `"documentdb"`, `"sqlserver"`, `"neptune"`, and `"babelfish"`. ## `external_table_definition`{% #external_table_definition %} **Type**: `STRING`**Provider name**: `ExternalTableDefinition`**Description**: The external table definition. ## `extra_connection_attributes`{% #extra_connection_attributes %} **Type**: `STRING`**Provider name**: `ExtraConnectionAttributes`**Description**: Additional connection attributes used to connect to the endpoint. ## `gcp_my_sql_settings`{% #gcp_my_sql_settings %} **Type**: `STRUCT`**Provider name**: `GcpMySQLSettings`**Description**: Settings in JSON format for the source GCP MySQL endpoint. - `after_connect_script`**Type**: `STRING`**Provider name**: `AfterConnectScript`**Description**: Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. For this parameter, provide the code of the script itself, not the name of a file containing the script. - `clean_source_metadata_on_mismatch`**Type**: `BOOLEAN`**Provider name**: `CleanSourceMetadataOnMismatch`**Description**: Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the `DatabaseName` request parameter on either the `CreateEndpoint` or `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. - `events_poll_interval`**Type**: `INT32`**Provider name**: `EventsPollInterval`**Description**: Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds. Example: `eventsPollInterval=5;` In the example, DMS checks for changes in the binary logs every five seconds. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. Example: `maxFileSize=512` - `parallel_load_threads`**Type**: `INT32`**Provider name**: `ParallelLoadThreads`**Description**: Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one. Example: `parallelLoadThreads=1` - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The MySQL host name. - `server_timezone`**Type**: `STRING`**Provider name**: `ServerTimezone`**Description**: Specifies the time zone for the source MySQL database. Example: `serverTimezone=US/Pacific;` Note: Do not enclose time zones in single quotes. - `target_db_type`**Type**: `STRING`**Provider name**: `TargetDbType`**Description**: Specifies where to migrate source tables on the target, either to a single database or multiple databases. Example: `targetDbType=MULTIPLE_DATABASES` - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `ibm_db2_settings`{% #ibm_db2_settings %} **Type**: `STRUCT`**Provider name**: `IBMDb2Settings`**Description**: The settings for the IBM Db2 LUW source endpoint. For more information, see the `IBMDb2Settings` structure. - `current_lsn`**Type**: `STRING`**Provider name**: `CurrentLsn`**Description**: For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `keep_csv_files`**Type**: `BOOLEAN`**Provider name**: `KeepCsvFiles`**Description**: If true, DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting. The default value is false. - `load_timeout`**Type**: `INT32`**Provider name**: `LoadTimeout`**Description**: The amount of time (in milliseconds) before DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes). - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW. - `max_k_bytes_per_read`**Type**: `INT32`**Provider name**: `MaxKBytesPerRead`**Description**: Maximum number of bytes per read, as a NUMBER value. The default is 64 KB. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. The default value is 50000. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Db2 LUW endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: Fully qualified domain name of the endpoint. - `set_data_capture_changes`**Type**: `BOOLEAN`**Provider name**: `SetDataCaptureChanges`**Description**: Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. - `write_buffer_size`**Type**: `INT32`**Provider name**: `WriteBufferSize`**Description**: The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk on the DMS replication instance. The default value is 1024 (1 MB). ## `kafka_settings`{% #kafka_settings %} **Type**: `STRUCT`**Provider name**: `KafkaSettings`**Description**: The settings for the Apache Kafka target endpoint. For more information, see the `KafkaSettings` structure. - `broker`**Type**: `STRING`**Provider name**: `Broker`**Description**: A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form `broker-hostname-or-ip : port`. For example, `"ec2-12-345-678-901.compute-1.amazonaws.com:2345"`. For more information and examples of specifying a list of broker locations, see [Using Apache Kafka as a target for Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the Database Migration Service User Guide. - `include_control_details`**Type**: `BOOLEAN`**Provider name**: `IncludeControlDetails`**Description**: Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is `false`. - `include_null_and_empty`**Type**: `BOOLEAN`**Provider name**: `IncludeNullAndEmpty`**Description**: Include NULL and empty columns for records migrated to the endpoint. The default is `false`. - `include_partition_value`**Type**: `BOOLEAN`**Provider name**: `IncludePartitionValue`**Description**: Shows the partition value within the Kafka message output unless the partition type is `schema-table-type`. The default is `false`. - `include_table_alter_operations`**Type**: `BOOLEAN`**Provider name**: `IncludeTableAlterOperations`**Description**: Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table`, `drop-table`, `add-column`, `drop-column`, and `rename-column`. The default is `false`. - `include_transaction_details`**Type**: `BOOLEAN`**Provider name**: `IncludeTransactionDetails`**Description**: Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for `transaction_id`, previous `transaction_id`, and `transaction_record_id` (the record offset within a transaction). The default is `false`. - `message_format`**Type**: `STRING`**Provider name**: `MessageFormat`**Description**: The output format for the records created on the endpoint. The message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab). - `message_max_bytes`**Type**: `INT32`**Provider name**: `MessageMaxBytes`**Description**: The maximum size in bytes for records created on the endpoint The default is 1,000,000. - `no_hex_prefix`**Type**: `BOOLEAN`**Provider name**: `NoHexPrefix`**Description**: Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix. - `partition_include_schema_table`**Type**: `BOOLEAN`**Provider name**: `PartitionIncludeSchemaTable`**Description**: Prefixes schema and table names to partition values, when the partition type is `primary-key-type`. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is `false`. - `sasl_mechanism`**Type**: `STRING`**Provider name**: `SaslMechanism`**Description**: For SASL/SSL authentication, DMS supports the `SCRAM-SHA-512` mechanism by default. DMS versions 3.5.0 and later also support the `PLAIN` mechanism. To use the `PLAIN` mechanism, set this parameter to `PLAIN.` - `sasl_password`**Type**: `STRING`**Provider name**: `SaslPassword`**Description**: The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. - `sasl_username`**Type**: `STRING`**Provider name**: `SaslUsername`**Description**: The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication. - `security_protocol`**Type**: `STRING`**Provider name**: `SecurityProtocol`**Description**: Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include `ssl-encryption`, `ssl-authentication`, and `sasl-ssl`. `sasl-ssl` requires `SaslUsername` and `SaslPassword`. - `ssl_ca_certificate_arn`**Type**: `STRING`**Provider name**: `SslCaCertificateArn`**Description**: The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint. - `ssl_client_certificate_arn`**Type**: `STRING`**Provider name**: `SslClientCertificateArn`**Description**: The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint. - `ssl_client_key_arn`**Type**: `STRING`**Provider name**: `SslClientKeyArn`**Description**: The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint. - `ssl_client_key_password`**Type**: `STRING`**Provider name**: `SslClientKeyPassword`**Description**: The password for the client private key used to securely connect to a Kafka target endpoint. - `ssl_endpoint_identification_algorithm`**Type**: `STRING`**Provider name**: `SslEndpointIdentificationAlgorithm`**Description**: Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later. - `topic`**Type**: `STRING`**Provider name**: `Topic`**Description**: The topic to which you migrate the data. If you don't specify a topic, DMS specifies `"kafka-default-topic"` as the migration topic. ## `kinesis_settings`{% #kinesis_settings %} **Type**: `STRUCT`**Provider name**: `KinesisSettings`**Description**: The settings for the Amazon Kinesis target endpoint. For more information, see the `KinesisSettings` structure. - `include_control_details`**Type**: `BOOLEAN`**Provider name**: `IncludeControlDetails`**Description**: Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is `false`. - `include_null_and_empty`**Type**: `BOOLEAN`**Provider name**: `IncludeNullAndEmpty`**Description**: Include NULL and empty columns for records migrated to the endpoint. The default is `false`. - `include_partition_value`**Type**: `BOOLEAN`**Provider name**: `IncludePartitionValue`**Description**: Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`. The default is `false`. - `include_table_alter_operations`**Type**: `BOOLEAN`**Provider name**: `IncludeTableAlterOperations`**Description**: Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table`, `drop-table`, `add-column`, `drop-column`, and `rename-column`. The default is `false`. - `include_transaction_details`**Type**: `BOOLEAN`**Provider name**: `IncludeTransactionDetails`**Description**: Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for `transaction_id`, previous `transaction_id`, and `transaction_record_id` (the record offset within a transaction). The default is `false`. - `message_format`**Type**: `STRING`**Provider name**: `MessageFormat`**Description**: The output format for the records created on the endpoint. The message format is `JSON` (default) or `JSON_UNFORMATTED` (a single line with no tab). - `no_hex_prefix`**Type**: `BOOLEAN`**Provider name**: `NoHexPrefix`**Description**: Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix. - `partition_include_schema_table`**Type**: `BOOLEAN`**Provider name**: `PartitionIncludeSchemaTable`**Description**: Prefixes schema and table names to partition values, when the partition type is `primary-key-type`. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is `false`. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the `iam:PassRole` action. - `stream_arn`**Type**: `STRING`**Provider name**: `StreamArn`**Description**: The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint. ## `kms_key_id`{% #kms_key_id %} **Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: An 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 DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region. ## `microsoft_sql_server_settings`{% #microsoft_sql_server_settings %} **Type**: `STRUCT`**Provider name**: `MicrosoftSQLServerSettings`**Description**: The settings for the Microsoft SQL Server source and target endpoint. For more information, see the `MicrosoftSQLServerSettings` structure. - `bcp_packet_size`**Type**: `INT32`**Provider name**: `BcpPacketSize`**Description**: The maximum size of the packets (in bytes) used to transfer data using BCP. - `control_tables_file_group`**Type**: `STRING`**Provider name**: `ControlTablesFileGroup`**Description**: Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `force_lob_lookup`**Type**: `BOOLEAN`**Provider name**: `ForceLobLookup`**Description**: Forces LOB lookup on inline LOB. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. - `query_single_always_on_node`**Type**: `BOOLEAN`**Provider name**: `QuerySingleAlwaysOnNode`**Description**: Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance. - `read_backup_only`**Type**: `BOOLEAN`**Provider name**: `ReadBackupOnly`**Description**: When this attribute is set to `Y`, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication. - `safeguard_policy`**Type**: `STRING`**Provider name**: `SafeguardPolicy`**Description**: Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods. Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method. Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the SQL Server endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `Endpoint .Address` field. - `tlog_access_mode`**Type**: `STRING`**Provider name**: `TlogAccessMode`**Description**: Indicates the mode used to fetch CDC data. - `trim_space_in_char`**Type**: `BOOLEAN`**Provider name**: `TrimSpaceInChar`**Description**: Use the `TrimSpaceInChar` source endpoint setting to right-trim data on CHAR and NCHAR data types during migration. Setting `TrimSpaceInChar` does not left-trim data. The default value is `true`. - `use_bcp_full_load`**Type**: `BOOLEAN`**Provider name**: `UseBcpFullLoad`**Description**: Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option. - `use_third_party_backup_device`**Type**: `BOOLEAN`**Provider name**: `UseThirdPartyBackupDevice`**Description**: When this attribute is set to `Y`, DMS processes third-party transaction log backups if they are created in native format. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `mongo_db_settings`{% #mongo_db_settings %} **Type**: `STRUCT`**Provider name**: `MongoDbSettings`**Description**: The settings for the MongoDB source endpoint. For more information, see the `MongoDbSettings` structure. - `auth_mechanism`**Type**: `STRING`**Provider name**: `AuthMechanism`**Description**: The authentication mechanism you use to access the MongoDB source endpoint. For the default value, in MongoDB version 2.x, `"default"` is `"mongodb_cr"`. For MongoDB version 3.x or later, `"default"` is `"scram_sha_1"`. This setting isn't used when `AuthType` is set to `"no"`. - `auth_source`**Type**: `STRING`**Provider name**: `AuthSource`**Description**: The MongoDB database name. This setting isn't used when `AuthType` is set to `"no"`. The default is `"admin"`. - `auth_type`**Type**: `STRING`**Provider name**: `AuthType`**Description**: The authentication type you use to access the MongoDB source endpoint. When when set to `"no"`, user name and password parameters are not used and can be empty. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: The database name on the MongoDB source endpoint. - `docs_to_investigate`**Type**: `STRING`**Provider name**: `DocsToInvestigate`**Description**: Indicates the number of documents to preview to determine the document organization. Use this setting when `NestingLevel` is set to `"one"`. Must be a positive value greater than `0`. Default value is `1000`. - `extract_doc_id`**Type**: `STRING`**Provider name**: `ExtractDocId`**Description**: Specifies the document ID. Use this setting when `NestingLevel` is set to `"none"`. Default value is `"false"`. - `kms_key_id`**Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: The 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 DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region. - `nesting_level`**Type**: `STRING`**Provider name**: `NestingLevel`**Description**: Specifies either document or table mode. Default value is `"none"`. Specify `"none"` to use document mode. Specify `"one"` to use table mode. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: The password for the user account you use to access the MongoDB source endpoint. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: The port value for the MongoDB source endpoint. - `replicate_shard_collections`**Type**: `BOOLEAN`**Provider name**: `ReplicateShardCollections`**Description**: If `true`, DMS replicates data to shard collections. DMS only uses this setting if the target endpoint is a DocumentDB elastic cluster. When this setting is `true`, note the following: - You must set `TargetTablePrepMode` to `nothing`. - DMS automatically sets `useUpdateLookup` to `false`. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set. - `use_update_look_up`**Type**: `BOOLEAN`**Provider name**: `UseUpdateLookUp`**Description**: If `true`, DMS retrieves the entire document from the MongoDB source during migration. This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates and deletes during migration, set this parameter to `false`. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: The user name you use to access the MongoDB source endpoint. ## `my_sql_settings`{% #my_sql_settings %} **Type**: `STRUCT`**Provider name**: `MySQLSettings`**Description**: The settings for the MySQL source and target endpoint. For more information, see the `MySQLSettings` structure. - `after_connect_script`**Type**: `STRING`**Provider name**: `AfterConnectScript`**Description**: Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. For this parameter, provide the code of the script itself, not the name of a file containing the script. - `clean_source_metadata_on_mismatch`**Type**: `BOOLEAN`**Provider name**: `CleanSourceMetadataOnMismatch`**Description**: Cleans and recreates table metadata information on the replication instance when a mismatch occurs. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the `DatabaseName` request parameter on either the `CreateEndpoint` or `ModifyEndpoint` API call. Specifying `DatabaseName` when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. - `events_poll_interval`**Type**: `INT32`**Provider name**: `EventsPollInterval`**Description**: Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds. Example: `eventsPollInterval=5;` In the example, DMS checks for changes in the binary logs every five seconds. - `execute_timeout`**Type**: `INT32`**Provider name**: `ExecuteTimeout`**Description**: Sets the client statement timeout (in seconds) for a MySQL source endpoint. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. Example: `maxFileSize=512` - `parallel_load_threads`**Type**: `INT32`**Provider name**: `ParallelLoadThreads`**Description**: Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one. Example: `parallelLoadThreads=1` - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The host name of the endpoint database. For an Amazon RDS MySQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `Endpoint .Address` field. For an Aurora MySQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` field. - `server_timezone`**Type**: `STRING`**Provider name**: `ServerTimezone`**Description**: Specifies the time zone for the source MySQL database. Example: `serverTimezone=US/Pacific;` Note: Do not enclose time zones in single quotes. - `target_db_type`**Type**: `STRING`**Provider name**: `TargetDbType`**Description**: Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify `SPECIFIC_DATABASE`, specify the database name using the `DatabaseName` parameter of the `Endpoint` object. Example: `targetDbType=MULTIPLE_DATABASES` - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `neptune_settings`{% #neptune_settings %} **Type**: `STRUCT`**Provider name**: `NeptuneSettings`**Description**: The settings for the Amazon Neptune target endpoint. For more information, see the `NeptuneSettings` structure. - `error_retry_duration`**Type**: `INT32`**Provider name**: `ErrorRetryDuration`**Description**: The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250. - `iam_auth_enabled`**Type**: `BOOLEAN`**Provider name**: `IamAuthEnabled`**Description**: If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to `true`. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`. The default is `false`. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data. - `max_retry_count`**Type**: `INT32`**Provider name**: `MaxRetryCount`**Description**: The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5. - `s3_bucket_folder`**Type**: `STRING`**Provider name**: `S3BucketFolder`**Description**: A folder path where you want DMS to store migrated graph data in the S3 bucket specified by `S3BucketName` - `s3_bucket_name`**Type**: `STRING`**Provider name**: `S3BucketName`**Description**: The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the `iam:PassRole` action. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the Database Migration Service User Guide. ## `oracle_settings`{% #oracle_settings %} **Type**: `STRUCT`**Provider name**: `OracleSettings`**Description**: The settings for the Oracle source and target endpoint. For more information, see the `OracleSettings` structure. - `access_alternate_directly`**Type**: `BOOLEAN`**Provider name**: `AccessAlternateDirectly`**Description**: Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access. - `add_supplemental_logging`**Type**: `BOOLEAN`**Provider name**: `AddSupplementalLogging`**Description**: Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task. If you use this option, you still need to enable database-level supplemental logging. - `additional_archived_log_dest_id`**Type**: `INT32`**Provider name**: `AdditionalArchivedLogDestId`**Description**: Set this attribute with `ArchivedLogDestId` in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover. Although DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary. For additional information about `RESETLOGS`, see [RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the Oracle Database Backup and Recovery User's Guide. - `allow_select_nested_tables`**Type**: `BOOLEAN`**Provider name**: `AllowSelectNestedTables`**Description**: Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types. - `archived_log_dest_id`**Type**: `INT32`**Provider name**: `ArchivedLogDestId`**Description**: Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset. - `archived_logs_only`**Type**: `BOOLEAN`**Provider name**: `ArchivedLogsOnly`**Description**: When this field is set to `Y`, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges. - `asm_password`**Type**: `STRING`**Provider name**: `AsmPassword`**Description**: For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the `asm_user_password`value. You set this value as part of the comma-separated value that you set to the `Password` request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). - `asm_server`**Type**: `STRING`**Provider name**: `AsmServer`**Description**: For an Oracle source endpoint, your ASM server address. You can set this value from the `asm_server` value. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). - `asm_user`**Type**: `STRING`**Provider name**: `AsmUser`**Description**: For an Oracle source endpoint, your ASM user name. You can set this value from the `asm_user` value. You set `asm_user` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). - `char_length_semantics`**Type**: `STRING`**Provider name**: `CharLengthSemantics`**Description**: Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to `CHAR`. Otherwise, the character column length is in bytes. Example: `charLengthSemantics=CHAR;` - `convert_timestamp_with_zone_to_utc`**Type**: `BOOLEAN`**Provider name**: `ConvertTimestampWithZoneToUTC`**Description**: When true, converts timestamps with the `timezone` datatype to their UTC value. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `direct_path_no_log`**Type**: `BOOLEAN`**Provider name**: `DirectPathNoLog`**Description**: When set to `true`, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs. - `direct_path_parallel_load`**Type**: `BOOLEAN`**Provider name**: `DirectPathParallelLoad`**Description**: When set to `true`, this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y`. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes. - `enable_homogenous_tablespace`**Type**: `BOOLEAN`**Provider name**: `EnableHomogenousTablespace`**Description**: Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target. - `extra_archived_log_dest_ids`**Type**: `UNORDERED_LIST_INT32`**Provider name**: `ExtraArchivedLogDestIds`**Description**: Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the `dest_id` column in the `v$archived_log` view. Use this setting with the `archivedLogDestId` extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup. This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings. `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]` In a primary-to-multiple-standby setup, you might apply the following settings. `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]` Although DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary. For more information about `RESETLOGS`, see [RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the Oracle Database Backup and Recovery User's Guide. - `fail_tasks_on_lob_truncation`**Type**: `BOOLEAN`**Provider name**: `FailTasksOnLobTruncation`**Description**: When set to `true`, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize`. If a task is set to limited LOB mode and this option is set to `true`, the task fails instead of truncating the LOB data. - `number_datatype_scale`**Type**: `INT32`**Provider name**: `NumberDatatypeScale`**Description**: Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10. Example: `numberDataTypeScale=12` - `open_transaction_window`**Type**: `INT32`**Provider name**: `OpenTransactionWindow`**Description**: The timeframe in minutes to check for open transactions for a CDC-only task. You can specify an integer value between 0 (the default) and 240 (the maximum).This parameter is only valid in DMS version 3.5.0 and later. DMS supports a window of up to 9.5 hours including the value for `OpenTransactionWindow`. - `oracle_path_prefix`**Type**: `STRING`**Provider name**: `OraclePathPrefix`**Description**: Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs. - `parallel_asm_read_threads`**Type**: `INT32`**Provider name**: `ParallelAsmReadThreads`**Description**: Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the `readAheadBlocks` attribute. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. - `read_ahead_blocks`**Type**: `INT32`**Provider name**: `ReadAheadBlocks`**Description**: Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum). - `read_table_space_name`**Type**: `BOOLEAN`**Provider name**: `ReadTableSpaceName`**Description**: When set to `true`, this attribute supports tablespace replication. - `replace_path_prefix`**Type**: `BOOLEAN`**Provider name**: `ReplacePathPrefix`**Description**: Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs. - `retry_interval`**Type**: `INT32`**Provider name**: `RetryInterval`**Description**: Specifies the number of seconds that the system waits before resending a query. Example: `retryInterval=6;` - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_oracle_asm_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerOracleAsmAccessRoleArn`**Description**: Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret`. This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId`. Or you can specify clear-text values for `AsmUser`, `AsmPassword`, and `AsmServerName`. You can't specify both. For more information on creating this `SecretsManagerOracleAsmSecret` and the `SecretsManagerOracleAsmAccessRoleArn` and `SecretsManagerOracleAsmSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_oracle_asm_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerOracleAsmSecretId`**Description**: Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details. - `security_db_encryption`**Type**: `STRING`**Provider name**: `SecurityDbEncryption`**Description**: For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the `TDE_Password`part of the comma-separated value you set to the `Password` request parameter when you create the endpoint. The `SecurityDbEncryptian` setting is related to this `SecurityDbEncryptionName` setting. For more information, see [Supported encryption methods for using Oracle as a source for DMS ](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)in the Database Migration Service User Guide. - `security_db_encryption_name`**Type**: `STRING`**Provider name**: `SecurityDbEncryptionName`**Description**: For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the `SecurityDbEncryption` setting. For more information on setting the key name value of `SecurityDbEncryptionName`, see the information and example for setting the `securityDbEncryptionName` extra connection attribute in [Supported encryption methods for using Oracle as a source for DMS ](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)in the Database Migration Service User Guide. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: Fully qualified domain name of the endpoint. For an Amazon RDS Oracle instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `Endpoint .Address` field. - `spatial_data_option_to_geo_json_function_name`**Type**: `STRING`**Provider name**: `SpatialDataOptionToGeoJsonFunctionName`**Description**: Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format. By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead. - `standby_delay_time`**Type**: `INT32`**Provider name**: `StandbyDelayTime`**Description**: Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases. In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production. - `trim_space_in_char`**Type**: `BOOLEAN`**Provider name**: `TrimSpaceInChar`**Description**: Use the `TrimSpaceInChar` source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is `true`. - `use_alternate_folder_for_online`**Type**: `BOOLEAN`**Provider name**: `UseAlternateFolderForOnline`**Description**: Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs. - `use_b_file`**Type**: `BOOLEAN`**Provider name**: `UseBFile`**Description**: Set this attribute to Y to capture change data using the Binary Reader utility. Set `UseLogminerReader` to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see [Using Oracle LogMiner or DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC). - `use_direct_path_full_load`**Type**: `BOOLEAN`**Provider name**: `UseDirectPathFullLoad`**Description**: Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load. - `use_logminer_reader`**Type**: `BOOLEAN`**Provider name**: `UseLogminerReader`**Description**: Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set `UseLogminerReader` to N, also set `UseBfile` to Y. For more information on this setting and using Oracle ASM, see [Using Oracle LogMiner or DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the DMS User Guide. - `use_path_prefix`**Type**: `STRING`**Provider name**: `UsePathPrefix`**Description**: Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `port`{% #port %} **Type**: `INT32`**Provider name**: `Port`**Description**: The port value used to access the endpoint. ## `postgre_sql_settings`{% #postgre_sql_settings %} **Type**: `STRUCT`**Provider name**: `PostgreSQLSettings`**Description**: The settings for the PostgreSQL source and target endpoint. For more information, see the `PostgreSQLSettings` structure. - `after_connect_script`**Type**: `STRING`**Provider name**: `AfterConnectScript`**Description**: For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. Example: `afterConnectScript=SET session_replication_role='replica'` - `babelfish_database_name`**Type**: `STRING`**Provider name**: `BabelfishDatabaseName`**Description**: The Babelfish for Aurora PostgreSQL database name for the endpoint. - `capture_ddls`**Type**: `BOOLEAN`**Provider name**: `CaptureDdls`**Description**: To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts. If this value is set to `N`, you don't have to create tables or triggers on the source database. - `database_mode`**Type**: `STRING`**Provider name**: `DatabaseMode`**Description**: Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `ddl_artifacts_schema`**Type**: `STRING`**Provider name**: `DdlArtifactsSchema`**Description**: The schema in which the operational DDL database artifacts are created. Example: `ddlArtifactsSchema=xyzddlschema;` - `execute_timeout`**Type**: `INT32`**Provider name**: `ExecuteTimeout`**Description**: Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: `executeTimeout=100;` - `fail_tasks_on_lob_truncation`**Type**: `BOOLEAN`**Provider name**: `FailTasksOnLobTruncation`**Description**: When set to `true`, this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize`. If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data. - `heartbeat_enable`**Type**: `BOOLEAN`**Provider name**: `HeartbeatEnable`**Description**: The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios. - `heartbeat_frequency`**Type**: `INT32`**Provider name**: `HeartbeatFrequency`**Description**: Sets the WAL heartbeat frequency (in minutes). - `heartbeat_schema`**Type**: `STRING`**Provider name**: `HeartbeatSchema`**Description**: Sets the schema in which the heartbeat artifacts are created. - `map_boolean_as_boolean`**Type**: `BOOLEAN`**Provider name**: `MapBooleanAsBoolean`**Description**: When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as `varchar(5)`. You must set this setting on both the source and target endpoints for it to take effect. - `map_jsonb_as_clob`**Type**: `BOOLEAN`**Provider name**: `MapJsonbAsClob`**Description**: When true, DMS migrates JSONB values as CLOB. - `map_long_varchar_as`**Type**: `STRING`**Provider name**: `MapLongVarcharAs`**Description**: When true, DMS migrates LONG values as VARCHAR. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Example: `maxFileSize=512` - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `plugin_name`**Type**: `STRING`**Provider name**: `PluginName`**Description**: Specifies the plugin to use to create a replication slot. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. The default is 5432. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The host name of the endpoint database. For an Amazon RDS PostgreSQL instance, this is the output of [DescribeDBInstances](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html), in the `Endpoint .Address` field. For an Aurora PostgreSQL instance, this is the output of [DescribeDBClusters](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html), in the `Endpoint` field. - `slot_name`**Type**: `STRING`**Provider name**: `SlotName`**Description**: Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. When used with the `CdcStartPosition` request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of `CdcStartPosition`. If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error. For more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the Database Migration Service User Guide. For more information about using `CdcStartPosition`, see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html), [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html), and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html). - `trim_space_in_char`**Type**: `BOOLEAN`**Provider name**: `TrimSpaceInChar`**Description**: Use the `TrimSpaceInChar` source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is `true`. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `redis_settings`{% #redis_settings %} **Type**: `STRUCT`**Provider name**: `RedisSettings`**Description**: The settings for the Redis target endpoint. For more information, see the `RedisSettings` structure. - `auth_password`**Type**: `STRING`**Provider name**: `AuthPassword`**Description**: The password provided with the `auth-role` and `auth-token` options of the `AuthType` setting for a Redis target endpoint. - `auth_type`**Type**: `STRING`**Provider name**: `AuthType`**Description**: The type of authentication to perform when connecting to a Redis target. Options include `none`, `auth-token`, and `auth-role`. The `auth-token` option requires an `AuthPassword` value to be provided. The `auth-role` option requires `AuthUserName` and `AuthPassword` values to be provided. - `auth_user_name`**Type**: `STRING`**Provider name**: `AuthUserName`**Description**: The user name provided with the `auth-role` option of the `AuthType` setting for a Redis target endpoint. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Transmission Control Protocol (TCP) port for the endpoint. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: Fully qualified domain name of the endpoint. - `ssl_ca_certificate_arn`**Type**: `STRING`**Provider name**: `SslCaCertificateArn`**Description**: The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint. - `ssl_security_protocol`**Type**: `STRING`**Provider name**: `SslSecurityProtocol`**Description**: The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include `plaintext` and `ssl-encryption`. The default is `ssl-encryption`. The `ssl-encryption` option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the `SslCaCertificateArn`setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA. The `plaintext` option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database. ## `redshift_settings`{% #redshift_settings %} **Type**: `STRUCT`**Provider name**: `RedshiftSettings`**Description**: Settings for the Amazon Redshift endpoint. - `accept_any_date`**Type**: `BOOLEAN`**Provider name**: `AcceptAnyDate`**Description**: A value that indicates to allow 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` (the default). This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. - `after_connect_script`**Type**: `STRING`**Provider name**: `AfterConnectScript`**Description**: Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code. - `bucket_folder`**Type**: `STRING`**Provider name**: `BucketFolder`**Description**: An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. For full load mode, DMS converts source records into .csv files and loads them to the BucketFolder/TableID path. DMS uses the Redshift `COPY` command to upload the .csv files to the target table. The files are deleted once the `COPY` operation has finished. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the Amazon Redshift Database Developer Guide. For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path. - `bucket_name`**Type**: `STRING`**Provider name**: `BucketName`**Description**: The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift. - `case_sensitive_names`**Type**: `BOOLEAN`**Provider name**: `CaseSensitiveNames`**Description**: If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true`. The default is `false`. - `comp_update`**Type**: `BOOLEAN`**Provider name**: `CompUpdate`**Description**: If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than `RAW`. If you set `CompUpdate` to `false`, automatic compression is disabled and existing column encodings aren't changed. The default is `true`. - `connection_timeout`**Type**: `INT32`**Provider name**: `ConnectionTimeout`**Description**: A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: The name of the Amazon Redshift data warehouse (service) that you are working with. - `date_format`**Type**: `STRING`**Provider name**: `DateFormat`**Description**: The date format that you are using. Valid values are `auto` (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string. If your date and time values use formats different from each other, set this to `auto`. - `empty_as_null`**Type**: `BOOLEAN`**Provider name**: `EmptyAsNull`**Description**: A value that specifies whether 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`. - `encryption_mode`**Type**: `STRING`**Provider name**: `EncryptionMode`**Description**: The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either `SSE_S3` (the default) or `SSE_KMS`.For the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`. But you can't change the existing value from `SSE_S3` to `SSE_KMS`.To use `SSE_S3`, create an Identity and Access Management (IAM) role with a policy that allows `"arn:aws:s3:::*"` to use the following actions: `"s3:PutObject", "s3:ListBucket"` - `explicit_ids`**Type**: `BOOLEAN`**Provider name**: `ExplicitIds`**Description**: This setting is only valid for a full-load migration task. Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is `false`. - `file_transfer_upload_streams`**Type**: `INT32`**Provider name**: `FileTransferUploadStreams`**Description**: The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10. The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). `FileTransferUploadStreams` accepts a value from 1 through 64. It defaults to 10. - `load_timeout`**Type**: `INT32`**Provider name**: `LoadTimeout`**Description**: The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE. - `map_boolean_as_boolean`**Type**: `BOOLEAN`**Provider name**: `MapBooleanAsBoolean`**Description**: When true, lets Redshift migrate the boolean type as boolean. By default, Redshift migrates booleans as `varchar(1)`. You must set this setting on both the source and target endpoints for it to take effect. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB). - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: The password for the user named in the `username` property. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: The port number for Amazon Redshift. The default value is 5439. - `remove_quotes`**Type**: `BOOLEAN`**Provider name**: `RemoveQuotes`**Description**: A value that specifies to remove 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`. - `replace_chars`**Type**: `STRING`**Provider name**: `ReplaceChars`**Description**: A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars`, substituting the specified characters instead. The default is `"?"`. - `replace_invalid_chars`**Type**: `STRING`**Provider name**: `ReplaceInvalidChars`**Description**: A list of characters that you want to replace. Use with `ReplaceChars`. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: The name of the Amazon Redshift cluster you are using. - `server_side_encryption_kms_key_id`**Type**: `STRING`**Provider name**: `ServerSideEncryptionKmsKeyId`**Description**: The KMS key ID. If you are using `SSE_KMS` for the `EncryptionMode`, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key. - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the `iam:PassRole` action. - `time_format`**Type**: `STRING`**Provider name**: `TimeFormat`**Description**: The time format that 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 aren't supported when you use a time format string. If your date and time values use formats different from each other, set this parameter to `auto`. - `trim_blanks`**Type**: `BOOLEAN`**Provider name**: `TrimBlanks`**Description**: A value that specifies to remove 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`. - `truncate_columns`**Type**: `BOOLEAN`**Provider name**: `TruncateColumns`**Description**: A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter 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`**Type**: `STRING`**Provider name**: `Username`**Description**: An Amazon Redshift user name for a registered user. - `write_buffer_size`**Type**: `INT32`**Provider name**: `WriteBufferSize`**Description**: The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB). ## `s3_settings`{% #s3_settings %} **Type**: `STRUCT`**Provider name**: `S3Settings`**Description**: The settings for the S3 target endpoint. For more information, see the `S3Settings` structure. - `add_column_name`**Type**: `BOOLEAN`**Provider name**: `AddColumnName`**Description**: An optional parameter that, when set to `true` or `y`, you can use to add column name information to the .csv output file. The default value is `false`. Valid values are `true`, `false`, `y`, and `n`. - `add_trailing_padding_character`**Type**: `BOOLEAN`**Provider name**: `AddTrailingPaddingCharacter`**Description**: Use the S3 target endpoint setting `AddTrailingPaddingCharacter` to add padding on string data. The default value is `false`. - `bucket_folder`**Type**: `STRING`**Provider name**: `BucketFolder`**Description**: 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 isn't specified, then the path used is `schema_name / table_name /`. - `bucket_name`**Type**: `STRING`**Provider name**: `BucketName`**Description**: The name of the S3 bucket. - `canned_acl_for_objects`**Type**: `STRING`**Provider name**: `CannedAclForObjects`**Description**: A value that enables DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the Amazon S3 Developer Guide. The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL. - `cdc_inserts_and_updates`**Type**: `BOOLEAN`**Provider name**: `CdcInsertsAndUpdates`**Description**: A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file.DMS supports the use of the .parquet files in versions 3.4.7 and later.How these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the Database Migration Service User Guide..DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3.3.1 and later. `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both. - `cdc_inserts_only`**Type**: `BOOLEAN`**Provider name**: `CdcInsertsOnly`**Description**: A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the `false` setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target. If `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the Database Migration Service User Guide..DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3.1.4 and later. `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both. - `cdc_max_batch_interval`**Type**: `INT32`**Provider name**: `CdcMaxBatchInterval`**Description**: Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. When `CdcMaxBatchInterval` and `CdcMinFileSize` are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template. The default value is 60 seconds. - `cdc_min_file_size`**Type**: `INT32`**Provider name**: `CdcMinFileSize`**Description**: Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3. When `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template. The default value is 32 MB. - `cdc_path`**Type**: `STRING`**Provider name**: `CdcPath`**Description**: Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `CdcPath` is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set [`PreserveTransactions` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions)to `true`, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [`BucketFolder` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder)and [`BucketName` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName). For example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`. If you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`. For more information on CDC including transaction order on an S3 target, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath).This setting is supported in DMS versions 3.4.2 and later. - `compression_type`**Type**: `STRING`**Provider name**: `CompressionType`**Description**: An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. - `csv_delimiter`**Type**: `STRING`**Provider name**: `CsvDelimiter`**Description**: The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. - `csv_no_sup_value`**Type**: `STRING`**Provider name**: `CsvNoSupValue`**Description**: This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If [`UseCsvNoSupValue` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue)is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the `UseCsvNoSupValue` setting.This setting is supported in DMS versions 3.4.1 and later. - `csv_null_value`**Type**: `STRING`**Provider name**: `CsvNullValue`**Description**: An optional parameter that specifies how DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), DMS treats the empty string as the null value instead of `NULL`. The default value is `NULL`. Valid values include any valid string. - `csv_row_delimiter`**Type**: `STRING`**Provider name**: `CsvRowDelimiter`**Description**: The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (`\n`). - `data_format`**Type**: `STRING`**Provider name**: `DataFormat`**Description**: The format of the data that you want to use for output. You can choose one of the following: - `csv` : This is a row-based file format with comma-separated values (.csv). - `parquet` : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. - `data_page_size`**Type**: `INT32`**Provider name**: `DataPageSize`**Description**: The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. - `date_partition_delimiter`**Type**: `STRING`**Provider name**: `DatePartitionDelimiter`**Description**: Specifies a date separating delimiter to use during folder partitioning. The default value is `SLASH`. Use this parameter when `DatePartitionedEnabled` is set to `true`. - `date_partition_enabled`**Type**: `BOOLEAN`**Provider name**: `DatePartitionEnabled`**Description**: When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is `false`. For more information about date-based folder partitioning, see [Using date-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning). - `date_partition_sequence`**Type**: `STRING`**Provider name**: `DatePartitionSequence`**Description**: Identifies the sequence of the date format to use during folder partitioning. The default value is `YYYYMMDD`. Use this parameter when `DatePartitionedEnabled` is set to `true`. - `date_partition_timezone`**Type**: `STRING`**Provider name**: `DatePartitionTimezone`**Description**: When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example. `s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":" Asia/Seoul ", "BucketName": "dms-nattarat-test"}'` - `dict_page_size_limit`**Type**: `INT32`**Provider name**: `DictPageSizeLimit`**Description**: 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`. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to `PLAIN` encoding. This size is used for .parquet file format only. - `enable_statistics`**Type**: `BOOLEAN`**Provider name**: `EnableStatistics`**Description**: A value that enables statistics for Parquet pages and row groups. Choose `true` to enable statistics, `false` to disable. Statistics include `NULL`, `DISTINCT`, `MAX`, and `MIN` values. This parameter defaults to `true`. This value is used for .parquet file format only. - `encoding_type`**Type**: `STRING`**Provider name**: `EncodingType`**Description**: The type of encoding you are using: - `RLE_DICTIONARY` uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default. - `PLAIN` doesn't 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. - `encryption_mode`**Type**: `STRING`**Provider name**: `EncryptionMode`**Description**: The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either `SSE_S3` (the default) or `SSE_KMS`.For the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`. But you can't change the existing value from `SSE_S3` to `SSE_KMS`.To use `SSE_S3`, you need an Identity and Access Management (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` - `expected_bucket_owner`**Type**: `STRING`**Provider name**: `ExpectedBucketOwner`**Description**: To specify a bucket owner and prevent sniping, you can use the `ExpectedBucketOwner` endpoint setting. Example: `–s3-settings='{"ExpectedBucketOwner": " AWS_Account_ID "}'` When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter. - `external_table_definition`**Type**: `STRING`**Provider name**: `ExternalTableDefinition`**Description**: Specifies how tables are defined in the S3 source files only. - `glue_catalog_generation`**Type**: `BOOLEAN`**Provider name**: `GlueCatalogGeneration`**Description**: When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog lets you use Athena to query your data. - `ignore_header_rows`**Type**: `INT32`**Provider name**: `IgnoreHeaderRows`**Description**: When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature. The default is 0. - `include_op_for_full_load`**Type**: `BOOLEAN`**Provider name**: `IncludeOpForFullLoad`**Description**: A value that enables a full load to write INSERT operations to the comma-separated value (.csv) or .parquet output files only to indicate how the rows were added to the source database.DMS supports the `IncludeOpForFullLoad` parameter in versions 3.1.4 and later. DMS supports the use of the .parquet files with the `IncludeOpForFullLoad` parameter in versions 3.4.7 and later.For full load, records can only be inserted. By default (the `false` setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.This setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to .csv files only. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the Database Migration Service User Guide.. - `max_file_size`**Type**: `INT32`**Provider name**: `MaxFileSize`**Description**: A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576. - `parquet_timestamp_in_millisecond`**Type**: `BOOLEAN`**Provider name**: `ParquetTimestampInMillisecond`**Description**: A value that specifies the precision of any `TIMESTAMP` column values that are written to an Amazon S3 object file in .parquet format.DMS supports the `ParquetTimestampInMillisecond` parameter in versions 3.1.4 and later.When `ParquetTimestampInMillisecond` is set to `true` or `y`, DMS writes all `TIMESTAMP` columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision. Currently, Amazon Athena and Glue can handle only millisecond precision for `TIMESTAMP` values. Set this parameter to `true` for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.DMS writes any `TIMESTAMP` column values written to an S3 file in .csv format with microsecond precision. Setting `ParquetTimestampInMillisecond` has no effect on the string format of the timestamp column value that is inserted by setting the `TimestampColumnName` parameter. - `parquet_version`**Type**: `STRING`**Provider name**: `ParquetVersion`**Description**: The version of the Apache Parquet format that you want to use: `parquet_1_0` (the default) or `parquet_2_0`. - `preserve_transactions`**Type**: `BOOLEAN`**Provider name**: `PreserveTransactions`**Description**: If set to `true`, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by [`CdcPath` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath). For more information, see [Capturing data changes (CDC) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath).This setting is supported in DMS versions 3.4.2 and later. - `rfc4180`**Type**: `BOOLEAN`**Provider name**: `Rfc4180`**Description**: For an S3 source, when this value is set to `true` or `y`, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to `false` or `n`, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value. For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to `true` or `y` using Amazon S3 as a target, if the data has quotation marks or newline characters in it, DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice. The default value is `true`. Valid values include `true`, `false`, `y`, and `n`. - `row_group_length`**Type**: `INT32`**Provider name**: `RowGroupLength`**Description**: 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. This parameter defaults to 10,000 rows. This number is used for .parquet file 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). - `server_side_encryption_kms_key_id`**Type**: `STRING`**Provider name**: `ServerSideEncryptionKmsKeyId`**Description**: If you are using `SSE_KMS` for the `EncryptionMode`, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (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` - `service_access_role_arn`**Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the `iam:PassRole` action. It is a required parameter that enables DMS to write and read objects from an S3 bucket. - `timestamp_column_name`**Type**: `STRING`**Provider name**: `TimestampColumnName`**Description**: A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.DMS supports the `TimestampColumnName` parameter in versions 3.1.4 and later.DMS includes an additional `STRING` column in the .csv or .parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value. For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database. When the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`. - `use_csv_no_sup_value`**Type**: `BOOLEAN`**Provider name**: `UseCsvNoSupValue`**Description**: This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to `true` for columns not included in the supplemental log, DMS uses the value specified by [`CsvNoSupValue` ](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue). If not set or set to `false`, DMS uses the null value for these columns.This setting is supported in DMS versions 3.4.1 and later. - `use_task_start_time_for_full_load_timestamp`**Type**: `BOOLEAN`**Provider name**: `UseTaskStartTimeForFullLoadTimestamp`**Description**: When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when `useTaskStartTimeForFullLoadTimestamp` is set to `true`, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. When `useTaskStartTimeForFullLoadTimestamp` is set to `false`, the full load timestamp in the timestamp column increments with the time data arrives at the target. ## `server_name`{% #server_name %} **Type**: `STRING`**Provider name**: `ServerName`**Description**: The name of the server at the endpoint. ## `service_access_role_arn`{% #service_access_role_arn %} **Type**: `STRING`**Provider name**: `ServiceAccessRoleArn`**Description**: The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the `iam:PassRole` action. ## `ssl_mode`{% #ssl_mode %} **Type**: `STRING`**Provider name**: `SslMode`**Description**: The SSL mode used to connect to the endpoint. The default value is `none`. ## `status`{% #status %} **Type**: `STRING`**Provider name**: `Status`**Description**: The status of the endpoint. ## `sybase_settings`{% #sybase_settings %} **Type**: `STRUCT`**Provider name**: `SybaseSettings`**Description**: The settings for the SAP ASE source and target endpoint. For more information, see the `SybaseSettings` structure. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `password`**Type**: `STRING`**Provider name**: `Password`**Description**: Endpoint connection password. - `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Endpoint TCP port. The default is 5000. - `secrets_manager_access_role_arn`**Type**: `STRING`**Provider name**: `SecretsManagerAccessRoleArn`**Description**: The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`. The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.You can specify one of two sets of values for these permissions. You can specify the values for this setting and `SecretsManagerSecretId`. Or you can specify clear-text values for `UserName`, `Password`, `ServerName`, and `Port`. You can't specify both. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the Database Migration Service User Guide. - `secrets_manager_secret_id`**Type**: `STRING`**Provider name**: `SecretsManagerSecretId`**Description**: The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details. - `server_name`**Type**: `STRING`**Provider name**: `ServerName`**Description**: Fully qualified domain name of the endpoint. - `username`**Type**: `STRING`**Provider name**: `Username`**Description**: Endpoint connection user name. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `timestream_settings`{% #timestream_settings %} **Type**: `STRUCT`**Provider name**: `TimestreamSettings`**Description**: The settings for the Amazon Timestream target endpoint. For more information, see the `TimestreamSettings` structure. - `cdc_inserts_and_updates`**Type**: `BOOLEAN`**Provider name**: `CdcInsertsAndUpdates`**Description**: Set this attribute to `true` to specify that DMS only applies inserts and updates, and not deletes. Amazon Timestream does not allow deleting records, so if this value is `false`, DMS nulls out the corresponding record in the Timestream database rather than deleting it. - `database_name`**Type**: `STRING`**Provider name**: `DatabaseName`**Description**: Database name for the endpoint. - `enable_magnetic_store_writes`**Type**: `BOOLEAN`**Provider name**: `EnableMagneticStoreWrites`**Description**: Set this attribute to `true` to enable memory store writes. When this value is `false`, DMS does not write records that are older in days than the value specified in `MagneticDuration`, because Amazon Timestream does not allow memory writes by default. For more information, see [Storage](https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html) in the [Amazon Timestream Developer Guide](https://docs.aws.amazon.com/timestream/latest/developerguide/). - `magnetic_duration`**Type**: `INT32`**Provider name**: `MagneticDuration`**Description**: Set this attribute to specify the default magnetic duration applied to the Amazon Timestream tables in days. This is the number of days that records remain in magnetic store before being discarded. For more information, see [Storage](https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html) in the [Amazon Timestream Developer Guide](https://docs.aws.amazon.com/timestream/latest/developerguide/). - `memory_duration`**Type**: `INT32`**Provider name**: `MemoryDuration`**Description**: Set this attribute to specify the length of time to store all of the tables in memory that are migrated into Amazon Timestream from the source database. Time is measured in units of hours. When Timestream data comes in, it first resides in memory for the specified duration, which allows quick access to it. ## `username`{% #username %} **Type**: `STRING`**Provider name**: `Username`**Description**: The user name used to connect to the endpoint.