AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Database Migration Service ModifyDataProvider API operation.

Syntax

Edit-DMSDataProvider
-DataProviderIdentifier <String>
-OracleSettings_AsmServer <String>
-MongoDbSettings_AuthMechanism <AuthMechanismValue>
-MongoDbSettings_AuthSource <String>
-MongoDbSettings_AuthType <AuthTypeValue>
-DocDbSettings_CertificateArn <String>
-MariaDbSettings_CertificateArn <String>
-MicrosoftSqlServerSettings_CertificateArn <String>
-MongoDbSettings_CertificateArn <String>
-MySqlSettings_CertificateArn <String>
-OracleSettings_CertificateArn <String>
-PostgreSqlSettings_CertificateArn <String>
-DocDbSettings_DatabaseName <String>
-MicrosoftSqlServerSettings_DatabaseName <String>
-MongoDbSettings_DatabaseName <String>
-OracleSettings_DatabaseName <String>
-PostgreSqlSettings_DatabaseName <String>
-RedshiftSettings_DatabaseName <String>
-DataProviderName <String>
-Description <String>
-Engine <String>
-ExactSetting <Boolean>
-DocDbSettings_Port <Int32>
-MariaDbSettings_Port <Int32>
-MicrosoftSqlServerSettings_Port <Int32>
-MongoDbSettings_Port <Int32>
-MySqlSettings_Port <Int32>
-OracleSettings_Port <Int32>
-PostgreSqlSettings_Port <Int32>
-RedshiftSettings_Port <Int32>
-OracleSettings_SecretsManagerOracleAsmAccessRoleArn <String>
-OracleSettings_SecretsManagerOracleAsmSecretId <String>
-OracleSettings_SecretsManagerSecurityDbEncryptionAccessRoleArn <String>
-OracleSettings_SecretsManagerSecurityDbEncryptionSecretId <String>
-DocDbSettings_ServerName <String>
-MariaDbSettings_ServerName <String>
-MicrosoftSqlServerSettings_ServerName <String>
-MongoDbSettings_ServerName <String>
-MySqlSettings_ServerName <String>
-OracleSettings_ServerName <String>
-PostgreSqlSettings_ServerName <String>
-RedshiftSettings_ServerName <String>
-DocDbSettings_SslMode <DmsSslModeValue>
-MariaDbSettings_SslMode <DmsSslModeValue>
-MicrosoftSqlServerSettings_SslMode <DmsSslModeValue>
-MongoDbSettings_SslMode <DmsSslModeValue>
-MySqlSettings_SslMode <DmsSslModeValue>
-OracleSettings_SslMode <DmsSslModeValue>
-PostgreSqlSettings_SslMode <DmsSslModeValue>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDatabaseMigrationServiceConfig>

Description

Modifies the specified data provider using the provided settings. You must remove the data provider from all migration projects before you can modify it.

Parameters

-ClientConfig <AmazonDatabaseMigrationServiceConfig>
Amazon.PowerShell.Cmdlets.DMS.AmazonDatabaseMigrationServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataProviderIdentifier <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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DataProviderName <String>
The name of the data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A user-friendly description of the data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocDbSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_DocDbSettings_CertificateArn
-DocDbSettings_DatabaseName <String>
The database name on the DocumentDB data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_DocDbSettings_DatabaseName
-DocDbSettings_Port <Int32>
The port value for the DocumentDB data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_DocDbSettings_Port
-DocDbSettings_ServerName <String>
The name of the source DocumentDB server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_DocDbSettings_ServerName
-DocDbSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the DocumentDB data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_DocDbSettings_SslMode
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExactSetting <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExactSettings
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MariaDbSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MariaDbSettings_CertificateArn
-MariaDbSettings_Port <Int32>
The port value for the MariaDB data provider
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MariaDbSettings_Port
-MariaDbSettings_ServerName <String>
The name of the MariaDB server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MariaDbSettings_ServerName
-MariaDbSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the MariaDB data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MariaDbSettings_SslMode
-MicrosoftSqlServerSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MicrosoftSqlServerSettings_CertificateArn
-MicrosoftSqlServerSettings_DatabaseName <String>
The database name on the Microsoft SQL Server data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MicrosoftSqlServerSettings_DatabaseName
-MicrosoftSqlServerSettings_Port <Int32>
The port value for the Microsoft SQL Server data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MicrosoftSqlServerSettings_Port
-MicrosoftSqlServerSettings_ServerName <String>
The name of the Microsoft SQL Server server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MicrosoftSqlServerSettings_ServerName
-MicrosoftSqlServerSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the Microsoft SQL Server data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MicrosoftSqlServerSettings_SslMode
-MongoDbSettings_AuthMechanism <AuthMechanismValue>
The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or SCRAM_SHA_1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_AuthMechanism
-MongoDbSettings_AuthSource <String>
The MongoDB database name. This setting isn't used when AuthType is set to "no". The default is "admin".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_AuthSource
-MongoDbSettings_AuthType <AuthTypeValue>
The authentication type for the database connection. Valid values are PASSWORD or NO.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_AuthType
-MongoDbSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_CertificateArn
-MongoDbSettings_DatabaseName <String>
The database name on the MongoDB data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_DatabaseName
-MongoDbSettings_Port <Int32>
The port value for the MongoDB data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_Port
-MongoDbSettings_ServerName <String>
The name of the MongoDB server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_ServerName
-MongoDbSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the MongoDB data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MongoDbSettings_SslMode
-MySqlSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MySqlSettings_CertificateArn
-MySqlSettings_Port <Int32>
The port value for the MySQL data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MySqlSettings_Port
-MySqlSettings_ServerName <String>
The name of the MySQL server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MySqlSettings_ServerName
-MySqlSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the MySQL data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MySqlSettings_SslMode
-OracleSettings_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_AsmServer
-OracleSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_CertificateArn
-OracleSettings_DatabaseName <String>
The database name on the Oracle data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_DatabaseName
-OracleSettings_Port <Int32>
The port value for the Oracle data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_Port
-OracleSettings_SecretsManagerOracleAsmAccessRoleArn <String>
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_SecretsManagerOracleAsmAccessRoleArn
-OracleSettings_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_SecretsManagerOracleAsmSecretId
-OracleSettings_SecretsManagerSecurityDbEncryptionAccessRoleArn <String>
The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_SecretsManagerSecurityDbEncryptionAccessRoleArn
-OracleSettings_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_SecretsManagerSecurityDbEncryptionSecretId
-OracleSettings_ServerName <String>
The name of the Oracle server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_ServerName
-OracleSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the Oracle data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_OracleSettings_SslMode
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DataProviderIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DataProviderIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PostgreSqlSettings_CertificateArn <String>
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_PostgreSqlSettings_CertificateArn
-PostgreSqlSettings_DatabaseName <String>
The database name on the PostgreSQL data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_PostgreSqlSettings_DatabaseName
-PostgreSqlSettings_Port <Int32>
The port value for the PostgreSQL data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_PostgreSqlSettings_Port
-PostgreSqlSettings_ServerName <String>
The name of the PostgreSQL server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_PostgreSqlSettings_ServerName
-PostgreSqlSettings_SslMode <DmsSslModeValue>
The SSL mode used to connect to the PostgreSQL data provider. The default value is none.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_PostgreSqlSettings_SslMode
-RedshiftSettings_DatabaseName <String>
The database name on the Amazon Redshift data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_RedshiftSettings_DatabaseName
-RedshiftSettings_Port <Int32>
The port value for the Amazon Redshift data provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_RedshiftSettings_Port
-RedshiftSettings_ServerName <String>
The name of the Amazon Redshift server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_RedshiftSettings_ServerName
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DataProvider'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyDataProviderResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyDataProviderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.DatabaseMigrationService.Model.DataProvider or Amazon.DatabaseMigrationService.Model.ModifyDataProviderResponse
This cmdlet returns an Amazon.DatabaseMigrationService.Model.DataProvider object. The service call response (type Amazon.DatabaseMigrationService.Model.ModifyDataProviderResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Schema Conversion User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z