Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dms
  6. getEndpoint

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.dms.getEndpoint

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DMS::Endpoint

    Using getEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOutputOptions): Output<GetEndpointResult>
    def get_endpoint(endpoint_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_arn: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

    > Note: This function is named LookupEndpoint in the Go SDK.

    public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:dms:getEndpoint
  arguments:
    # arguments dictionary
    data "aws-native_dms_get_endpoint" "name" {
    # arguments
}

    The following arguments are supported:

    EndpointArn string
    The endpoint ARN.
    EndpointArn string
    The endpoint ARN.
    endpoint_arn string
    The endpoint ARN.
    endpointArn String
    The endpoint ARN.
    endpointArn string
    The endpoint ARN.
    endpoint_arn str
    The endpoint ARN.
    endpointArn String
    The endpoint ARN.

    getEndpoint Result

    The following output properties are available:

    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    DatabaseName string
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    DocDbSettings Pulumi.AwsNative.Dms.Outputs.EndpointDocDbSettings
    Settings in JSON format for the source and target DocumentDB endpoint
    DynamoDbSettings Pulumi.AwsNative.Dms.Outputs.EndpointDynamoDbSettings
    Settings in JSON format for the target Amazon DynamoDB endpoint
    ElasticsearchSettings Pulumi.AwsNative.Dms.Outputs.EndpointElasticsearchSettings
    Settings in JSON format for the target OpenSearch endpoint
    EndpointArn string
    The endpoint ARN.
    EndpointIdentifier string
    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.
    EndpointType string
    The type of endpoint. Valid values are source and target.
    EngineName string
    The type of engine for the endpoint, depending on the EndpointType value.
    ExternalId string
    A value that can be used for cross-account validation.
    GcpMySqlSettings Pulumi.AwsNative.Dms.Outputs.EndpointGcpMySqlSettings
    Settings in JSON format for the source GCP MySQL endpoint
    IbmDb2Settings Pulumi.AwsNative.Dms.Outputs.EndpointIbmDb2Settings
    Settings in JSON format for the source IBM Db2 LUW endpoint
    KafkaSettings Pulumi.AwsNative.Dms.Outputs.EndpointKafkaSettings
    Settings in JSON format for the target Apache Kafka endpoint
    KinesisSettings Pulumi.AwsNative.Dms.Outputs.EndpointKinesisSettings
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    MicrosoftSqlServerSettings Pulumi.AwsNative.Dms.Outputs.EndpointMicrosoftSqlServerSettings
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    MongoDbSettings Pulumi.AwsNative.Dms.Outputs.EndpointMongoDbSettings
    Settings in JSON format for the source MongoDB endpoint
    MySqlSettings Pulumi.AwsNative.Dms.Outputs.EndpointMySqlSettings
    Settings in JSON format for the source and target MySQL endpoin
    NeptuneSettings Pulumi.AwsNative.Dms.Outputs.EndpointNeptuneSettings
    Settings in JSON format for the target Amazon Neptune endpoint
    OracleSettings Pulumi.AwsNative.Dms.Outputs.EndpointOracleSettings
    Settings in JSON format for the source and target Oracle endpoint
    Port int
    The port used by the endpoint database.
    PostgreSqlSettings Pulumi.AwsNative.Dms.Outputs.EndpointPostgreSqlSettings
    Settings in JSON format for the source and target PostgreSQL endpoint.
    RedisSettings Pulumi.AwsNative.Dms.Outputs.EndpointRedisSettings
    Settings in JSON format for the target Redis endpoint
    RedshiftSettings Pulumi.AwsNative.Dms.Outputs.EndpointRedshiftSettings
    Settings in JSON format for the Amazon Redshift endpoint.
    S3Settings Pulumi.AwsNative.Dms.Outputs.EndpointS3Settings
    Settings in JSON format for the source and target Amazon S3 endpoint
    ServerName string
    The name of the server where the endpoint database resides.
    SslMode string
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    SybaseSettings Pulumi.AwsNative.Dms.Outputs.EndpointSybaseSettings
    Settings in JSON format for the source and target SAP ASE endpoint.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags to be assigned to the endpoint.
    Username string
    The user name to be used to log in to the endpoint database.
    CertificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    DatabaseName string
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    DocDbSettings EndpointDocDbSettings
    Settings in JSON format for the source and target DocumentDB endpoint
    DynamoDbSettings EndpointDynamoDbSettings
    Settings in JSON format for the target Amazon DynamoDB endpoint
    ElasticsearchSettings EndpointElasticsearchSettings
    Settings in JSON format for the target OpenSearch endpoint
    EndpointArn string
    The endpoint ARN.
    EndpointIdentifier string
    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.
    EndpointType string
    The type of endpoint. Valid values are source and target.
    EngineName string
    The type of engine for the endpoint, depending on the EndpointType value.
    ExternalId string
    A value that can be used for cross-account validation.
    GcpMySqlSettings EndpointGcpMySqlSettings
    Settings in JSON format for the source GCP MySQL endpoint
    IbmDb2Settings EndpointIbmDb2Settings
    Settings in JSON format for the source IBM Db2 LUW endpoint
    KafkaSettings EndpointKafkaSettings
    Settings in JSON format for the target Apache Kafka endpoint
    KinesisSettings EndpointKinesisSettings
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    MicrosoftSqlServerSettings EndpointMicrosoftSqlServerSettings
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    MongoDbSettings EndpointMongoDbSettings
    Settings in JSON format for the source MongoDB endpoint
    MySqlSettings EndpointMySqlSettings
    Settings in JSON format for the source and target MySQL endpoin
    NeptuneSettings EndpointNeptuneSettings
    Settings in JSON format for the target Amazon Neptune endpoint
    OracleSettings EndpointOracleSettings
    Settings in JSON format for the source and target Oracle endpoint
    Port int
    The port used by the endpoint database.
    PostgreSqlSettings EndpointPostgreSqlSettings
    Settings in JSON format for the source and target PostgreSQL endpoint.
    RedisSettings EndpointRedisSettings
    Settings in JSON format for the target Redis endpoint
    RedshiftSettings EndpointRedshiftSettings
    Settings in JSON format for the Amazon Redshift endpoint.
    S3Settings EndpointS3Settings
    Settings in JSON format for the source and target Amazon S3 endpoint
    ServerName string
    The name of the server where the endpoint database resides.
    SslMode string
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    SybaseSettings EndpointSybaseSettings
    Settings in JSON format for the source and target SAP ASE endpoint.
    Tags Tag
    One or more tags to be assigned to the endpoint.
    Username string
    The user name to be used to log in to the endpoint database.
    certificate_arn string
    The Amazon Resource Name (ARN) for the certificate.
    database_name string
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    doc_db_settings object
    Settings in JSON format for the source and target DocumentDB endpoint
    dynamo_db_settings object
    Settings in JSON format for the target Amazon DynamoDB endpoint
    elasticsearch_settings object
    Settings in JSON format for the target OpenSearch endpoint
    endpoint_arn string
    The endpoint ARN.
    endpoint_identifier string
    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 string
    The type of endpoint. Valid values are source and target.
    engine_name string
    The type of engine for the endpoint, depending on the EndpointType value.
    external_id string
    A value that can be used for cross-account validation.
    gcp_my_sql_settings object
    Settings in JSON format for the source GCP MySQL endpoint
    ibm_db2_settings object
    Settings in JSON format for the source IBM Db2 LUW endpoint
    kafka_settings object
    Settings in JSON format for the target Apache Kafka endpoint
    kinesis_settings object
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    microsoft_sql_server_settings object
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    mongo_db_settings object
    Settings in JSON format for the source MongoDB endpoint
    my_sql_settings object
    Settings in JSON format for the source and target MySQL endpoin
    neptune_settings object
    Settings in JSON format for the target Amazon Neptune endpoint
    oracle_settings object
    Settings in JSON format for the source and target Oracle endpoint
    port number
    The port used by the endpoint database.
    postgre_sql_settings object
    Settings in JSON format for the source and target PostgreSQL endpoint.
    redis_settings object
    Settings in JSON format for the target Redis endpoint
    redshift_settings object
    Settings in JSON format for the Amazon Redshift endpoint.
    s3_settings object
    Settings in JSON format for the source and target Amazon S3 endpoint
    server_name string
    The name of the server where the endpoint database resides.
    ssl_mode string
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    sybase_settings object
    Settings in JSON format for the source and target SAP ASE endpoint.
    tags list(object)
    One or more tags to be assigned to the endpoint.
    username string
    The user name to be used to log in to the endpoint database.
    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    databaseName String
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    docDbSettings EndpointDocDbSettings
    Settings in JSON format for the source and target DocumentDB endpoint
    dynamoDbSettings EndpointDynamoDbSettings
    Settings in JSON format for the target Amazon DynamoDB endpoint
    elasticsearchSettings EndpointElasticsearchSettings
    Settings in JSON format for the target OpenSearch endpoint
    endpointArn String
    The endpoint ARN.
    endpointIdentifier String
    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.
    endpointType String
    The type of endpoint. Valid values are source and target.
    engineName String
    The type of engine for the endpoint, depending on the EndpointType value.
    externalId String
    A value that can be used for cross-account validation.
    gcpMySqlSettings EndpointGcpMySqlSettings
    Settings in JSON format for the source GCP MySQL endpoint
    ibmDb2Settings EndpointIbmDb2Settings
    Settings in JSON format for the source IBM Db2 LUW endpoint
    kafkaSettings EndpointKafkaSettings
    Settings in JSON format for the target Apache Kafka endpoint
    kinesisSettings EndpointKinesisSettings
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    microsoftSqlServerSettings EndpointMicrosoftSqlServerSettings
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    mongoDbSettings EndpointMongoDbSettings
    Settings in JSON format for the source MongoDB endpoint
    mySqlSettings EndpointMySqlSettings
    Settings in JSON format for the source and target MySQL endpoin
    neptuneSettings EndpointNeptuneSettings
    Settings in JSON format for the target Amazon Neptune endpoint
    oracleSettings EndpointOracleSettings
    Settings in JSON format for the source and target Oracle endpoint
    port Integer
    The port used by the endpoint database.
    postgreSqlSettings EndpointPostgreSqlSettings
    Settings in JSON format for the source and target PostgreSQL endpoint.
    redisSettings EndpointRedisSettings
    Settings in JSON format for the target Redis endpoint
    redshiftSettings EndpointRedshiftSettings
    Settings in JSON format for the Amazon Redshift endpoint.
    s3Settings EndpointS3Settings
    Settings in JSON format for the source and target Amazon S3 endpoint
    serverName String
    The name of the server where the endpoint database resides.
    sslMode String
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    sybaseSettings EndpointSybaseSettings
    Settings in JSON format for the source and target SAP ASE endpoint.
    tags List<Tag>
    One or more tags to be assigned to the endpoint.
    username String
    The user name to be used to log in to the endpoint database.
    certificateArn string
    The Amazon Resource Name (ARN) for the certificate.
    databaseName string
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    docDbSettings EndpointDocDbSettings
    Settings in JSON format for the source and target DocumentDB endpoint
    dynamoDbSettings EndpointDynamoDbSettings
    Settings in JSON format for the target Amazon DynamoDB endpoint
    elasticsearchSettings EndpointElasticsearchSettings
    Settings in JSON format for the target OpenSearch endpoint
    endpointArn string
    The endpoint ARN.
    endpointIdentifier string
    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.
    endpointType string
    The type of endpoint. Valid values are source and target.
    engineName string
    The type of engine for the endpoint, depending on the EndpointType value.
    externalId string
    A value that can be used for cross-account validation.
    gcpMySqlSettings EndpointGcpMySqlSettings
    Settings in JSON format for the source GCP MySQL endpoint
    ibmDb2Settings EndpointIbmDb2Settings
    Settings in JSON format for the source IBM Db2 LUW endpoint
    kafkaSettings EndpointKafkaSettings
    Settings in JSON format for the target Apache Kafka endpoint
    kinesisSettings EndpointKinesisSettings
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    microsoftSqlServerSettings EndpointMicrosoftSqlServerSettings
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    mongoDbSettings EndpointMongoDbSettings
    Settings in JSON format for the source MongoDB endpoint
    mySqlSettings EndpointMySqlSettings
    Settings in JSON format for the source and target MySQL endpoin
    neptuneSettings EndpointNeptuneSettings
    Settings in JSON format for the target Amazon Neptune endpoint
    oracleSettings EndpointOracleSettings
    Settings in JSON format for the source and target Oracle endpoint
    port number
    The port used by the endpoint database.
    postgreSqlSettings EndpointPostgreSqlSettings
    Settings in JSON format for the source and target PostgreSQL endpoint.
    redisSettings EndpointRedisSettings
    Settings in JSON format for the target Redis endpoint
    redshiftSettings EndpointRedshiftSettings
    Settings in JSON format for the Amazon Redshift endpoint.
    s3Settings EndpointS3Settings
    Settings in JSON format for the source and target Amazon S3 endpoint
    serverName string
    The name of the server where the endpoint database resides.
    sslMode string
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    sybaseSettings EndpointSybaseSettings
    Settings in JSON format for the source and target SAP ASE endpoint.
    tags Tag[]
    One or more tags to be assigned to the endpoint.
    username string
    The user name to be used to log in to the endpoint database.
    certificate_arn str
    The Amazon Resource Name (ARN) for the certificate.
    database_name str
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    doc_db_settings EndpointDocDbSettings
    Settings in JSON format for the source and target DocumentDB endpoint
    dynamo_db_settings EndpointDynamoDbSettings
    Settings in JSON format for the target Amazon DynamoDB endpoint
    elasticsearch_settings EndpointElasticsearchSettings
    Settings in JSON format for the target OpenSearch endpoint
    endpoint_arn str
    The endpoint ARN.
    endpoint_identifier str
    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 str
    The type of endpoint. Valid values are source and target.
    engine_name str
    The type of engine for the endpoint, depending on the EndpointType value.
    external_id str
    A value that can be used for cross-account validation.
    gcp_my_sql_settings EndpointGcpMySqlSettings
    Settings in JSON format for the source GCP MySQL endpoint
    ibm_db2_settings EndpointIbmDb2Settings
    Settings in JSON format for the source IBM Db2 LUW endpoint
    kafka_settings EndpointKafkaSettings
    Settings in JSON format for the target Apache Kafka endpoint
    kinesis_settings EndpointKinesisSettings
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    microsoft_sql_server_settings EndpointMicrosoftSqlServerSettings
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    mongo_db_settings EndpointMongoDbSettings
    Settings in JSON format for the source MongoDB endpoint
    my_sql_settings EndpointMySqlSettings
    Settings in JSON format for the source and target MySQL endpoin
    neptune_settings EndpointNeptuneSettings
    Settings in JSON format for the target Amazon Neptune endpoint
    oracle_settings EndpointOracleSettings
    Settings in JSON format for the source and target Oracle endpoint
    port int
    The port used by the endpoint database.
    postgre_sql_settings EndpointPostgreSqlSettings
    Settings in JSON format for the source and target PostgreSQL endpoint.
    redis_settings EndpointRedisSettings
    Settings in JSON format for the target Redis endpoint
    redshift_settings EndpointRedshiftSettings
    Settings in JSON format for the Amazon Redshift endpoint.
    s3_settings EndpointS3Settings
    Settings in JSON format for the source and target Amazon S3 endpoint
    server_name str
    The name of the server where the endpoint database resides.
    ssl_mode str
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    sybase_settings EndpointSybaseSettings
    Settings in JSON format for the source and target SAP ASE endpoint.
    tags Sequence[root_Tag]
    One or more tags to be assigned to the endpoint.
    username str
    The user name to be used to log in to the endpoint database.
    certificateArn String
    The Amazon Resource Name (ARN) for the certificate.
    databaseName String
    The name of the endpoint database. For a MySQL source or target endpoint, don't specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
    docDbSettings Property Map
    Settings in JSON format for the source and target DocumentDB endpoint
    dynamoDbSettings Property Map
    Settings in JSON format for the target Amazon DynamoDB endpoint
    elasticsearchSettings Property Map
    Settings in JSON format for the target OpenSearch endpoint
    endpointArn String
    The endpoint ARN.
    endpointIdentifier String
    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.
    endpointType String
    The type of endpoint. Valid values are source and target.
    engineName String
    The type of engine for the endpoint, depending on the EndpointType value.
    externalId String
    A value that can be used for cross-account validation.
    gcpMySqlSettings Property Map
    Settings in JSON format for the source GCP MySQL endpoint
    ibmDb2Settings Property Map
    Settings in JSON format for the source IBM Db2 LUW endpoint
    kafkaSettings Property Map
    Settings in JSON format for the target Apache Kafka endpoint
    kinesisSettings Property Map
    Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams
    microsoftSqlServerSettings Property Map
    Settings in JSON format for the source and target Microsoft SQL Server endpoint
    mongoDbSettings Property Map
    Settings in JSON format for the source MongoDB endpoint
    mySqlSettings Property Map
    Settings in JSON format for the source and target MySQL endpoin
    neptuneSettings Property Map
    Settings in JSON format for the target Amazon Neptune endpoint
    oracleSettings Property Map
    Settings in JSON format for the source and target Oracle endpoint
    port Number
    The port used by the endpoint database.
    postgreSqlSettings Property Map
    Settings in JSON format for the source and target PostgreSQL endpoint.
    redisSettings Property Map
    Settings in JSON format for the target Redis endpoint
    redshiftSettings Property Map
    Settings in JSON format for the Amazon Redshift endpoint.
    s3Settings Property Map
    Settings in JSON format for the source and target Amazon S3 endpoint
    serverName String
    The name of the server where the endpoint database resides.
    sslMode String
    The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none.
    sybaseSettings Property Map
    Settings in JSON format for the source and target SAP ASE endpoint.
    tags List<Property Map>
    One or more tags to be assigned to the endpoint.
    username String
    The user name to be used to log in to the endpoint database.

    Supporting Types

    EndpointDocDbSettings

    DocsToInvestigate int
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    ExtractDocId bool
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    NestingLevel string
    Specifies either document or table mode.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    SecretsManagerSecretId string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    DocsToInvestigate int
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    ExtractDocId bool
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    NestingLevel string
    Specifies either document or table mode.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    SecretsManagerSecretId string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    docs_to_investigate number
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extract_doc_id bool
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    nesting_level string
    Specifies either document or table mode.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    secrets_manager_secret_id string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    docsToInvestigate Integer
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId Boolean
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    nestingLevel String
    Specifies either document or table mode.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    secretsManagerSecretId String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    docsToInvestigate number
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId boolean
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    nestingLevel string
    Specifies either document or table mode.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    secretsManagerSecretId string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    docs_to_investigate int
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extract_doc_id bool
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    nesting_level str
    Specifies either document or table mode.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    secrets_manager_secret_id str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    docsToInvestigate Number
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId Boolean
    Specifies the document ID. Use this setting when NestingLevel is set to "none"
    nestingLevel String
    Specifies either document or table mode.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.
    secretsManagerSecretId String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the DocumentDB endpoint.

    EndpointDynamoDbSettings

    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    service_access_role_arn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    serviceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    service_access_role_arn str
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

    EndpointElasticsearchSettings

    EndpointUri string
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    ErrorRetryDuration int
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    FullLoadErrorPercentage int
    The maximum percentage of records that can fail to be written before a full load operation stops.
    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    EndpointUri string
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    ErrorRetryDuration int
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    FullLoadErrorPercentage int
    The maximum percentage of records that can fail to be written before a full load operation stops.
    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    endpoint_uri string
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    error_retry_duration number
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    full_load_error_percentage number
    The maximum percentage of records that can fail to be written before a full load operation stops.
    service_access_role_arn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    endpointUri String
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    errorRetryDuration Integer
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    fullLoadErrorPercentage Integer
    The maximum percentage of records that can fail to be written before a full load operation stops.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    endpointUri string
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    errorRetryDuration number
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    fullLoadErrorPercentage number
    The maximum percentage of records that can fail to be written before a full load operation stops.
    serviceAccessRoleArn string
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    endpoint_uri str
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    error_retry_duration int
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    full_load_error_percentage int
    The maximum percentage of records that can fail to be written before a full load operation stops.
    service_access_role_arn str
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    endpointUri String
    The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (either HTTP or HTTPS) isn't specified.
    errorRetryDuration Number
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    fullLoadErrorPercentage Number
    The maximum percentage of records that can fail to be written before a full load operation stops.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

    EndpointGcpMySqlSettings

    AfterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    CleanSourceMetadataOnMismatch bool
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    DatabaseName string
    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 AWS DMS task.
    EventsPollInterval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    ParallelLoadThreads int
    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.
    Password string
    Endpoint connection password.
    Port int
    The port used by the endpoint database.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    ServerName string
    The MySQL host name.
    ServerTimezone string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    Username string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    AfterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    CleanSourceMetadataOnMismatch bool
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    DatabaseName string
    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 AWS DMS task.
    EventsPollInterval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    ParallelLoadThreads int
    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.
    Password string
    Endpoint connection password.
    Port int
    The port used by the endpoint database.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    ServerName string
    The MySQL host name.
    ServerTimezone string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    Username string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    after_connect_script string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    clean_source_metadata_on_mismatch bool
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    database_name string
    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 AWS DMS task.
    events_poll_interval number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    max_file_size number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallel_load_threads number
    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.
    password string
    Endpoint connection password.
    port number
    The port used by the endpoint database.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    server_name string
    The MySQL host name.
    server_timezone string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    username string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    afterConnectScript String
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch Boolean
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    databaseName String
    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 AWS DMS task.
    eventsPollInterval Integer
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize Integer
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads Integer
    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.
    password String
    Endpoint connection password.
    port Integer
    The port used by the endpoint database.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverName String
    The MySQL host name.
    serverTimezone String
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    username String
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    afterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch boolean
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    databaseName string
    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 AWS DMS task.
    eventsPollInterval number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads number
    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.
    password string
    Endpoint connection password.
    port number
    The port used by the endpoint database.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverName string
    The MySQL host name.
    serverTimezone string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    username string
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    after_connect_script str
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    clean_source_metadata_on_mismatch bool
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    database_name str
    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 AWS DMS task.
    events_poll_interval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    max_file_size int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallel_load_threads int
    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.
    password str
    Endpoint connection password.
    port int
    The port used by the endpoint database.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    server_name str
    The MySQL host name.
    server_timezone str
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    username str
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    afterConnectScript String
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch Boolean
    Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.
    databaseName String
    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 AWS DMS task.
    eventsPollInterval Number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize Number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads Number
    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.
    password String
    Endpoint connection password.
    port Number
    The port used by the endpoint database.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 AWS Secrets Manager secret that allows access to the MySQL endpoint.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverName String
    The MySQL host name.
    serverTimezone String
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.
    username String
    Specifies the time zone for the source MySQL database. Don't enclose time zones in single quotation marks.

    EndpointIbmDb2Settings

    CurrentLsn string
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    KeepCsvFiles bool
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    LoadTimeout int
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    MaxFileSize int
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    MaxKBytesPerRead int
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    SetDataCaptureChanges bool
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    WriteBufferSize int
    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).
    CurrentLsn string
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    KeepCsvFiles bool
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    LoadTimeout int
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    MaxFileSize int
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    MaxKBytesPerRead int
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    SetDataCaptureChanges bool
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    WriteBufferSize int
    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).
    current_lsn string
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    keep_csv_files bool
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    load_timeout number
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    max_file_size number
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    max_k_bytes_per_read number
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    set_data_capture_changes bool
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    write_buffer_size number
    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).
    currentLsn String
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    keepCsvFiles Boolean
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    loadTimeout Integer
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    maxFileSize Integer
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    maxKBytesPerRead Integer
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    setDataCaptureChanges Boolean
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    writeBufferSize Integer
    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).
    currentLsn string
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    keepCsvFiles boolean
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    loadTimeout number
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    maxFileSize number
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    maxKBytesPerRead number
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    setDataCaptureChanges boolean
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    writeBufferSize number
    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).
    current_lsn str
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    keep_csv_files bool
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    load_timeout int
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    max_file_size int
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    max_k_bytes_per_read int
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    set_data_capture_changes bool
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    write_buffer_size int
    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).
    currentLsn String
    For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
    keepCsvFiles Boolean
    If true, AWS DMS saves any .csv files to the Db2 LUW target that were used to replicate data. DMS uses these files for analysis and troubleshooting.
    loadTimeout Number
    The amount of time (in milliseconds) before AWS DMS times out operations performed by DMS on the Db2 target. The default value is 1200 (20 minutes).
    maxFileSize Number
    Specifies the maximum size (in KB) of .csv files used to transfer data to Db2 LUW.
    maxKBytesPerRead Number
    Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS 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 ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
    setDataCaptureChanges Boolean
    Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
    writeBufferSize Number
    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).

    EndpointKafkaSettings

    Broker string
    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
    IncludeControlDetails bool
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    IncludeNullAndEmpty bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    IncludePartitionValue bool
    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
    IncludeTableAlterOperations bool
    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.
    IncludeTransactionDetails bool
    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.
    MessageFormat string
    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).
    MessageMaxBytes int
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    NoHexPrefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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.
    PartitionIncludeSchemaTable bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    SaslPassword string
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    SaslUserName string
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    SecurityProtocol string
    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.
    SslCaCertificateArn string
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    SslClientCertificateArn string
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    SslClientKeyArn string
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    SslClientKeyPassword string
    The password for the client private key used to securely connect to a Kafka target endpoint.
    Topic string
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    Broker string
    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
    IncludeControlDetails bool
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    IncludeNullAndEmpty bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    IncludePartitionValue bool
    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
    IncludeTableAlterOperations bool
    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.
    IncludeTransactionDetails bool
    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.
    MessageFormat string
    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).
    MessageMaxBytes int
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    NoHexPrefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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.
    PartitionIncludeSchemaTable bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    SaslPassword string
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    SaslUserName string
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    SecurityProtocol string
    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.
    SslCaCertificateArn string
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    SslClientCertificateArn string
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    SslClientKeyArn string
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    SslClientKeyPassword string
    The password for the client private key used to securely connect to a Kafka target endpoint.
    Topic string
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    broker string
    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
    include_control_details bool
    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 bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    include_partition_value bool
    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 bool
    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 bool
    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 string
    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 number
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    no_hex_prefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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 bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    sasl_password string
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    sasl_user_name string
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    security_protocol string
    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 string
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    ssl_client_certificate_arn string
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    ssl_client_key_arn string
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    ssl_client_key_password string
    The password for the client private key used to securely connect to a Kafka target endpoint.
    topic string
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    broker String
    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
    includeControlDetails Boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    includeNullAndEmpty Boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue Boolean
    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations Boolean
    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.
    includeTransactionDetails Boolean
    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.
    messageFormat String
    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).
    messageMaxBytes Integer
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    noHexPrefix Boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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.
    partitionIncludeSchemaTable Boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    saslPassword String
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    saslUserName String
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    securityProtocol String
    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.
    sslCaCertificateArn String
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    sslClientCertificateArn String
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    sslClientKeyArn String
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    sslClientKeyPassword String
    The password for the client private key used to securely connect to a Kafka target endpoint.
    topic String
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    broker string
    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
    includeControlDetails boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    includeNullAndEmpty boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue boolean
    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations boolean
    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.
    includeTransactionDetails boolean
    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.
    messageFormat string
    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).
    messageMaxBytes number
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    noHexPrefix boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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.
    partitionIncludeSchemaTable boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    saslPassword string
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    saslUserName string
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    securityProtocol string
    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.
    sslCaCertificateArn string
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    sslClientCertificateArn string
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    sslClientKeyArn string
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    sslClientKeyPassword string
    The password for the client private key used to securely connect to a Kafka target endpoint.
    topic string
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    broker str
    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
    include_control_details bool
    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 bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    include_partition_value bool
    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 bool
    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 bool
    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 str
    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 int
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    no_hex_prefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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 bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    sasl_password str
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    sasl_user_name str
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    security_protocol str
    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 str
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    ssl_client_certificate_arn str
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    ssl_client_key_arn str
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    ssl_client_key_password str
    The password for the client private key used to securely connect to a Kafka target endpoint.
    topic str
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    broker String
    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
    includeControlDetails Boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    includeNullAndEmpty Boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue Boolean
    Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations Boolean
    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.
    includeTransactionDetails Boolean
    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.
    messageFormat String
    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).
    messageMaxBytes Number
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    noHexPrefix Boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, AWS 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.
    partitionIncludeSchemaTable Boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    saslPassword String
    The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    saslUserName String
    The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    securityProtocol String
    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.
    sslCaCertificateArn String
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
    sslClientCertificateArn String
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    sslClientKeyArn String
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    sslClientKeyPassword String
    The password for the client private key used to securely connect to a Kafka target endpoint.
    topic String
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.

    EndpointKinesisSettings

    IncludeControlDetails bool
    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
    IncludeNullAndEmpty bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    IncludePartitionValue bool
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
    IncludeTableAlterOperations bool
    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.
    IncludeTransactionDetails bool
    Provides detailed transaction information from the source database.
    MessageFormat string
    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).
    NoHexPrefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    PartitionIncludeSchemaTable bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    StreamArn string
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    IncludeControlDetails bool
    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
    IncludeNullAndEmpty bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    IncludePartitionValue bool
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
    IncludeTableAlterOperations bool
    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.
    IncludeTransactionDetails bool
    Provides detailed transaction information from the source database.
    MessageFormat string
    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).
    NoHexPrefix bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    PartitionIncludeSchemaTable bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    ServiceAccessRoleArn string
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    StreamArn string
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    include_control_details bool
    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 bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    include_partition_value bool
    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 bool
    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 bool
    Provides detailed transaction information from the source database.
    message_format string
    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 bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    partition_include_schema_table bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    service_access_role_arn string
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    stream_arn string
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    includeControlDetails Boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
    includeNullAndEmpty Boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue Boolean
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations Boolean
    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.
    includeTransactionDetails Boolean
    Provides detailed transaction information from the source database.
    messageFormat String
    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).
    noHexPrefix Boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    partitionIncludeSchemaTable Boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    streamArn String
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    includeControlDetails boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
    includeNullAndEmpty boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue boolean
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations boolean
    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.
    includeTransactionDetails boolean
    Provides detailed transaction information from the source database.
    messageFormat string
    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).
    noHexPrefix boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    partitionIncludeSchemaTable boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    serviceAccessRoleArn string
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    streamArn string
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    include_control_details bool
    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 bool
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    include_partition_value bool
    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 bool
    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 bool
    Provides detailed transaction information from the source database.
    message_format str
    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 bool
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    partition_include_schema_table bool
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    service_access_role_arn str
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    stream_arn str
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
    includeControlDetails Boolean
    Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.
    includeNullAndEmpty Boolean
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    includePartitionValue Boolean
    Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.
    includeTableAlterOperations Boolean
    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.
    includeTransactionDetails Boolean
    Provides detailed transaction information from the source database.
    messageFormat String
    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).
    noHexPrefix Boolean
    Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.
    partitionIncludeSchemaTable Boolean
    Prefixes schema and table names to partition values, when the partition type is primary-key-type.
    serviceAccessRoleArn String
    The Amazon Resource Name (ARN) for the IAM role that AWS DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.
    streamArn String
    The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

    EndpointMicrosoftSqlServerSettings

    BcpPacketSize int
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    ControlTablesFileGroup string
    Specifies a file group for the AWS DMS internal tables.
    DatabaseName string
    Database name for the endpoint.
    ForceLobLookup bool
    Forces LOB lookup on inline LOB.
    Password string
    Endpoint connection password.
    Port int
    Endpoint TCP port.
    QuerySingleAlwaysOnNode bool
    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.
    ReadBackupOnly bool
    When this attribute is set to Y, AWS 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.
    SafeguardPolicy string
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    ServerName string
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    TlogAccessMode string
    Indicates the mode used to fetch CDC data.
    TrimSpaceInChar bool
    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.
    UseBcpFullLoad bool
    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.
    UseThirdPartyBackupDevice bool
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    Username string
    Endpoint connection user name.
    BcpPacketSize int
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    ControlTablesFileGroup string
    Specifies a file group for the AWS DMS internal tables.
    DatabaseName string
    Database name for the endpoint.
    ForceLobLookup bool
    Forces LOB lookup on inline LOB.
    Password string
    Endpoint connection password.
    Port int
    Endpoint TCP port.
    QuerySingleAlwaysOnNode bool
    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.
    ReadBackupOnly bool
    When this attribute is set to Y, AWS 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.
    SafeguardPolicy string
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    ServerName string
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    TlogAccessMode string
    Indicates the mode used to fetch CDC data.
    TrimSpaceInChar bool
    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.
    UseBcpFullLoad bool
    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.
    UseThirdPartyBackupDevice bool
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    Username string
    Endpoint connection user name.
    bcp_packet_size number
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    control_tables_file_group string
    Specifies a file group for the AWS DMS internal tables.
    database_name string
    Database name for the endpoint.
    force_lob_lookup bool
    Forces LOB lookup on inline LOB.
    password string
    Endpoint connection password.
    port number
    Endpoint TCP port.
    query_single_always_on_node bool
    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 bool
    When this attribute is set to Y, AWS 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 string
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    server_name string
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    tlog_access_mode string
    Indicates the mode used to fetch CDC data.
    trim_space_in_char bool
    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 bool
    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 bool
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    username string
    Endpoint connection user name.
    bcpPacketSize Integer
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    controlTablesFileGroup String
    Specifies a file group for the AWS DMS internal tables.
    databaseName String
    Database name for the endpoint.
    forceLobLookup Boolean
    Forces LOB lookup on inline LOB.
    password String
    Endpoint connection password.
    port Integer
    Endpoint TCP port.
    querySingleAlwaysOnNode Boolean
    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.
    readBackupOnly Boolean
    When this attribute is set to Y, AWS 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.
    safeguardPolicy String
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    serverName String
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    tlogAccessMode String
    Indicates the mode used to fetch CDC data.
    trimSpaceInChar Boolean
    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.
    useBcpFullLoad Boolean
    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.
    useThirdPartyBackupDevice Boolean
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    username String
    Endpoint connection user name.
    bcpPacketSize number
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    controlTablesFileGroup string
    Specifies a file group for the AWS DMS internal tables.
    databaseName string
    Database name for the endpoint.
    forceLobLookup boolean
    Forces LOB lookup on inline LOB.
    password string
    Endpoint connection password.
    port number
    Endpoint TCP port.
    querySingleAlwaysOnNode boolean
    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.
    readBackupOnly boolean
    When this attribute is set to Y, AWS 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.
    safeguardPolicy string
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    serverName string
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    tlogAccessMode string
    Indicates the mode used to fetch CDC data.
    trimSpaceInChar boolean
    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.
    useBcpFullLoad boolean
    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.
    useThirdPartyBackupDevice boolean
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    username string
    Endpoint connection user name.
    bcp_packet_size int
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    control_tables_file_group str
    Specifies a file group for the AWS DMS internal tables.
    database_name str
    Database name for the endpoint.
    force_lob_lookup bool
    Forces LOB lookup on inline LOB.
    password str
    Endpoint connection password.
    port int
    Endpoint TCP port.
    query_single_always_on_node bool
    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 bool
    When this attribute is set to Y, AWS 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 str
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    server_name str
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    tlog_access_mode str
    Indicates the mode used to fetch CDC data.
    trim_space_in_char bool
    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 bool
    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 bool
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    username str
    Endpoint connection user name.
    bcpPacketSize Number
    The maximum size of the packets (in bytes) used to transfer data using BCP.
    controlTablesFileGroup String
    Specifies a file group for the AWS DMS internal tables.
    databaseName String
    Database name for the endpoint.
    forceLobLookup Boolean
    Forces LOB lookup on inline LOB.
    password String
    Endpoint connection password.
    port Number
    Endpoint TCP port.
    querySingleAlwaysOnNode Boolean
    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.
    readBackupOnly Boolean
    When this attribute is set to Y, AWS 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.
    safeguardPolicy String
    Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MicrosoftSQLServer endpoint connection details.
    serverName String
    Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.
    tlogAccessMode String
    Indicates the mode used to fetch CDC data.
    trimSpaceInChar Boolean
    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.
    useBcpFullLoad Boolean
    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.
    useThirdPartyBackupDevice Boolean
    When this attribute is set to Y, DMS processes third-party transaction log backups if they are created in native format.
    username String
    Endpoint connection user name.

    EndpointMongoDbSettings

    AuthMechanism string
    The authentication mechanism you use to access the MongoDB source endpoint.
    AuthSource string
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    AuthType string
    The authentication type you use to access the MongoDB source endpoint.
    DatabaseName string
    The database name on the MongoDB source endpoint.
    DocsToInvestigate string
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    ExtractDocId string
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    NestingLevel string
    Specifies either document or table mode.
    Password string
    The password for the user account you use to access the MongoDB source endpoint.
    Port int
    The port value for the MongoDB source endpoint.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    ServerName string
    The name of the server on the MongoDB source endpoint.
    Username string
    The user name you use to access the MongoDB source endpoint.
    AuthMechanism string
    The authentication mechanism you use to access the MongoDB source endpoint.
    AuthSource string
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    AuthType string
    The authentication type you use to access the MongoDB source endpoint.
    DatabaseName string
    The database name on the MongoDB source endpoint.
    DocsToInvestigate string
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    ExtractDocId string
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    NestingLevel string
    Specifies either document or table mode.
    Password string
    The password for the user account you use to access the MongoDB source endpoint.
    Port int
    The port value for the MongoDB source endpoint.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    ServerName string
    The name of the server on the MongoDB source endpoint.
    Username string
    The user name you use to access the MongoDB source endpoint.
    auth_mechanism string
    The authentication mechanism you use to access the MongoDB source endpoint.
    auth_source string
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    auth_type string
    The authentication type you use to access the MongoDB source endpoint.
    database_name string
    The database name on the MongoDB source endpoint.
    docs_to_investigate string
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extract_doc_id string
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    nesting_level string
    Specifies either document or table mode.
    password string
    The password for the user account you use to access the MongoDB source endpoint.
    port number
    The port value for the MongoDB source endpoint.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    server_name string
    The name of the server on the MongoDB source endpoint.
    username string
    The user name you use to access the MongoDB source endpoint.
    authMechanism String
    The authentication mechanism you use to access the MongoDB source endpoint.
    authSource String
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    authType String
    The authentication type you use to access the MongoDB source endpoint.
    databaseName String
    The database name on the MongoDB source endpoint.
    docsToInvestigate String
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId String
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    nestingLevel String
    Specifies either document or table mode.
    password String
    The password for the user account you use to access the MongoDB source endpoint.
    port Integer
    The port value for the MongoDB source endpoint.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    serverName String
    The name of the server on the MongoDB source endpoint.
    username String
    The user name you use to access the MongoDB source endpoint.
    authMechanism string
    The authentication mechanism you use to access the MongoDB source endpoint.
    authSource string
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    authType string
    The authentication type you use to access the MongoDB source endpoint.
    databaseName string
    The database name on the MongoDB source endpoint.
    docsToInvestigate string
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId string
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    nestingLevel string
    Specifies either document or table mode.
    password string
    The password for the user account you use to access the MongoDB source endpoint.
    port number
    The port value for the MongoDB source endpoint.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    serverName string
    The name of the server on the MongoDB source endpoint.
    username string
    The user name you use to access the MongoDB source endpoint.
    auth_mechanism str
    The authentication mechanism you use to access the MongoDB source endpoint.
    auth_source str
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    auth_type str
    The authentication type you use to access the MongoDB source endpoint.
    database_name str
    The database name on the MongoDB source endpoint.
    docs_to_investigate str
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extract_doc_id str
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    nesting_level str
    Specifies either document or table mode.
    password str
    The password for the user account you use to access the MongoDB source endpoint.
    port int
    The port value for the MongoDB source endpoint.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    server_name str
    The name of the server on the MongoDB source endpoint.
    username str
    The user name you use to access the MongoDB source endpoint.
    authMechanism String
    The authentication mechanism you use to access the MongoDB source endpoint.
    authSource String
    The MongoDB database name. This setting isn't used when AuthType is set to "no".
    authType String
    The authentication type you use to access the MongoDB source endpoint.
    databaseName String
    The database name on the MongoDB source endpoint.
    docsToInvestigate String
    Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to "one".
    extractDocId String
    Specifies the document ID. Use this setting when NestingLevel is set to "none".
    nestingLevel String
    Specifies either document or table mode.
    password String
    The password for the user account you use to access the MongoDB source endpoint.
    port Number
    The port value for the MongoDB source endpoint.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
    serverName String
    The name of the server on the MongoDB source endpoint.
    username String
    The user name you use to access the MongoDB source endpoint.

    EndpointMySqlSettings

    AfterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    CleanSourceMetadataOnMismatch bool
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    EventsPollInterval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    ParallelLoadThreads int
    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.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    ServerTimezone string
    Specifies the time zone for the source MySQL database.
    TargetDbType string
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    AfterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    CleanSourceMetadataOnMismatch bool
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    EventsPollInterval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    ParallelLoadThreads int
    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.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    ServerTimezone string
    Specifies the time zone for the source MySQL database.
    TargetDbType string
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    after_connect_script string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    clean_source_metadata_on_mismatch bool
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    events_poll_interval number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    max_file_size number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallel_load_threads number
    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.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    server_timezone string
    Specifies the time zone for the source MySQL database.
    target_db_type string
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    afterConnectScript String
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch Boolean
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    eventsPollInterval Integer
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize Integer
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads Integer
    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.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverTimezone String
    Specifies the time zone for the source MySQL database.
    targetDbType String
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    afterConnectScript string
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch boolean
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    eventsPollInterval number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads number
    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.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverTimezone string
    Specifies the time zone for the source MySQL database.
    targetDbType string
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    after_connect_script str
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    clean_source_metadata_on_mismatch bool
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    events_poll_interval int
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    max_file_size int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallel_load_threads int
    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.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    server_timezone str
    Specifies the time zone for the source MySQL database.
    target_db_type str
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.
    afterConnectScript String
    Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.
    cleanSourceMetadataOnMismatch Boolean
    Cleans and recreates table metadata information on the replication instance when a mismatch occurs.
    eventsPollInterval Number
    Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.
    maxFileSize Number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
    parallelLoadThreads Number
    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.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
    serverTimezone String
    Specifies the time zone for the source MySQL database.
    targetDbType String
    Specifies where to migrate source tables on the target, either to a single database or multiple databases.

    EndpointNeptuneSettings

    ErrorRetryDuration int
    The number of milliseconds for AWS 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.
    IamAuthEnabled bool
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    MaxFileSize int
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    MaxRetryCount int
    The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
    S3BucketFolder string
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    S3BucketName string
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    ServiceAccessRoleArn string
    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.
    ErrorRetryDuration int
    The number of milliseconds for AWS 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.
    IamAuthEnabled bool
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    MaxFileSize int
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    MaxRetryCount int
    The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
    S3BucketFolder string
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    S3BucketName string
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    ServiceAccessRoleArn string
    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.
    error_retry_duration number
    The number of milliseconds for AWS 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 bool
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    max_file_size number
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    max_retry_count number
    The number of times for AWS 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 string
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    s3_bucket_name string
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    service_access_role_arn string
    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.
    errorRetryDuration Integer
    The number of milliseconds for AWS 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.
    iamAuthEnabled Boolean
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    maxFileSize Integer
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    maxRetryCount Integer
    The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
    s3BucketFolder String
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    s3BucketName String
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    serviceAccessRoleArn String
    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.
    errorRetryDuration number
    The number of milliseconds for AWS 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.
    iamAuthEnabled boolean
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    maxFileSize number
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    maxRetryCount number
    The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
    s3BucketFolder string
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    s3BucketName string
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    serviceAccessRoleArn string
    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.
    error_retry_duration int
    The number of milliseconds for AWS 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 bool
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    max_file_size int
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    max_retry_count int
    The number of times for AWS 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 str
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    s3_bucket_name str
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    service_access_role_arn str
    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.
    errorRetryDuration Number
    The number of milliseconds for AWS 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.
    iamAuthEnabled Boolean
    If you want IAM authorization enabled for this endpoint, set this parameter to true.
    maxFileSize Number
    The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database.
    maxRetryCount Number
    The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.
    s3BucketFolder String
    A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName
    s3BucketName String
    The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database.
    serviceAccessRoleArn String
    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.

    EndpointOracleSettings

    AccessAlternateDirectly bool
    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.
    AddSupplementalLogging bool
    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.
    AdditionalArchivedLogDestId int
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    AllowSelectNestedTables bool
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    ArchivedLogDestId int
    Specifies the ID of the destination for the archived redo logs.
    ArchivedLogsOnly bool
    When this field is set to True, AWS DMS only accesses the archived redo logs
    AsmPassword string
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    AsmServer string
    For an Oracle source endpoint, your ASM server address.
    AsmUser string
    For an Oracle source endpoint, your ASM user name.
    CharLengthSemantics string
    Specifies whether the length of a character column is in bytes or in characters.
    DirectPathNoLog bool
    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.
    DirectPathParallelLoad bool
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    EnableHomogenousTablespace bool
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    ExtraArchivedLogDestIds List<int>
    Specifies the IDs of one more destinations for one or more archived redo logs.
    FailTasksOnLobTruncation bool
    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.
    NumberDatatypeScale int
    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.
    OraclePathPrefix string
    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.
    ParallelAsmReadThreads int
    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).
    ReadAheadBlocks int
    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).
    ReadTableSpaceName bool
    When set to true, this attribute supports tablespace replication.
    ReplacePathPrefix bool
    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.
    RetryInterval int
    Specifies the number of seconds that the system waits before resending a query.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerOracleAsmAccessRoleArn string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    SecretsManagerOracleAsmSecretId string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    SecurityDbEncryption string
    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.
    SecurityDbEncryptionName string
    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.
    SpatialDataOptionToGeoJsonFunctionName string
    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.
    StandbyDelayTime int
    Use this attribute to specify a time in minutes for the delay in standby sync.
    UseAlternateFolderForOnline bool
    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
    UseBFile bool
    Set this attribute to True to capture change data using the Binary Reader utility.
    UseDirectPathFullLoad bool
    Set this attribute to True to have AWS DMS use a direct path full load.
    UseLogminerReader bool
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    UsePathPrefix string
    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.
    AccessAlternateDirectly bool
    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.
    AddSupplementalLogging bool
    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.
    AdditionalArchivedLogDestId int
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    AllowSelectNestedTables bool
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    ArchivedLogDestId int
    Specifies the ID of the destination for the archived redo logs.
    ArchivedLogsOnly bool
    When this field is set to True, AWS DMS only accesses the archived redo logs
    AsmPassword string
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    AsmServer string
    For an Oracle source endpoint, your ASM server address.
    AsmUser string
    For an Oracle source endpoint, your ASM user name.
    CharLengthSemantics string
    Specifies whether the length of a character column is in bytes or in characters.
    DirectPathNoLog bool
    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.
    DirectPathParallelLoad bool
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    EnableHomogenousTablespace bool
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    ExtraArchivedLogDestIds []int
    Specifies the IDs of one more destinations for one or more archived redo logs.
    FailTasksOnLobTruncation bool
    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.
    NumberDatatypeScale int
    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.
    OraclePathPrefix string
    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.
    ParallelAsmReadThreads int
    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).
    ReadAheadBlocks int
    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).
    ReadTableSpaceName bool
    When set to true, this attribute supports tablespace replication.
    ReplacePathPrefix bool
    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.
    RetryInterval int
    Specifies the number of seconds that the system waits before resending a query.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerOracleAsmAccessRoleArn string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    SecretsManagerOracleAsmSecretId string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    SecurityDbEncryption string
    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.
    SecurityDbEncryptionName string
    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.
    SpatialDataOptionToGeoJsonFunctionName string
    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.
    StandbyDelayTime int
    Use this attribute to specify a time in minutes for the delay in standby sync.
    UseAlternateFolderForOnline bool
    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
    UseBFile bool
    Set this attribute to True to capture change data using the Binary Reader utility.
    UseDirectPathFullLoad bool
    Set this attribute to True to have AWS DMS use a direct path full load.
    UseLogminerReader bool
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    UsePathPrefix string
    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.
    access_alternate_directly bool
    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.
    add_supplemental_logging bool
    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.
    additional_archived_log_dest_id number
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    allow_select_nested_tables bool
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    archived_log_dest_id number
    Specifies the ID of the destination for the archived redo logs.
    archived_logs_only bool
    When this field is set to True, AWS DMS only accesses the archived redo logs
    asm_password string
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    asm_server string
    For an Oracle source endpoint, your ASM server address.
    asm_user string
    For an Oracle source endpoint, your ASM user name.
    char_length_semantics string
    Specifies whether the length of a character column is in bytes or in characters.
    direct_path_no_log bool
    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 bool
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    enable_homogenous_tablespace bool
    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 list(number)
    Specifies the IDs of one more destinations for one or more archived redo logs.
    fail_tasks_on_lob_truncation bool
    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.
    number_datatype_scale number
    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.
    oracle_path_prefix string
    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.
    parallel_asm_read_threads number
    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).
    read_ahead_blocks number
    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).
    read_table_space_name bool
    When set to true, this attribute supports tablespace replication.
    replace_path_prefix bool
    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.
    retry_interval number
    Specifies the number of seconds that the system waits before resending a query.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_oracle_asm_access_role_arn string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secrets_manager_oracle_asm_secret_id string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    security_db_encryption string
    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.
    security_db_encryption_name string
    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.
    spatial_data_option_to_geo_json_function_name string
    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 number
    Use this attribute to specify a time in minutes for the delay in standby sync.
    use_alternate_folder_for_online bool
    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
    use_b_file bool
    Set this attribute to True to capture change data using the Binary Reader utility.
    use_direct_path_full_load bool
    Set this attribute to True to have AWS DMS use a direct path full load.
    use_logminer_reader bool
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    use_path_prefix string
    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.
    accessAlternateDirectly Boolean
    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.
    addSupplementalLogging Boolean
    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.
    additionalArchivedLogDestId Integer
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    allowSelectNestedTables Boolean
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    archivedLogDestId Integer
    Specifies the ID of the destination for the archived redo logs.
    archivedLogsOnly Boolean
    When this field is set to True, AWS DMS only accesses the archived redo logs
    asmPassword String
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    asmServer String
    For an Oracle source endpoint, your ASM server address.
    asmUser String
    For an Oracle source endpoint, your ASM user name.
    charLengthSemantics String
    Specifies whether the length of a character column is in bytes or in characters.
    directPathNoLog Boolean
    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.
    directPathParallelLoad Boolean
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    enableHomogenousTablespace Boolean
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    extraArchivedLogDestIds List<Integer>
    Specifies the IDs of one more destinations for one or more archived redo logs.
    failTasksOnLobTruncation Boolean
    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.
    numberDatatypeScale Integer
    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.
    oraclePathPrefix String
    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.
    parallelAsmReadThreads Integer
    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).
    readAheadBlocks Integer
    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).
    readTableSpaceName Boolean
    When set to true, this attribute supports tablespace replication.
    replacePathPrefix Boolean
    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.
    retryInterval Integer
    Specifies the number of seconds that the system waits before resending a query.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerOracleAsmAccessRoleArn String
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerOracleAsmSecretId String
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    securityDbEncryption String
    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.
    securityDbEncryptionName String
    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.
    spatialDataOptionToGeoJsonFunctionName String
    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.
    standbyDelayTime Integer
    Use this attribute to specify a time in minutes for the delay in standby sync.
    useAlternateFolderForOnline Boolean
    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
    useBFile Boolean
    Set this attribute to True to capture change data using the Binary Reader utility.
    useDirectPathFullLoad Boolean
    Set this attribute to True to have AWS DMS use a direct path full load.
    useLogminerReader Boolean
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    usePathPrefix String
    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.
    accessAlternateDirectly boolean
    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.
    addSupplementalLogging boolean
    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.
    additionalArchivedLogDestId number
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    allowSelectNestedTables boolean
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    archivedLogDestId number
    Specifies the ID of the destination for the archived redo logs.
    archivedLogsOnly boolean
    When this field is set to True, AWS DMS only accesses the archived redo logs
    asmPassword string
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    asmServer string
    For an Oracle source endpoint, your ASM server address.
    asmUser string
    For an Oracle source endpoint, your ASM user name.
    charLengthSemantics string
    Specifies whether the length of a character column is in bytes or in characters.
    directPathNoLog boolean
    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.
    directPathParallelLoad boolean
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    enableHomogenousTablespace boolean
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    extraArchivedLogDestIds number[]
    Specifies the IDs of one more destinations for one or more archived redo logs.
    failTasksOnLobTruncation boolean
    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.
    numberDatatypeScale number
    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.
    oraclePathPrefix string
    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.
    parallelAsmReadThreads number
    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).
    readAheadBlocks number
    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).
    readTableSpaceName boolean
    When set to true, this attribute supports tablespace replication.
    replacePathPrefix boolean
    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.
    retryInterval number
    Specifies the number of seconds that the system waits before resending a query.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerOracleAsmAccessRoleArn string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerOracleAsmSecretId string
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    securityDbEncryption string
    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.
    securityDbEncryptionName string
    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.
    spatialDataOptionToGeoJsonFunctionName string
    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.
    standbyDelayTime number
    Use this attribute to specify a time in minutes for the delay in standby sync.
    useAlternateFolderForOnline boolean
    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
    useBFile boolean
    Set this attribute to True to capture change data using the Binary Reader utility.
    useDirectPathFullLoad boolean
    Set this attribute to True to have AWS DMS use a direct path full load.
    useLogminerReader boolean
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    usePathPrefix string
    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.
    access_alternate_directly bool
    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.
    add_supplemental_logging bool
    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.
    additional_archived_log_dest_id int
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    allow_select_nested_tables bool
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    archived_log_dest_id int
    Specifies the ID of the destination for the archived redo logs.
    archived_logs_only bool
    When this field is set to True, AWS DMS only accesses the archived redo logs
    asm_password str
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    asm_server str
    For an Oracle source endpoint, your ASM server address.
    asm_user str
    For an Oracle source endpoint, your ASM user name.
    char_length_semantics str
    Specifies whether the length of a character column is in bytes or in characters.
    direct_path_no_log bool
    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 bool
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    enable_homogenous_tablespace bool
    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 Sequence[int]
    Specifies the IDs of one more destinations for one or more archived redo logs.
    fail_tasks_on_lob_truncation bool
    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.
    number_datatype_scale int
    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.
    oracle_path_prefix str
    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.
    parallel_asm_read_threads int
    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).
    read_ahead_blocks int
    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).
    read_table_space_name bool
    When set to true, this attribute supports tablespace replication.
    replace_path_prefix bool
    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.
    retry_interval int
    Specifies the number of seconds that the system waits before resending a query.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_oracle_asm_access_role_arn str
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secrets_manager_oracle_asm_secret_id str
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    security_db_encryption str
    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.
    security_db_encryption_name str
    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.
    spatial_data_option_to_geo_json_function_name str
    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 int
    Use this attribute to specify a time in minutes for the delay in standby sync.
    use_alternate_folder_for_online bool
    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
    use_b_file bool
    Set this attribute to True to capture change data using the Binary Reader utility.
    use_direct_path_full_load bool
    Set this attribute to True to have AWS DMS use a direct path full load.
    use_logminer_reader bool
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    use_path_prefix str
    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.
    accessAlternateDirectly Boolean
    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.
    addSupplementalLogging Boolean
    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.
    additionalArchivedLogDestId Number
    Set this attribute with ArchivedLogDestId in a primary/ standby setup
    allowSelectNestedTables Boolean
    Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
    archivedLogDestId Number
    Specifies the ID of the destination for the archived redo logs.
    archivedLogsOnly Boolean
    When this field is set to True, AWS DMS only accesses the archived redo logs
    asmPassword String
    For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
    asmServer String
    For an Oracle source endpoint, your ASM server address.
    asmUser String
    For an Oracle source endpoint, your ASM user name.
    charLengthSemantics String
    Specifies whether the length of a character column is in bytes or in characters.
    directPathNoLog Boolean
    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.
    directPathParallelLoad Boolean
    When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
    enableHomogenousTablespace Boolean
    Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
    extraArchivedLogDestIds List<Number>
    Specifies the IDs of one more destinations for one or more archived redo logs.
    failTasksOnLobTruncation Boolean
    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.
    numberDatatypeScale Number
    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.
    oraclePathPrefix String
    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.
    parallelAsmReadThreads Number
    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).
    readAheadBlocks Number
    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).
    readTableSpaceName Boolean
    When set to true, this attribute supports tablespace replication.
    replacePathPrefix Boolean
    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.
    retryInterval Number
    Specifies the number of seconds that the system waits before resending a query.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerOracleAsmAccessRoleArn String
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerOracleAsmSecretId String
    Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
    securityDbEncryption String
    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.
    securityDbEncryptionName String
    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.
    spatialDataOptionToGeoJsonFunctionName String
    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.
    standbyDelayTime Number
    Use this attribute to specify a time in minutes for the delay in standby sync.
    useAlternateFolderForOnline Boolean
    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
    useBFile Boolean
    Set this attribute to True to capture change data using the Binary Reader utility.
    useDirectPathFullLoad Boolean
    Set this attribute to True to have AWS DMS use a direct path full load.
    useLogminerReader Boolean
    Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).
    usePathPrefix String
    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.

    EndpointPostgreSqlSettings

    AfterConnectScript string
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    BabelfishDatabaseName string
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    CaptureDdls bool
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    DatabaseMode string
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    DdlArtifactsSchema string
    The schema in which the operational DDL database artifacts are created.
    ExecuteTimeout int
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    FailTasksOnLobTruncation bool
    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.
    HeartbeatEnable bool
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    HeartbeatFrequency int
    Sets the WAL heartbeat frequency (in minutes).
    HeartbeatSchema string
    Sets the schema in which the heartbeat artifacts are created.
    MapBooleanAsBoolean bool
    When true, lets PostgreSQL migrate the boolean type as boolean.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    PluginName string
    Specifies the plugin to use to create a replication slot.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    SlotName string
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    AfterConnectScript string
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    BabelfishDatabaseName string
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    CaptureDdls bool
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    DatabaseMode string
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    DdlArtifactsSchema string
    The schema in which the operational DDL database artifacts are created.
    ExecuteTimeout int
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    FailTasksOnLobTruncation bool
    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.
    HeartbeatEnable bool
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    HeartbeatFrequency int
    Sets the WAL heartbeat frequency (in minutes).
    HeartbeatSchema string
    Sets the schema in which the heartbeat artifacts are created.
    MapBooleanAsBoolean bool
    When true, lets PostgreSQL migrate the boolean type as boolean.
    MaxFileSize int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    PluginName string
    Specifies the plugin to use to create a replication slot.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    SlotName string
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    after_connect_script string
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    babelfish_database_name string
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    capture_ddls bool
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    database_mode string
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    ddl_artifacts_schema string
    The schema in which the operational DDL database artifacts are created.
    execute_timeout number
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    fail_tasks_on_lob_truncation bool
    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.
    heartbeat_enable bool
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    heartbeat_frequency number
    Sets the WAL heartbeat frequency (in minutes).
    heartbeat_schema string
    Sets the schema in which the heartbeat artifacts are created.
    map_boolean_as_boolean bool
    When true, lets PostgreSQL migrate the boolean type as boolean.
    max_file_size number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    plugin_name string
    Specifies the plugin to use to create a replication slot.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    slot_name string
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    afterConnectScript String
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    babelfishDatabaseName String
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    captureDdls Boolean
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    databaseMode String
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    ddlArtifactsSchema String
    The schema in which the operational DDL database artifacts are created.
    executeTimeout Integer
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    failTasksOnLobTruncation Boolean
    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.
    heartbeatEnable Boolean
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    heartbeatFrequency Integer
    Sets the WAL heartbeat frequency (in minutes).
    heartbeatSchema String
    Sets the schema in which the heartbeat artifacts are created.
    mapBooleanAsBoolean Boolean
    When true, lets PostgreSQL migrate the boolean type as boolean.
    maxFileSize Integer
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    pluginName String
    Specifies the plugin to use to create a replication slot.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    slotName String
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    afterConnectScript string
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    babelfishDatabaseName string
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    captureDdls boolean
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    databaseMode string
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    ddlArtifactsSchema string
    The schema in which the operational DDL database artifacts are created.
    executeTimeout number
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    failTasksOnLobTruncation boolean
    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.
    heartbeatEnable boolean
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    heartbeatFrequency number
    Sets the WAL heartbeat frequency (in minutes).
    heartbeatSchema string
    Sets the schema in which the heartbeat artifacts are created.
    mapBooleanAsBoolean boolean
    When true, lets PostgreSQL migrate the boolean type as boolean.
    maxFileSize number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    pluginName string
    Specifies the plugin to use to create a replication slot.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    slotName string
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    after_connect_script str
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    babelfish_database_name str
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    capture_ddls bool
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    database_mode str
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    ddl_artifacts_schema str
    The schema in which the operational DDL database artifacts are created.
    execute_timeout int
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    fail_tasks_on_lob_truncation bool
    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.
    heartbeat_enable bool
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    heartbeat_frequency int
    Sets the WAL heartbeat frequency (in minutes).
    heartbeat_schema str
    Sets the schema in which the heartbeat artifacts are created.
    map_boolean_as_boolean bool
    When true, lets PostgreSQL migrate the boolean type as boolean.
    max_file_size int
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    plugin_name str
    Specifies the plugin to use to create a replication slot.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    slot_name str
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
    afterConnectScript String
    For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.
    babelfishDatabaseName String
    The Babelfish for Aurora PostgreSQL database name for the endpoint.
    captureDdls Boolean
    To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.
    databaseMode String
    Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
    ddlArtifactsSchema String
    The schema in which the operational DDL database artifacts are created.
    executeTimeout Number
    Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
    failTasksOnLobTruncation Boolean
    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.
    heartbeatEnable Boolean
    The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
    heartbeatFrequency Number
    Sets the WAL heartbeat frequency (in minutes).
    heartbeatSchema String
    Sets the schema in which the heartbeat artifacts are created.
    mapBooleanAsBoolean Boolean
    When true, lets PostgreSQL migrate the boolean type as boolean.
    maxFileSize Number
    Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
    pluginName String
    Specifies the plugin to use to create a replication slot.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
    slotName String
    Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.

    EndpointRedisSettings

    AuthPassword string
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    AuthType string
    The type of authentication to perform when connecting to a Redis target.
    AuthUserName string
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    Port double
    Transmission Control Protocol (TCP) port for the endpoint.
    ServerName string
    Fully qualified domain name of the endpoint.
    SslCaCertificateArn string
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    SslSecurityProtocol string
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    AuthPassword string
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    AuthType string
    The type of authentication to perform when connecting to a Redis target.
    AuthUserName string
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    Port float64
    Transmission Control Protocol (TCP) port for the endpoint.
    ServerName string
    Fully qualified domain name of the endpoint.
    SslCaCertificateArn string
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    SslSecurityProtocol string
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    auth_password string
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    auth_type string
    The type of authentication to perform when connecting to a Redis target.
    auth_user_name string
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    port number
    Transmission Control Protocol (TCP) port for the endpoint.
    server_name string
    Fully qualified domain name of the endpoint.
    ssl_ca_certificate_arn string
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    ssl_security_protocol string
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    authPassword String
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    authType String
    The type of authentication to perform when connecting to a Redis target.
    authUserName String
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    port Double
    Transmission Control Protocol (TCP) port for the endpoint.
    serverName String
    Fully qualified domain name of the endpoint.
    sslCaCertificateArn String
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    sslSecurityProtocol String
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    authPassword string
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    authType string
    The type of authentication to perform when connecting to a Redis target.
    authUserName string
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    port number
    Transmission Control Protocol (TCP) port for the endpoint.
    serverName string
    Fully qualified domain name of the endpoint.
    sslCaCertificateArn string
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    sslSecurityProtocol string
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    auth_password str
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    auth_type str
    The type of authentication to perform when connecting to a Redis target.
    auth_user_name str
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    port float
    Transmission Control Protocol (TCP) port for the endpoint.
    server_name str
    Fully qualified domain name of the endpoint.
    ssl_ca_certificate_arn str
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    ssl_security_protocol str
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.
    authPassword String
    The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.
    authType String
    The type of authentication to perform when connecting to a Redis target.
    authUserName String
    The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.
    port Number
    Transmission Control Protocol (TCP) port for the endpoint.
    serverName String
    Fully qualified domain name of the endpoint.
    sslCaCertificateArn String
    The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
    sslSecurityProtocol String
    The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption.

    EndpointRedshiftSettings

    AcceptAnyDate bool
    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).
    AfterConnectScript string
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    BucketFolder string
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    BucketName string
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    CaseSensitiveNames bool
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    CompUpdate bool
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    ConnectionTimeout int
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    DateFormat string
    The date format that you are using.
    EmptyAsNull bool
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    EncryptionMode string
    The type of server-side encryption that you want to use for your data.
    ExplicitIds bool
    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.
    FileTransferUploadStreams int
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    LoadTimeout int
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    MapBooleanAsBoolean bool
    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.
    MaxFileSize int
    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).
    RemoveQuotes bool
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    ReplaceChars string
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    ReplaceInvalidChars string
    A list of characters that you want to replace. Use with ReplaceChars.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    ServerSideEncryptionKmsKeyId string
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    ServiceAccessRoleArn string
    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.
    TimeFormat string
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    TrimBlanks bool
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    TruncateColumns bool
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    WriteBufferSize int
    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).
    AcceptAnyDate bool
    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).
    AfterConnectScript string
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    BucketFolder string
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    BucketName string
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    CaseSensitiveNames bool
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    CompUpdate bool
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    ConnectionTimeout int
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    DateFormat string
    The date format that you are using.
    EmptyAsNull bool
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    EncryptionMode string
    The type of server-side encryption that you want to use for your data.
    ExplicitIds bool
    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.
    FileTransferUploadStreams int
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    LoadTimeout int
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    MapBooleanAsBoolean bool
    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.
    MaxFileSize int
    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).
    RemoveQuotes bool
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    ReplaceChars string
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    ReplaceInvalidChars string
    A list of characters that you want to replace. Use with ReplaceChars.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    ServerSideEncryptionKmsKeyId string
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    ServiceAccessRoleArn string
    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.
    TimeFormat string
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    TrimBlanks bool
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    TruncateColumns bool
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    WriteBufferSize int
    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).
    accept_any_date bool
    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).
    after_connect_script string
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    bucket_folder string
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    bucket_name string
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    case_sensitive_names bool
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    comp_update bool
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    connection_timeout number
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    date_format string
    The date format that you are using.
    empty_as_null bool
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    encryption_mode string
    The type of server-side encryption that you want to use for your data.
    explicit_ids bool
    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 number
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    load_timeout number
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    map_boolean_as_boolean bool
    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 number
    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).
    remove_quotes bool
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    replace_chars string
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    replace_invalid_chars string
    A list of characters that you want to replace. Use with ReplaceChars.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    server_side_encryption_kms_key_id string
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    service_access_role_arn string
    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 string
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    trim_blanks bool
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    truncate_columns bool
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    write_buffer_size number
    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).
    acceptAnyDate Boolean
    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).
    afterConnectScript String
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    bucketFolder String
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    bucketName String
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    caseSensitiveNames Boolean
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    compUpdate Boolean
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    connectionTimeout Integer
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    dateFormat String
    The date format that you are using.
    emptyAsNull Boolean
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    encryptionMode String
    The type of server-side encryption that you want to use for your data.
    explicitIds Boolean
    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.
    fileTransferUploadStreams Integer
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    loadTimeout Integer
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    mapBooleanAsBoolean Boolean
    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.
    maxFileSize Integer
    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).
    removeQuotes Boolean
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    replaceChars String
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    replaceInvalidChars String
    A list of characters that you want to replace. Use with ReplaceChars.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    serverSideEncryptionKmsKeyId String
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    serviceAccessRoleArn String
    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.
    timeFormat String
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    trimBlanks Boolean
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    truncateColumns Boolean
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    writeBufferSize Integer
    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).
    acceptAnyDate boolean
    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).
    afterConnectScript string
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    bucketFolder string
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    bucketName string
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    caseSensitiveNames boolean
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    compUpdate boolean
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    connectionTimeout number
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    dateFormat string
    The date format that you are using.
    emptyAsNull boolean
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    encryptionMode string
    The type of server-side encryption that you want to use for your data.
    explicitIds boolean
    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.
    fileTransferUploadStreams number
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    loadTimeout number
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    mapBooleanAsBoolean boolean
    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.
    maxFileSize number
    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).
    removeQuotes boolean
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    replaceChars string
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    replaceInvalidChars string
    A list of characters that you want to replace. Use with ReplaceChars.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    serverSideEncryptionKmsKeyId string
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    serviceAccessRoleArn string
    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.
    timeFormat string
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    trimBlanks boolean
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    truncateColumns boolean
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    writeBufferSize number
    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).
    accept_any_date bool
    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).
    after_connect_script str
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    bucket_folder str
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    bucket_name str
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    case_sensitive_names bool
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    comp_update bool
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    connection_timeout int
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    date_format str
    The date format that you are using.
    empty_as_null bool
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    encryption_mode str
    The type of server-side encryption that you want to use for your data.
    explicit_ids bool
    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 int
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    load_timeout int
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    map_boolean_as_boolean bool
    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 int
    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).
    remove_quotes bool
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    replace_chars str
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    replace_invalid_chars str
    A list of characters that you want to replace. Use with ReplaceChars.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    server_side_encryption_kms_key_id str
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    service_access_role_arn str
    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 str
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    trim_blanks bool
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    truncate_columns bool
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    write_buffer_size int
    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).
    acceptAnyDate Boolean
    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).
    afterConnectScript String
    Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
    bucketFolder String
    An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster.
    bucketName String
    The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
    caseSensitiveNames Boolean
    If Amazon Redshift is configured to support case sensitive schema names, set CaseSensitiveNames to true. The default is false.
    compUpdate Boolean
    If you set CompUpdate to true Amazon Redshift applies automatic compression if the table is empty.
    connectionTimeout Number
    A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    dateFormat String
    The date format that you are using.
    emptyAsNull Boolean
    A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.
    encryptionMode String
    The type of server-side encryption that you want to use for your data.
    explicitIds Boolean
    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.
    fileTransferUploadStreams Number
    The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.
    loadTimeout Number
    The amount of time to wait (in milliseconds) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
    mapBooleanAsBoolean Boolean
    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.
    maxFileSize Number
    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).
    removeQuotes Boolean
    A value that specifies to remove surrounding quotation marks from strings in the incoming data.
    replaceChars String
    A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is "?".
    replaceInvalidChars String
    A list of characters that you want to replace. Use with ReplaceChars.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret.
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.
    serverSideEncryptionKmsKeyId String
    The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID.
    serviceAccessRoleArn String
    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.
    timeFormat String
    The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'.
    trimBlanks Boolean
    A value that specifies to remove the trailing white space characters from a VARCHAR string.
    truncateColumns Boolean
    A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column.
    writeBufferSize Number
    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).

    EndpointS3Settings

    AddColumnName bool
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    AddTrailingPaddingCharacter bool
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    BucketFolder string
    An optional parameter to set a folder name in the S3 bucket.
    BucketName string
    The name of the S3 bucket.
    CannedAclForObjects string
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    CdcInsertsAndUpdates bool
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    CdcInsertsOnly bool
    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.
    CdcMaxBatchInterval int
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    CdcMinFileSize int
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    CdcPath string
    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.
    CompressionType string
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    CsvDelimiter string
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    CsvNoSupValue string
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    CsvNullValue string
    An optional parameter that specifies how AWS DMS treats null values.
    CsvRowDelimiter string
    The delimiter used to separate rows in the .csv file for both source and target.
    DataFormat string
    The format of the data that you want to use for output.
    DataPageSize int
    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.
    DatePartitionDelimiter string
    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
    DatePartitionEnabled bool
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    DatePartitionSequence string
    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.
    DatePartitionTimezone string
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    DictPageSizeLimit int
    The maximum size of an encoded dictionary page of a column
    EnableStatistics bool
    A value that enables statistics for Parquet pages and row groups.
    EncodingType string
    The type of encoding that you're using.
    EncryptionMode string
    The type of server-side encryption that you want to use for your data.
    ExpectedBucketOwner string
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    ExternalTableDefinition string
    The external table definition.
    GlueCatalogGeneration bool
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    IgnoreHeaderRows int
    When this value is set to 1, AWS 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.
    IncludeOpForFullLoad bool
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    MaxFileSize int
    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.
    ParquetTimestampInMillisecond bool
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    ParquetVersion string
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    PreserveTransactions bool
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    Rfc4180 bool
    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.
    RowGroupLength int
    The number of rows in a row group.
    ServerSideEncryptionKmsKeyId string
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
    ServiceAccessRoleArn string
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    TimestampColumnName string
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    UseCsvNoSupValue bool
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    UseTaskStartTimeForFullLoadTimestamp bool
    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
    AddColumnName bool
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    AddTrailingPaddingCharacter bool
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    BucketFolder string
    An optional parameter to set a folder name in the S3 bucket.
    BucketName string
    The name of the S3 bucket.
    CannedAclForObjects string
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    CdcInsertsAndUpdates bool
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    CdcInsertsOnly bool
    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.
    CdcMaxBatchInterval int
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    CdcMinFileSize int
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    CdcPath string
    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.
    CompressionType string
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    CsvDelimiter string
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    CsvNoSupValue string
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    CsvNullValue string
    An optional parameter that specifies how AWS DMS treats null values.
    CsvRowDelimiter string
    The delimiter used to separate rows in the .csv file for both source and target.
    DataFormat string
    The format of the data that you want to use for output.
    DataPageSize int
    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.
    DatePartitionDelimiter string
    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
    DatePartitionEnabled bool
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    DatePartitionSequence string
    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.
    DatePartitionTimezone string
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    DictPageSizeLimit int
    The maximum size of an encoded dictionary page of a column
    EnableStatistics bool
    A value that enables statistics for Parquet pages and row groups.
    EncodingType string
    The type of encoding that you're using.
    EncryptionMode string
    The type of server-side encryption that you want to use for your data.
    ExpectedBucketOwner string
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    ExternalTableDefinition string
    The external table definition.
    GlueCatalogGeneration bool
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    IgnoreHeaderRows int
    When this value is set to 1, AWS 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.
    IncludeOpForFullLoad bool
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    MaxFileSize int
    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.
    ParquetTimestampInMillisecond bool
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    ParquetVersion string
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    PreserveTransactions bool
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    Rfc4180 bool
    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.
    RowGroupLength int
    The number of rows in a row group.
    ServerSideEncryptionKmsKeyId string
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
    ServiceAccessRoleArn string
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    TimestampColumnName string
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    UseCsvNoSupValue bool
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    UseTaskStartTimeForFullLoadTimestamp bool
    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
    add_column_name bool
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    add_trailing_padding_character bool
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    bucket_folder string
    An optional parameter to set a folder name in the S3 bucket.
    bucket_name string
    The name of the S3 bucket.
    canned_acl_for_objects string
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    cdc_inserts_and_updates bool
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    cdc_inserts_only bool
    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.
    cdc_max_batch_interval number
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    cdc_min_file_size number
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    cdc_path string
    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.
    compression_type string
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    csv_delimiter string
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    csv_no_sup_value string
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    csv_null_value string
    An optional parameter that specifies how AWS DMS treats null values.
    csv_row_delimiter string
    The delimiter used to separate rows in the .csv file for both source and target.
    data_format string
    The format of the data that you want to use for output.
    data_page_size number
    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 string
    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 bool
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    date_partition_sequence string
    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 string
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    dict_page_size_limit number
    The maximum size of an encoded dictionary page of a column
    enable_statistics bool
    A value that enables statistics for Parquet pages and row groups.
    encoding_type string
    The type of encoding that you're using.
    encryption_mode string
    The type of server-side encryption that you want to use for your data.
    expected_bucket_owner string
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    external_table_definition string
    The external table definition.
    glue_catalog_generation bool
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    ignore_header_rows number
    When this value is set to 1, AWS 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.
    include_op_for_full_load bool
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    max_file_size number
    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.
    parquet_timestamp_in_millisecond bool
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    parquet_version string
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    preserve_transactions bool
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    rfc4180 bool
    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.
    row_group_length number
    The number of rows in a row group.
    server_side_encryption_kms_key_id string
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS 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 string
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    timestamp_column_name string
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    use_csv_no_sup_value bool
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    use_task_start_time_for_full_load_timestamp bool
    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
    addColumnName Boolean
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    addTrailingPaddingCharacter Boolean
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    bucketFolder String
    An optional parameter to set a folder name in the S3 bucket.
    bucketName String
    The name of the S3 bucket.
    cannedAclForObjects String
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    cdcInsertsAndUpdates Boolean
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    cdcInsertsOnly Boolean
    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.
    cdcMaxBatchInterval Integer
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    cdcMinFileSize Integer
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    cdcPath String
    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.
    compressionType String
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    csvDelimiter String
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    csvNoSupValue String
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    csvNullValue String
    An optional parameter that specifies how AWS DMS treats null values.
    csvRowDelimiter String
    The delimiter used to separate rows in the .csv file for both source and target.
    dataFormat String
    The format of the data that you want to use for output.
    dataPageSize Integer
    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.
    datePartitionDelimiter String
    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
    datePartitionEnabled Boolean
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    datePartitionSequence String
    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.
    datePartitionTimezone String
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    dictPageSizeLimit Integer
    The maximum size of an encoded dictionary page of a column
    enableStatistics Boolean
    A value that enables statistics for Parquet pages and row groups.
    encodingType String
    The type of encoding that you're using.
    encryptionMode String
    The type of server-side encryption that you want to use for your data.
    expectedBucketOwner String
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    externalTableDefinition String
    The external table definition.
    glueCatalogGeneration Boolean
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    ignoreHeaderRows Integer
    When this value is set to 1, AWS 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.
    includeOpForFullLoad Boolean
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    maxFileSize Integer
    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.
    parquetTimestampInMillisecond Boolean
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    parquetVersion String
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    preserveTransactions Boolean
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    rfc4180 Boolean
    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.
    rowGroupLength Integer
    The number of rows in a row group.
    serverSideEncryptionKmsKeyId String
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
    serviceAccessRoleArn String
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    timestampColumnName String
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    useCsvNoSupValue Boolean
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    useTaskStartTimeForFullLoadTimestamp Boolean
    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
    addColumnName boolean
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    addTrailingPaddingCharacter boolean
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    bucketFolder string
    An optional parameter to set a folder name in the S3 bucket.
    bucketName string
    The name of the S3 bucket.
    cannedAclForObjects string
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    cdcInsertsAndUpdates boolean
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    cdcInsertsOnly boolean
    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.
    cdcMaxBatchInterval number
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    cdcMinFileSize number
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    cdcPath string
    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.
    compressionType string
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    csvDelimiter string
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    csvNoSupValue string
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    csvNullValue string
    An optional parameter that specifies how AWS DMS treats null values.
    csvRowDelimiter string
    The delimiter used to separate rows in the .csv file for both source and target.
    dataFormat string
    The format of the data that you want to use for output.
    dataPageSize number
    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.
    datePartitionDelimiter string
    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
    datePartitionEnabled boolean
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    datePartitionSequence string
    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.
    datePartitionTimezone string
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    dictPageSizeLimit number
    The maximum size of an encoded dictionary page of a column
    enableStatistics boolean
    A value that enables statistics for Parquet pages and row groups.
    encodingType string
    The type of encoding that you're using.
    encryptionMode string
    The type of server-side encryption that you want to use for your data.
    expectedBucketOwner string
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    externalTableDefinition string
    The external table definition.
    glueCatalogGeneration boolean
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    ignoreHeaderRows number
    When this value is set to 1, AWS 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.
    includeOpForFullLoad boolean
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    maxFileSize number
    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.
    parquetTimestampInMillisecond boolean
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    parquetVersion string
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    preserveTransactions boolean
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    rfc4180 boolean
    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.
    rowGroupLength number
    The number of rows in a row group.
    serverSideEncryptionKmsKeyId string
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
    serviceAccessRoleArn string
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    timestampColumnName string
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    useCsvNoSupValue boolean
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    useTaskStartTimeForFullLoadTimestamp boolean
    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
    add_column_name bool
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    add_trailing_padding_character bool
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    bucket_folder str
    An optional parameter to set a folder name in the S3 bucket.
    bucket_name str
    The name of the S3 bucket.
    canned_acl_for_objects str
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    cdc_inserts_and_updates bool
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    cdc_inserts_only bool
    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.
    cdc_max_batch_interval int
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    cdc_min_file_size int
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    cdc_path str
    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.
    compression_type str
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    csv_delimiter str
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    csv_no_sup_value str
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    csv_null_value str
    An optional parameter that specifies how AWS DMS treats null values.
    csv_row_delimiter str
    The delimiter used to separate rows in the .csv file for both source and target.
    data_format str
    The format of the data that you want to use for output.
    data_page_size int
    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 str
    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 bool
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    date_partition_sequence str
    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 str
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    dict_page_size_limit int
    The maximum size of an encoded dictionary page of a column
    enable_statistics bool
    A value that enables statistics for Parquet pages and row groups.
    encoding_type str
    The type of encoding that you're using.
    encryption_mode str
    The type of server-side encryption that you want to use for your data.
    expected_bucket_owner str
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    external_table_definition str
    The external table definition.
    glue_catalog_generation bool
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    ignore_header_rows int
    When this value is set to 1, AWS 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.
    include_op_for_full_load bool
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    max_file_size int
    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.
    parquet_timestamp_in_millisecond bool
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    parquet_version str
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    preserve_transactions bool
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    rfc4180 bool
    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.
    row_group_length int
    The number of rows in a row group.
    server_side_encryption_kms_key_id str
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS 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 str
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    timestamp_column_name str
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    use_csv_no_sup_value bool
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    use_task_start_time_for_full_load_timestamp bool
    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
    addColumnName Boolean
    An optional parameter that, when set to true or y, you can use to add column name information to the .csv output file.
    addTrailingPaddingCharacter Boolean
    Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on string data. The default value is false.
    bucketFolder String
    An optional parameter to set a folder name in the S3 bucket.
    bucketName String
    The name of the S3 bucket.
    cannedAclForObjects String
    A value that enables AWS DMS to specify a predefined (canned) access control list (ACL) for objects created in an Amazon S3 bucket as .csv or .parquet files.
    cdcInsertsAndUpdates Boolean
    A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files.
    cdcInsertsOnly Boolean
    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.
    cdcMaxBatchInterval Number
    Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
    cdcMinFileSize Number
    Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
    cdcPath String
    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.
    compressionType String
    An optional parameter. When set to GZIP it enables the service to compress the target files.
    csvDelimiter String
    The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
    csvNoSupValue String
    This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format.
    csvNullValue String
    An optional parameter that specifies how AWS DMS treats null values.
    csvRowDelimiter String
    The delimiter used to separate rows in the .csv file for both source and target.
    dataFormat String
    The format of the data that you want to use for output.
    dataPageSize Number
    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.
    datePartitionDelimiter String
    Specifies a date separating delimiter to use during folder partitioning. The default value is SLASH. Use this parameter when DatePartitionedEnabled is set to true.
    datePartitionEnabled Boolean
    When set to true, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is false.
    datePartitionSequence String
    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.
    datePartitionTimezone String
    When creating an S3 target endpoint, set DatePartitionTimezone to convert the current UTC time into a specified time zone.
    dictPageSizeLimit Number
    The maximum size of an encoded dictionary page of a column
    enableStatistics Boolean
    A value that enables statistics for Parquet pages and row groups.
    encodingType String
    The type of encoding that you're using.
    encryptionMode String
    The type of server-side encryption that you want to use for your data.
    expectedBucketOwner String
    To specify a bucket owner and prevent sniping, you can use the ExpectedBucketOwner endpoint setting.
    externalTableDefinition String
    The external table definition.
    glueCatalogGeneration Boolean
    When true, allows AWS Glue to catalog your S3 bucket. Creating an AWS Glue catalog lets you use Athena to query your data.
    ignoreHeaderRows Number
    When this value is set to 1, AWS 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.
    includeOpForFullLoad Boolean
    A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.
    maxFileSize Number
    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.
    parquetTimestampInMillisecond Boolean
    A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.
    parquetVersion String
    The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.
    preserveTransactions Boolean
    If this setting is set to true, AWS DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by CdcPath.
    rfc4180 Boolean
    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.
    rowGroupLength Number
    The number of rows in a row group.
    serverSideEncryptionKmsKeyId String
    If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
    serviceAccessRoleArn String
    A required parameter that specifies the Amazon Resource Name (ARN) used by the service to access the IAM role.
    timestampColumnName String
    A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.
    useCsvNoSupValue Boolean
    This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If this setting is set to true for columns not included in the supplemental log, AWS DMS uses the value specified by CsvNoSupValue. If this setting isn't set or is set to false, AWS DMS uses the null value for these columns.
    useTaskStartTimeForFullLoadTimestamp Boolean
    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

    EndpointSybaseSettings

    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    SecretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    SecretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    secrets_manager_access_role_arn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    secretsManagerAccessRoleArn string
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId string
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    secrets_manager_access_role_arn str
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secrets_manager_secret_id str
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.
    secretsManagerAccessRoleArn String
    The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret
    secretsManagerSecretId String
    The full ARN, partial ARN, or display name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial