Skip to content

CreateEndpointMessage

Source code in docs_src/capo_database_migration_service/types/create_endpoint_message.py 
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
class CreateEndpointMessage(TypedDict, closed=True):
    endpoint_identifier: "capo_database_migration_service.types.string.String"
    """<p>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.</p>"""
    endpoint_type: "capo_database_migration_service.types.replication_endpoint_type_value.ReplicationEndpointTypeValue"
    """<p>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</p>"""
    engine_name: "capo_database_migration_service.types.string.String"
    """<p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"opensearch"</code>, <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"docdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, <code>"babelfish"</code>, <code>redshift-serverless</code>, <code>aurora-serverless</code>, <code>aurora-postgresql-serverless</code>, <code>gcp-mysql</code>, <code>azure-sql-managed-instance</code>, <code>redis</code>, <code>dms-transfer</code>.</p>"""
    username: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The user name to be used to log in to the endpoint database.</p>"""
    password: NotRequired[
        "capo_database_migration_service.types.secret_string.SecretString"
    ]
    """<p>The password to be used to log in to the endpoint database.</p>"""
    server_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name of the server where the endpoint database resides.</p>"""
    port: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The port used by the endpoint database.</p>"""
    database_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and <code>targetDbType</code>.</p>"""
    extra_connection_attributes: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html">Working with DMS Endpoints</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    kms_key_id: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>An KMS key identifier that is used to encrypt the connection parameters for the endpoint.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>"""
    tags: NotRequired["capo_database_migration_service.types.tag_list.TagList"]
    """<p>One or more tags to be assigned to the endpoint.</p>"""
    certificate_arn: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the certificate.</p>"""
    ssl_mode: NotRequired[
        "capo_database_migration_service.types.dms_ssl_mode_value.DmsSslModeValue"
    ]
    """<p>The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is <code>none</code> </p>"""
    service_access_role_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p> The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the <code>iam:PassRole</code> action.</p>"""
    external_table_definition: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The external table definition. </p>"""
    dynamo_db_settings: NotRequired[
        "capo_database_migration_service.types.dynamo_db_settings.DynamoDbSettings"
    ]
    """<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    s3_settings: NotRequired[
        "capo_database_migration_service.types.s3_settings.S3Settings"
    ]
    """<p>Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring">Extra Connection Attributes When Using Amazon S3 as a Target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    dms_transfer_settings: NotRequired[
        "capo_database_migration_service.types.dms_transfer_settings.DmsTransferSettings"
    ]
    """<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible settings include the following:</p> <ul> <li> <p> <code>ServiceAccessRoleArn</code> - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the <code>iam:PassRole</code> action.</p> </li> <li> <p> <code>BucketName</code> - The name of the S3 bucket to use.</p> </li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string,BucketName=string</code> </p> <p>JSON syntax for these settings is as follows: <code>{ "ServiceAccessRoleArn": "string", "BucketName": "string", } </code> </p>"""
    mongo_db_settings: NotRequired[
        "capo_database_migration_service.types.mongo_db_settings.MongoDbSettings"
    ]
    """<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration">Endpoint configuration settings when using MongoDB as a source for Database Migration Service</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    kinesis_settings: NotRequired[
        "capo_database_migration_service.types.kinesis_settings.KinesisSettings"
    ]
    """<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping">Using object mapping to migrate data to a Kinesis data stream</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    kafka_settings: NotRequired[
        "capo_database_migration_service.types.kafka_settings.KafkaSettings"
    ]
    """<p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping">Using object mapping to migrate data to a Kafka topic</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    elasticsearch_settings: NotRequired[
        "capo_database_migration_service.types.elasticsearch_settings.ElasticsearchSettings"
    ]
    """<p>Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration">Extra Connection Attributes When Using OpenSearch as a Target for DMS</a> in the <i>Database Migration Service User Guide</i>.</p>"""
    neptune_settings: NotRequired[
        "capo_database_migration_service.types.neptune_settings.NeptuneSettings"
    ]
    """<p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings">Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    redshift_settings: NotRequired[
        "capo_database_migration_service.types.redshift_settings.RedshiftSettings"
    ]
    postgre_sql_settings: NotRequired[
        "capo_database_migration_service.types.postgre_sql_settings.PostgreSQLSettings"
    ]
    """<p>Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra connection attributes when using PostgreSQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib"> Extra connection attributes when using PostgreSQL as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    my_sql_settings: NotRequired[
        "capo_database_migration_service.types.my_sql_settings.MySQLSettings"
    ]
    """<p>Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib">Extra connection attributes when using MySQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib">Extra connection attributes when using a MySQL-compatible database as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    oracle_settings: NotRequired[
        "capo_database_migration_service.types.oracle_settings.OracleSettings"
    ]
    """<p>Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib">Extra connection attributes when using Oracle as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib"> Extra connection attributes when using Oracle as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    sybase_settings: NotRequired[
        "capo_database_migration_service.types.sybase_settings.SybaseSettings"
    ]
    """<p>Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    microsoft_sql_server_settings: NotRequired[
        "capo_database_migration_service.types.microsoft_sql_server_settings.MicrosoftSQLServerSettings"
    ]
    """<p>Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib">Extra connection attributes when using SQL Server as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib"> Extra connection attributes when using SQL Server as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    ibm_db2_settings: NotRequired[
        "capo_database_migration_service.types.ibm_db2_settings.IBMDb2Settings"
    ]
    """<p>Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib">Extra connection attributes when using Db2 LUW as a source for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>"""
    resource_identifier: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.</p>"""
    doc_db_settings: NotRequired[
        "capo_database_migration_service.types.doc_db_settings.DocDbSettings"
    ]
    redis_settings: NotRequired[
        "capo_database_migration_service.types.redis_settings.RedisSettings"
    ]
    """<p>Settings in JSON format for the target Redis endpoint.</p>"""
    gcp_my_sql_settings: NotRequired[
        "capo_database_migration_service.types.gcp_my_sql_settings.GcpMySQLSettings"
    ]
    """<p>Settings in JSON format for the source GCP MySQL endpoint.</p>"""
    timestream_settings: NotRequired[
        "capo_database_migration_service.types.timestream_settings.TimestreamSettings"
    ]
    """<p>Settings in JSON format for the target Amazon Timestream endpoint.</p>"""

certificate_arn instance-attribute 

certificate_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the certificate.

database_name instance-attribute 

database_name: NotRequired[String]

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

dms_transfer_settings instance-attribute 

dms_transfer_settings: NotRequired[DmsTransferSettings]

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

Possible settings include the following:

  • ServiceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

  • BucketName - The name of the S3 bucket to use.

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

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", }

doc_db_settings instance-attribute 

doc_db_settings: NotRequired[DocDbSettings]

dynamo_db_settings instance-attribute 

dynamo_db_settings: NotRequired[DynamoDbSettings]

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

elasticsearch_settings instance-attribute 

elasticsearch_settings: NotRequired[ElasticsearchSettings]

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

endpoint_identifier instance-attribute 

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 instance-attribute 

endpoint_type: ReplicationEndpointTypeValue

The type of endpoint. Valid values are source and target.

engine_name instance-attribute 

engine_name: String

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", "babelfish", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.

external_table_definition instance-attribute 

external_table_definition: NotRequired[String]

The external table definition.

extra_connection_attributes instance-attribute 

extra_connection_attributes: NotRequired[String]

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

gcp_my_sql_settings instance-attribute 

gcp_my_sql_settings: NotRequired[GcpMySQLSettings]

Settings in JSON format for the source GCP MySQL endpoint.

ibm_db2_settings instance-attribute 

ibm_db2_settings: NotRequired[IBMDb2Settings]

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

kafka_settings instance-attribute 

kafka_settings: NotRequired[KafkaSettings]

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

kinesis_settings instance-attribute 

kinesis_settings: NotRequired[KinesisSettings]

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

kms_key_id instance-attribute 

kms_key_id: NotRequired[String]

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

microsoft_sql_server_settings instance-attribute 

microsoft_sql_server_settings: NotRequired[MicrosoftSQLServerSettings]

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

mongo_db_settings instance-attribute 

mongo_db_settings: NotRequired[MongoDbSettings]

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

my_sql_settings instance-attribute 

my_sql_settings: NotRequired[MySQLSettings]

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

neptune_settings instance-attribute 

neptune_settings: NotRequired[NeptuneSettings]

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

oracle_settings instance-attribute 

oracle_settings: NotRequired[OracleSettings]

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

password instance-attribute 

password: NotRequired[SecretString]

The password to be used to log in to the endpoint database.

port instance-attribute 

port: NotRequired[IntegerOptional]

The port used by the endpoint database.

postgre_sql_settings instance-attribute 

postgre_sql_settings: NotRequired[PostgreSQLSettings]

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

redis_settings instance-attribute 

redis_settings: NotRequired[RedisSettings]

Settings in JSON format for the target Redis endpoint.

redshift_settings instance-attribute 

redshift_settings: NotRequired[RedshiftSettings]

resource_identifier instance-attribute 

resource_identifier: NotRequired[String]

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

s3_settings instance-attribute 

s3_settings: NotRequired[S3Settings]

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

server_name instance-attribute 

server_name: NotRequired[String]

The name of the server where the endpoint database resides.

service_access_role_arn instance-attribute 

service_access_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

ssl_mode instance-attribute 

ssl_mode: NotRequired[DmsSslModeValue]

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

sybase_settings instance-attribute 

sybase_settings: NotRequired[SybaseSettings]

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

tags instance-attribute 

tags: NotRequired[TagList]

One or more tags to be assigned to the endpoint.

timestream_settings instance-attribute 

timestream_settings: NotRequired[TimestreamSettings]

Settings in JSON format for the target Amazon Timestream endpoint.

username instance-attribute 

username: NotRequired[String]

The user name to be used to log in to the endpoint database.