DatabaseMigrationService / Client / modify_data_provider

modify_data_provider#

DatabaseMigrationService.Client.modify_data_provider(**kwargs)#

Modifies the specified data provider using the provided settings.

Note

You must remove the data provider from all migration projects before you can modify it.

Request Syntax

response = client.modify_data_provider(
    DataProviderIdentifier='string',
    DataProviderName='string',
    Description='string',
    Engine='string',
    ExactSettings=True|False,
    Settings={
        'RedshiftSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string'
        },
        'PostgreSqlSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string'
        },
        'MySqlSettings': {
            'ServerName': 'string',
            'Port': 123,
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string'
        },
        'OracleSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string',
            'AsmServer': 'string',
            'SecretsManagerOracleAsmSecretId': 'string',
            'SecretsManagerOracleAsmAccessRoleArn': 'string',
            'SecretsManagerSecurityDbEncryptionSecretId': 'string',
            'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
        },
        'MicrosoftSqlServerSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string'
        },
        'DocDbSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string'
        },
        'MariaDbSettings': {
            'ServerName': 'string',
            'Port': 123,
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string'
        },
        'MongoDbSettings': {
            'ServerName': 'string',
            'Port': 123,
            'DatabaseName': 'string',
            'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
            'CertificateArn': 'string',
            'AuthType': 'no'|'password',
            'AuthSource': 'string',
            'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1'
        }
    }
)

Parameters:

DataProviderIdentifier (string) –
[REQUIRED]

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.
DataProviderName (string) – The name of the data provider.
Description (string) – A user-friendly description of the data provider.
Engine (string) – The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, and docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
ExactSettings (boolean) –
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 (dict) –
The settings in JSON format for a data provider.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: RedshiftSettings, PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings, DocDbSettings, MariaDbSettings, MongoDbSettings.
- RedshiftSettings (dict) –
  
  Provides information that defines an Amazon Redshift data provider.
  - ServerName (string) –
    
    The name of the Amazon Redshift server.
  - Port (integer) –
    
    The port value for the Amazon Redshift data provider.
  - DatabaseName (string) –
    
    The database name on the Amazon Redshift data provider.
- PostgreSqlSettings (dict) –
  
  Provides information that defines a PostgreSQL data provider.
  - ServerName (string) –
    
    The name of the PostgreSQL server.
  - Port (integer) –
    
    The port value for the PostgreSQL data provider.
  - DatabaseName (string) –
    
    The database name on the PostgreSQL data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the PostgreSQL data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
- MySqlSettings (dict) –
  
  Provides information that defines a MySQL data provider.
  - ServerName (string) –
    
    The name of the MySQL server.
  - Port (integer) –
    
    The port value for the MySQL data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the MySQL data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
- OracleSettings (dict) –
  
  Provides information that defines an Oracle data provider.
  - ServerName (string) –
    
    The name of the Oracle server.
  - Port (integer) –
    
    The port value for the Oracle data provider.
  - DatabaseName (string) –
    
    The database name on the Oracle data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the Oracle data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
  - AsmServer (string) –
    
    The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
  - SecretsManagerOracleAsmSecretId (string) –
    
    The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
    
    Required only if your data provider uses the Oracle ASM server.
  - SecretsManagerOracleAsmAccessRoleArn (string) –
    
    The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
  - SecretsManagerSecurityDbEncryptionSecretId (string) –
    
    The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
  - SecretsManagerSecurityDbEncryptionAccessRoleArn (string) –
    
    The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
- MicrosoftSqlServerSettings (dict) –
  
  Provides information that defines a Microsoft SQL Server data provider.
  - ServerName (string) –
    
    The name of the Microsoft SQL Server server.
  - Port (integer) –
    
    The port value for the Microsoft SQL Server data provider.
  - DatabaseName (string) –
    
    The database name on the Microsoft SQL Server data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
- DocDbSettings (dict) –
  
  Provides information that defines a DocumentDB data provider.
  - ServerName (string) –
    
    The name of the source DocumentDB server.
  - Port (integer) –
    
    The port value for the DocumentDB data provider.
  - DatabaseName (string) –
    
    The database name on the DocumentDB data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the DocumentDB data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
- MariaDbSettings (dict) –
  
  Provides information that defines a MariaDB data provider.
  - ServerName (string) –
    
    The name of the MariaDB server.
  - Port (integer) –
    
    The port value for the MariaDB data provider
  - SslMode (string) –
    
    The SSL mode used to connect to the MariaDB data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
- MongoDbSettings (dict) –
  
  Provides information that defines a MongoDB data provider.
  - ServerName (string) –
    
    The name of the MongoDB server.
  - Port (integer) –
    
    The port value for the MongoDB data provider.
  - DatabaseName (string) –
    
    The database name on the MongoDB data provider.
  - SslMode (string) –
    
    The SSL mode used to connect to the MongoDB data provider. The default value is none.
  - CertificateArn (string) –
    
    The Amazon Resource Name (ARN) of the certificate used for SSL connection.
  - AuthType (string) –
    
    The authentication type for the database connection. Valid values are PASSWORD or NO.
  - AuthSource (string) –
    
    The MongoDB database name. This setting isn’t used when AuthType is set to "no".
    
    The default is "admin".
  - AuthMechanism (string) –
    
    The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

Return type:

dict

Returns:

Response Syntax

{
    'DataProvider': {
        'DataProviderName': 'string',
        'DataProviderArn': 'string',
        'DataProviderCreationTime': datetime(2015, 1, 1),
        'Description': 'string',
        'Engine': 'string',
        'Settings': {
            'RedshiftSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string'
            },
            'PostgreSqlSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string'
            },
            'MySqlSettings': {
                'ServerName': 'string',
                'Port': 123,
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string'
            },
            'OracleSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string',
                'AsmServer': 'string',
                'SecretsManagerOracleAsmSecretId': 'string',
                'SecretsManagerOracleAsmAccessRoleArn': 'string',
                'SecretsManagerSecurityDbEncryptionSecretId': 'string',
                'SecretsManagerSecurityDbEncryptionAccessRoleArn': 'string'
            },
            'MicrosoftSqlServerSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string'
            },
            'DocDbSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string'
            },
            'MariaDbSettings': {
                'ServerName': 'string',
                'Port': 123,
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string'
            },
            'MongoDbSettings': {
                'ServerName': 'string',
                'Port': 123,
                'DatabaseName': 'string',
                'SslMode': 'none'|'require'|'verify-ca'|'verify-full',
                'CertificateArn': 'string',
                'AuthType': 'no'|'password',
                'AuthSource': 'string',
                'AuthMechanism': 'default'|'mongodb_cr'|'scram_sha_1'
            }
        }
    }
}

Response Structure

(dict) –
- DataProvider (dict) –
  
  The data provider that was modified.
  - DataProviderName (string) –
    
    The name of the data provider.
  - DataProviderArn (string) –
    
    The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
  - DataProviderCreationTime (datetime) –
    
    The time the data provider was created.
  - Description (string) –
    
    A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
  - Engine (string) –
    
    The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, and docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
  - Settings (dict) –
    
    The settings in JSON format for a data provider.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: RedshiftSettings, PostgreSqlSettings, MySqlSettings, OracleSettings, MicrosoftSqlServerSettings, DocDbSettings, MariaDbSettings, MongoDbSettings. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - RedshiftSettings (dict) –
      
      Provides information that defines an Amazon Redshift data provider.
      - ServerName (string) –
        
        The name of the Amazon Redshift server.
      - Port (integer) –
        
        The port value for the Amazon Redshift data provider.
      - DatabaseName (string) –
        
        The database name on the Amazon Redshift data provider.
    - PostgreSqlSettings (dict) –
      
      Provides information that defines a PostgreSQL data provider.
      - ServerName (string) –
        
        The name of the PostgreSQL server.
      - Port (integer) –
        
        The port value for the PostgreSQL data provider.
      - DatabaseName (string) –
        
        The database name on the PostgreSQL data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the PostgreSQL data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    - MySqlSettings (dict) –
      
      Provides information that defines a MySQL data provider.
      - ServerName (string) –
        
        The name of the MySQL server.
      - Port (integer) –
        
        The port value for the MySQL data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the MySQL data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    - OracleSettings (dict) –
      
      Provides information that defines an Oracle data provider.
      - ServerName (string) –
        
        The name of the Oracle server.
      - Port (integer) –
        
        The port value for the Oracle data provider.
      - DatabaseName (string) –
        
        The database name on the Oracle data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the Oracle data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
      - AsmServer (string) –
        
        The address of your Oracle Automatic Storage Management (ASM) server. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
      - SecretsManagerOracleAsmSecretId (string) –
        
        The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
        
        Required only if your data provider uses the Oracle ASM server.
      - SecretsManagerOracleAsmAccessRoleArn (string) –
        
        The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
      - SecretsManagerSecurityDbEncryptionSecretId (string) –
        
        The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.
      - SecretsManagerSecurityDbEncryptionAccessRoleArn (string) –
        
        The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
    - MicrosoftSqlServerSettings (dict) –
      
      Provides information that defines a Microsoft SQL Server data provider.
      - ServerName (string) –
        
        The name of the Microsoft SQL Server server.
      - Port (integer) –
        
        The port value for the Microsoft SQL Server data provider.
      - DatabaseName (string) –
        
        The database name on the Microsoft SQL Server data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    - DocDbSettings (dict) –
      
      Provides information that defines a DocumentDB data provider.
      - ServerName (string) –
        
        The name of the source DocumentDB server.
      - Port (integer) –
        
        The port value for the DocumentDB data provider.
      - DatabaseName (string) –
        
        The database name on the DocumentDB data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the DocumentDB data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    - MariaDbSettings (dict) –
      
      Provides information that defines a MariaDB data provider.
      - ServerName (string) –
        
        The name of the MariaDB server.
      - Port (integer) –
        
        The port value for the MariaDB data provider
      - SslMode (string) –
        
        The SSL mode used to connect to the MariaDB data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
    - MongoDbSettings (dict) –
      
      Provides information that defines a MongoDB data provider.
      - ServerName (string) –
        
        The name of the MongoDB server.
      - Port (integer) –
        
        The port value for the MongoDB data provider.
      - DatabaseName (string) –
        
        The database name on the MongoDB data provider.
      - SslMode (string) –
        
        The SSL mode used to connect to the MongoDB data provider. The default value is none.
      - CertificateArn (string) –
        
        The Amazon Resource Name (ARN) of the certificate used for SSL connection.
      - AuthType (string) –
        
        The authentication type for the database connection. Valid values are PASSWORD or NO.
      - AuthSource (string) –
        
        The MongoDB database name. This setting isn’t used when AuthType is set to "no".
        
        The default is "admin".
      - AuthMechanism (string) –
        
        The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.

modify_data_provider#

Note

Request Syntax

Note

Response Syntax

Response Structure

Note

Exceptions