Skip to content

ModifyDataProviderMessage

Source code in docs_src/capo_database_migration_service/types/modify_data_provider_message.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ModifyDataProviderMessage(TypedDict, closed=True):
    data_provider_identifier: "capo_database_migration_service.types.string.String"
    """<p>The identifier of the data provider. 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>"""
    data_provider_name: NotRequired[
        "capo_database_migration_service.types.string.String"
    ]
    """<p>The name of the data provider.</p>"""
    description: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>A user-friendly description of the data provider.</p>"""
    engine: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>The type of database engine for the data provider.</p> <p>Valid values: <code>aurora</code>, <code>aurora-postgresql</code>, <code>db2</code>, <code>db2-zos</code>, <code>docdb</code>, <code>mariadb</code>, <code>mongodb</code>, <code>mysql</code>, <code>oracle</code>, <code>postgres</code>, <code>redshift</code>, <code>sqlserver</code>, and <code>sybase</code>. A value of <code>aurora</code> represents Amazon Aurora MySQL-Compatible Edition.</p>"""
    virtual: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the data provider is virtual.</p>"""
    exact_settings: NotRequired[
        "capo_database_migration_service.types.boolean_optional.BooleanOptional"
    ]
    """<p>If this attribute is Y, the current call to <code>ModifyDataProvider</code> replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to <code>ModifyDataProvider</code> does two things: </p> <ul> <li> <p>It replaces any data provider settings that already exist with new values, for settings with the same names.</p> </li> <li> <p>It creates new data provider settings that you specify in the call, for settings with different names. </p> </li> </ul>"""
    settings: NotRequired[
        "capo_database_migration_service.types.data_provider_settings.DataProviderSettings"
    ]
    """<p>The settings in JSON format for a data provider.</p>"""

data_provider_identifier instance-attribute 

data_provider_identifier: String

The identifier of the data provider. 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.

data_provider_name instance-attribute 

data_provider_name: NotRequired[String]

The name of the data provider.

description instance-attribute 

description: NotRequired[String]

A user-friendly description of the data provider.

engine instance-attribute 

engine: NotRequired[String]

The type of database engine for the data provider.

Valid values: aurora, aurora-postgresql, db2, db2-zos, docdb, mariadb, mongodb, mysql, oracle, postgres, redshift, sqlserver, and sybase. A value of aurora represents Amazon Aurora MySQL-Compatible Edition.

exact_settings instance-attribute 

exact_settings: NotRequired[BooleanOptional]

If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyDataProvider does two things:

  • It replaces any data provider settings that already exist with new values, for settings with the same names.

  • It creates new data provider settings that you specify in the call, for settings with different names.

settings instance-attribute 

settings: NotRequired[DataProviderSettings]

The settings in JSON format for a data provider.

virtual instance-attribute 

virtual: NotRequired[BooleanOptional]

Indicates whether the data provider is virtual.