Endpoint ¶

class Endpoint(TypedDict, closed=True):
    endpoint_identifier: NotRequired[
        "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: NotRequired[
        "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: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The database engine name. Valid values, depending on the EndpointType, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"redshift"</code>, <code>"redshift-serverless"</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>"documentdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, and <code>"babelfish"</code>.</p>"""
    engine_display_name: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The expanded name for the engine name. For example, if the <code>EngineName</code> parameter is "aurora", this value would be "Amazon Aurora MySQL".</p>"""
    username: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The user name used to connect to the endpoint.</p>"""
    server_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name of the server at the endpoint.</p>"""
    port: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>The port value used to access the endpoint.</p>"""
    database_name: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The name of the database at the endpoint.</p>"""
    extra_connection_attributes: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>Additional connection attributes used to connect to the endpoint.</p>"""
    status: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The status of the endpoint.</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>"""
    endpoint_arn: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>"""
    certificate_arn: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The Amazon Resource Name (ARN) used for SSL connection to the endpoint.</p>"""
    ssl_mode: NotRequired[
        "capo_database_migration_service.types.dms_ssl_mode_value.DmsSslModeValue"
    ]
    """<p>The SSL mode used to connect to the endpoint. The default value is <code>none</code>.</p>"""
    service_access_role_arn: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The Amazon Resource Name (ARN) used by the service to access the IAM role. 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>"""
    external_id: NotRequired["capo_database_migration_service.types.string.String"]
    """<p> Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account. </p>"""
    is_read_only: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the endpoint is read-only. When set to <code>true</code>, this endpoint is managed by DMS as part of a zero-ETL integration and cannot be modified or deleted directly. You can only modify or delete read-only endpoints through their associated zero-ETL integration.</p>"""
    dynamo_db_settings: NotRequired[
        "capo_database_migration_service.types.dynamo_db_settings.DynamoDbSettings"
    ]
    """<p>The settings for the DynamoDB target endpoint. For more information, see the <code>DynamoDBSettings</code> structure.</p>"""
    s3_settings: NotRequired[
        "capo_database_migration_service.types.s3_settings.S3Settings"
    ]
    """<p>The settings for the S3 target endpoint. For more information, see the <code>S3Settings</code> structure.</p>"""
    dms_transfer_settings: NotRequired[
        "capo_database_migration_service.types.dms_transfer_settings.DmsTransferSettings"
    ]
    """<p>The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure. </p>"""
    mongo_db_settings: NotRequired[
        "capo_database_migration_service.types.mongo_db_settings.MongoDbSettings"
    ]
    """<p>The settings for the MongoDB source endpoint. For more information, see the <code>MongoDbSettings</code> structure.</p>"""
    kinesis_settings: NotRequired[
        "capo_database_migration_service.types.kinesis_settings.KinesisSettings"
    ]
    """<p>The settings for the Amazon Kinesis target endpoint. For more information, see the <code>KinesisSettings</code> structure.</p>"""
    kafka_settings: NotRequired[
        "capo_database_migration_service.types.kafka_settings.KafkaSettings"
    ]
    """<p>The settings for the Apache Kafka target endpoint. For more information, see the <code>KafkaSettings</code> structure.</p>"""
    elasticsearch_settings: NotRequired[
        "capo_database_migration_service.types.elasticsearch_settings.ElasticsearchSettings"
    ]
    """<p>The settings for the OpenSearch source endpoint. For more information, see the <code>ElasticsearchSettings</code> structure.</p>"""
    neptune_settings: NotRequired[
        "capo_database_migration_service.types.neptune_settings.NeptuneSettings"
    ]
    """<p>The settings for the Amazon Neptune target endpoint. For more information, see the <code>NeptuneSettings</code> structure.</p>"""
    redshift_settings: NotRequired[
        "capo_database_migration_service.types.redshift_settings.RedshiftSettings"
    ]
    """<p>Settings for the Amazon Redshift endpoint.</p>"""
    postgre_sql_settings: NotRequired[
        "capo_database_migration_service.types.postgre_sql_settings.PostgreSQLSettings"
    ]
    """<p>The settings for the PostgreSQL source and target endpoint. For more information, see the <code>PostgreSQLSettings</code> structure.</p>"""
    my_sql_settings: NotRequired[
        "capo_database_migration_service.types.my_sql_settings.MySQLSettings"
    ]
    """<p>The settings for the MySQL source and target endpoint. For more information, see the <code>MySQLSettings</code> structure.</p>"""
    oracle_settings: NotRequired[
        "capo_database_migration_service.types.oracle_settings.OracleSettings"
    ]
    """<p>The settings for the Oracle source and target endpoint. For more information, see the <code>OracleSettings</code> structure.</p>"""
    sybase_settings: NotRequired[
        "capo_database_migration_service.types.sybase_settings.SybaseSettings"
    ]
    """<p>The settings for the SAP ASE source and target endpoint. For more information, see the <code>SybaseSettings</code> structure.</p>"""
    microsoft_sql_server_settings: NotRequired[
        "capo_database_migration_service.types.microsoft_sql_server_settings.MicrosoftSQLServerSettings"
    ]
    """<p>The settings for the Microsoft SQL Server source and target endpoint. For more information, see the <code>MicrosoftSQLServerSettings</code> structure.</p>"""
    ibm_db2_settings: NotRequired[
        "capo_database_migration_service.types.ibm_db2_settings.IBMDb2Settings"
    ]
    """<p>The settings for the IBM Db2 LUW source endpoint. For more information, see the <code>IBMDb2Settings</code> structure. </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>The settings for the Redis target endpoint. For more information, see the <code>RedisSettings</code> structure.</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>The settings for the Amazon Timestream target endpoint. For more information, see the <code>TimestreamSettings</code> structure.</p>"""
    lakehouse_settings: NotRequired[
        "capo_database_migration_service.types.lakehouse_settings.LakehouseSettings"
    ]
    """<p>Settings in JSON format for the target Lakehouse endpoint. This parameter applies to endpoints that are automatically created by DMS for a Lakehouse data warehouse as part of a zero-ETL integration.</p>"""