AWS.Tools.DatabaseMigrationService.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DatabaseMigrationService</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet"> <summary> Applies a pending maintenance action to a resource (for example, to a replication instance). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.ApplyAction"> <summary> <para> <para>The pending maintenance action to apply to this resource.</para><para>Valid values: <code>os-upgrade</code>, <code>system-update</code>, <code>db-upgrade</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.OptInType"> <summary> <para> <para>A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type <code>immediate</code>.</para><para>Valid values:</para><ul><li><para><code>immediate</code> - Apply the maintenance action immediately.</para></li><li><para><code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource.</para></li><li><para><code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePendingMaintenanceActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ApplyPendingMaintenanceActionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ApplyPendingMaintenanceActionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.CompleteDMSPendingMaintenanceActionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet"> <summary> Modifies the specified endpoint. <note><para> For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on the <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_AcceptAnyDate"> <summary> <para> <para>A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose <code>true</code> or <code>false</code> (the default).</para><para>This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AccessAlternateDirectly"> <summary> <para> <para>Set this attribute to <code>false</code> in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_AddColumnName"> <summary> <para> <para>An optional parameter that, when set to <code>true</code> or <code>y</code>, you can use to add column name information to the .csv output file.</para><para>The default value is <code>false</code>. Valid values are <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AdditionalArchivedLogDestId"> <summary> <para> <para>Set this attribute with <code>ArchivedLogDestId</code> in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.</para><para>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless necessary. For additional information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B">RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AddSupplementalLogging"> <summary> <para> <para>Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.</para><para>If you use this option, you still need to enable database-level supplemental logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_AddTrailingPaddingCharacter"> <summary> <para> <para>Use the S3 target endpoint setting <code>AddTrailingPaddingCharacter</code> to add padding on string data. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_AfterConnectScript"> <summary> <para> <para>Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.</para><para>For this parameter, provide the code of the script itself, not the name of a file containing the script. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_AfterConnectScript"> <summary> <para> <para>Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.</para><para>For this parameter, provide the code of the script itself, not the name of a file containing the script.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_AfterConnectScript"> <summary> <para> <para>For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.</para><para>Example: <code>afterConnectScript=SET session_replication_role='replica'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_AfterConnectScript"> <summary> <para> <para>Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AllowSelectNestedTable"> <summary> <para> <para>Set this attribute to <code>true</code> to enable replication of Oracle tables containing columns that are nested tables or defined types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ArchivedLogDestId"> <summary> <para> <para>Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the <code>AdditionalArchivedLogDestId</code> option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ArchivedLogsOnly"> <summary> <para> <para>When this field is set to <code>Y</code>, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AsmPassword"> <summary> <para> <para>For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the <code><i>asm_user_password</i></code> value. You set this value as part of the comma-separated value that you set to the <code>Password</code> request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AsmServer"> <summary> <para> <para>For an Oracle source endpoint, your ASM server address. You can set this value from the <code>asm_server</code> value. You set <code>asm_server</code> as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_AsmUser"> <summary> <para> <para>For an Oracle source endpoint, your ASM user name. You can set this value from the <code>asm_user</code> value. You set <code>asm_user</code> as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_AuthMechanism"> <summary> <para> <para> The authentication mechanism you use to access the MongoDB source endpoint.</para><para>For the default value, in MongoDB version 2.x, <code>"default"</code> is <code>"mongodb_cr"</code>. For MongoDB version 3.x or later, <code>"default"</code> is <code>"scram_sha_1"</code>. This setting isn't used when <code>AuthType</code> is set to <code>"no"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_AuthPassword"> <summary> <para> <para>The password provided with the <code>auth-role</code> and <code>auth-token</code> options of the <code>AuthType</code> setting for a Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_AuthSource"> <summary> <para> <para> The MongoDB database name. This setting isn't used when <code>AuthType</code> is set to <code>"no"</code>. </para><para>The default is <code>"admin"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_AuthType"> <summary> <para> <para> The authentication type you use to access the MongoDB source endpoint.</para><para>When when set to <code>"no"</code>, user name and password parameters are not used and can be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_AuthType"> <summary> <para> <para>The type of authentication to perform when connecting to a Redis target. Options include <code>none</code>, <code>auth-token</code>, and <code>auth-role</code>. The <code>auth-token</code> option requires an <code>AuthPassword</code> value to be provided. The <code>auth-role</code> option requires <code>AuthUserName</code> and <code>AuthPassword</code> values to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_AuthUserName"> <summary> <para> <para>The user name provided with the <code>auth-role</code> option of the <code>AuthType</code> setting for a Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_BcpPacketSize"> <summary> <para> <para>The maximum size of the packets (in bytes) used to transfer data using BCP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_Broker"> <summary> <para> <para>A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form <code><i>broker-hostname-or-ip</i>:<i>port</i></code>. For example, <code>"ec2-12-345-678-901.compute-1.amazonaws.com:2345"</code>. For more information and examples of specifying a list of broker locations, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html">Using Apache Kafka as a target for Database Migration Service</a> in the <i>Database Migration Service User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_BucketFolder"> <summary> <para> <para>An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. </para><para>For full load mode, DMS converts source records into .csv files and loads them to the <i>BucketFolder/TableID</i> path. DMS uses the Redshift <code>COPY</code> command to upload the .csv files to the target table. The files are deleted once the <code>COPY</code> operation has finished. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html">COPY</a> in the <i>Amazon Redshift Database Developer Guide</i>.</para><para>For change-data-capture (CDC) mode, DMS creates a <i>NetChanges</i> table, and loads the .csv files to this <i>BucketFolder/NetChangesTableID</i> path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_BucketFolder"> <summary> <para> <para> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <code><i>bucketFolder</i>/<i>schema_name</i>/<i>table_name</i>/</code>. If this parameter isn't specified, then the path used is <code><i>schema_name</i>/<i>table_name</i>/</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DmsTransferSettings_BucketName"> <summary> <para> <para> The name of the S3 bucket to use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_BucketName"> <summary> <para> <para>The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_BucketName"> <summary> <para> <para> The name of the S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CannedAclForObject"> <summary> <para> <para>A value that enables DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 Developer Guide.</i></para><para>The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_CaptureDdl"> <summary> <para> <para>To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.</para><para>If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_CaseSensitiveName"> <summary> <para> <para>If Amazon Redshift is configured to support case sensitive schema names, set <code>CaseSensitiveNames</code> to <code>true</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CdcInsertsAndUpdate"> <summary> <para> <para>A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is <code>false</code>, but when <code>CdcInsertsAndUpdates</code> is set to <code>true</code> or <code>y</code>, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. </para><para>For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the <code>IncludeOpForFullLoad</code> parameter. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to either <code>I</code> or <code>U</code> to indicate INSERT and UPDATE operations at the source. But if <code>IncludeOpForFullLoad</code> is set to <code>false</code>, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para><note><para>DMS supports the use of the <code>CdcInsertsAndUpdates</code> parameter in versions 3.3.1 and later.</para><para><code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CdcInsertsOnly"> <summary> <para> <para>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</para><para>If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para><note><para>DMS supports the interaction described preceding between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later. </para><para><code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CdcMaxBatchInterval"> <summary> <para> <para>Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.</para><para>When <code>CdcMaxBatchInterval</code> and <code>CdcMinFileSize</code> are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.</para><para>The default value is 60 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CdcMinFileSize"> <summary> <para> <para>Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.</para><para>When <code>CdcMinFileSize</code> and <code>CdcMaxBatchInterval</code> are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.</para><para>The default value is 32 MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CdcPath"> <summary> <para> <para>Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If <code>CdcPath</code> is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions"><code>PreserveTransactions</code></a> to <code>true</code>, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder"><code>BucketFolder</code></a> and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName"><code>BucketName</code></a>.</para><para>For example, if you specify <code>CdcPath</code> as <code>MyChangedData</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> but do not specify <code>BucketFolder</code>, DMS creates the CDC folder path following: <code>MyTargetBucket/MyChangedData</code>.</para><para>If you specify the same <code>CdcPath</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> and <code>BucketFolder</code> as <code>MyTargetData</code>, DMS creates the CDC folder path following: <code>MyTargetBucket/MyTargetData/MyChangedData</code>.</para><para>For more information on CDC including transaction order on an S3 target, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath">Capturing data changes (CDC) including transaction order on the S3 target</a>.</para><note><para>This setting is supported in DMS versions 3.4.2 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.CertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_CharLengthSemantic"> <summary> <para> <para>Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to <code>CHAR</code>. Otherwise, the character column length is in bytes.</para><para>Example: <code>charLengthSemantics=CHAR;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_CleanSourceMetadataOnMismatch"> <summary> <para> <para>Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_CleanSourceMetadataOnMismatch"> <summary> <para> <para>Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CompressionType"> <summary> <para> <para>An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_CompUpdate"> <summary> <para> <para>If you set <code>CompUpdate</code> to <code>true</code> Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than <code>RAW</code>. If you set <code>CompUpdate</code> to <code>false</code>, automatic compression is disabled and existing column encodings aren't changed. The default is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ConnectionTimeout"> <summary> <para> <para>A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_ControlTablesFileGroup"> <summary> <para> <para>Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CsvDelimiter"> <summary> <para> <para> The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CsvNoSupValue"> <summary> <para> <para>This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue"><code>UseCsvNoSupValue</code></a> is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the <code>UseCsvNoSupValue</code> setting.</para><note><para>This setting is supported in DMS versions 3.4.1 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CsvNullValue"> <summary> <para> <para>An optional parameter that specifies how DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), DMS treats the empty string as the null value instead of <code>NULL</code>.</para><para>The default value is <code>NULL</code>. Valid values include any valid string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_CsvRowDelimiter"> <summary> <para> <para> The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (<code>\n</code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_CurrentLsn"> <summary> <para> <para>For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DatabaseName"> <summary> <para> <para>The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_DatabaseName"> <summary> <para> <para> The database name on the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code> or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_DatabaseName"> <summary> <para> <para> The database name on the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code> or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_DatabaseName"> <summary> <para> <para>The name of the Amazon Redshift data warehouse (service) that you are working with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DataFormat"> <summary> <para> <para>The format of the data that you want to use for output. You can choose one of the following: </para><ul><li><para><code>csv</code> : This is a row-based file format with comma-separated values (.csv). </para></li><li><para><code>parquet</code> : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DataPageSize"> <summary> <para> <para>The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_DateFormat"> <summary> <para> <para>The date format that you are using. Valid values are <code>auto</code> (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using <code>auto</code> recognizes most strings, even some that aren't supported when you use a date format string. </para><para>If your date and time values use formats different from each other, set this to <code>auto</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DatePartitionDelimiter"> <summary> <para> <para>Specifies a date separating delimiter to use during folder partitioning. The default value is <code>SLASH</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DatePartitionEnabled"> <summary> <para> <para>When set to <code>true</code>, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is <code>false</code>. For more information about date-based folder partitioning, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning">Using date-based folder partitioning</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DatePartitionSequence"> <summary> <para> <para>Identifies the sequence of the date format to use during folder partitioning. The default value is <code>YYYYMMDD</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DatePartitionTimezone"> <summary> <para> <para>When creating an S3 target endpoint, set <code>DatePartitionTimezone</code> to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>, as shown in the following example.</para><para><code>s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":"<i>Asia/Seoul</i>", "BucketName": "dms-nattarat-test"}'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_DdlArtifactsSchema"> <summary> <para> <para>The schema in which the operational DDL database artifacts are created.</para><para>Example: <code>ddlArtifactsSchema=xyzddlschema;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_DictPageSizeLimit"> <summary> <para> <para>The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of <code>PLAIN</code>. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to <code>PLAIN</code> encoding. This size is used for .parquet file format only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_DirectPathNoLog"> <summary> <para> <para>When set to <code>true</code>, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_DirectPathParallelLoad"> <summary> <para> <para>When set to <code>true</code>, this attribute specifies a parallel load when <code>useDirectPathFullLoad</code> is set to <code>Y</code>. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to <code>"one"</code>. </para><para>Must be a positive value greater than <code>0</code>. Default value is <code>1000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to <code>"one"</code>. </para><para>Must be a positive value greater than <code>0</code>. Default value is <code>1000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_EmptyAsNull"> <summary> <para> <para>A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of <code>true</code> sets empty CHAR and VARCHAR fields to null. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_EnableHomogenousTablespace"> <summary> <para> <para>Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_EnableStatistic"> <summary> <para> <para>A value that enables statistics for Parquet pages and row groups. Choose <code>true</code> to enable statistics, <code>false</code> to disable. Statistics include <code>NULL</code>, <code>DISTINCT</code>, <code>MAX</code>, and <code>MIN</code> values. This parameter defaults to <code>true</code>. This value is used for .parquet file format only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_EncodingType"> <summary> <para> <para>The type of encoding you are using: </para><ul><li><para><code>RLE_DICTIONARY</code> uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.</para></li><li><para><code>PLAIN</code> doesn't use encoding at all. Values are stored as they are.</para></li><li><para><code>PLAIN_DICTIONARY</code> builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_EncryptionMode"> <summary> <para> <para>The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either <code>SSE_S3</code> (the default) or <code>SSE_KMS</code>. </para><note><para>For the <code>ModifyEndpoint</code> operation, you can change the existing value of the <code>EncryptionMode</code> parameter from <code>SSE_KMS</code> to <code>SSE_S3</code>. But you can’t change the existing value from <code>SSE_S3</code> to <code>SSE_KMS</code>.</para></note><para>To use <code>SSE_S3</code>, create an Identity and Access Management (IAM) role with a policy that allows <code>"arn:aws:s3:::*"</code> to use the following actions: <code>"s3:PutObject", "s3:ListBucket"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_EncryptionMode"> <summary> <para> <para>The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either <code>SSE_S3</code> (the default) or <code>SSE_KMS</code>. </para><note><para>For the <code>ModifyEndpoint</code> operation, you can change the existing value of the <code>EncryptionMode</code> parameter from <code>SSE_KMS</code> to <code>SSE_S3</code>. But you can’t change the existing value from <code>SSE_S3</code> to <code>SSE_KMS</code>.</para></note><para>To use <code>SSE_S3</code>, you need an Identity and Access Management (IAM) role with permission to allow <code>"arn:aws:s3:::dms-*"</code> to use the following actions:</para><ul><li><para><code>s3:CreateBucket</code></para></li><li><para><code>s3:ListBucket</code></para></li><li><para><code>s3:DeleteBucket</code></para></li><li><para><code>s3:GetBucketLocation</code></para></li><li><para><code>s3:GetObject</code></para></li><li><para><code>s3:PutObject</code></para></li><li><para><code>s3:DeleteObject</code></para></li><li><para><code>s3:GetObjectVersion</code></para></li><li><para><code>s3:GetBucketPolicy</code></para></li><li><para><code>s3:PutBucketPolicy</code></para></li><li><para><code>s3:DeleteBucketPolicy</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.EndpointIdentifier"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.EndpointType"> <summary> <para> <para>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_EndpointUri"> <summary> <para> <para>The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.EngineName"> <summary> <para> <para>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>"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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_ErrorRetryDuration"> <summary> <para> <para>The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_ErrorRetryDuration"> <summary> <para> <para>The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_EventsPollInterval"> <summary> <para> <para>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</para><para>Example: <code>eventsPollInterval=5;</code></para><para>In the example, DMS checks for changes in the binary logs every five seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_EventsPollInterval"> <summary> <para> <para>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</para><para>Example: <code>eventsPollInterval=5;</code></para><para>In the example, DMS checks for changes in the binary logs every five seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ExactSetting"> <summary> <para> <para>If this attribute is Y, the current call to <code>ModifyEndpoint</code> replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to <code>ModifyEndpoint</code> does two things: </para><ul><li><para>It replaces any endpoint settings that already exist with new values, for settings with the same names.</para></li><li><para>It creates new endpoint settings that you specify in the call, for settings with different names. </para></li></ul><para>For example, if you call <code>create-endpoint ... --endpoint-settings '{"a":1}' ...</code>, the endpoint has the following endpoint settings: <code>'{"a":1}'</code>. If you then call <code>modify-endpoint ... --endpoint-settings '{"b":2}' ...</code> for the same endpoint, the endpoint has the following settings: <code>'{"a":1,"b":2}'</code>. </para><para>However, suppose that you follow this with a call to <code>modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ...</code> for that same endpoint again. Then the endpoint has the following settings: <code>'{"b":2}'</code>. All existing settings are replaced with the exact settings that you specify. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_ExecuteTimeout"> <summary> <para> <para>Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.</para><para>Example: <code>executeTimeout=100;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ExpectedBucketOwner"> <summary> <para> <para>To specify a bucket owner and prevent sniping, you can use the <code>ExpectedBucketOwner</code> endpoint setting. </para><para>Example: <code>--s3-settings='{"ExpectedBucketOwner": "<i>AWS_Account_ID</i>"}'</code></para><para>When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ExplicitId"> <summary> <para> <para>This setting is only valid for a full-load migration task. Set <code>ExplicitIds</code> to <code>true</code> to have tables with <code>IDENTITY</code> columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ExternalTableDefinition"> <summary> <para> <para>The external table definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ExternalTableDefinition"> <summary> <para> <para> Specifies how tables are defined in the S3 source files only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ExtraArchivedLogDestId"> <summary> <para> <para>Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the <code>dest_id</code> column in the <code>v$archived_log</code> view. Use this setting with the <code>archivedLogDestId</code> extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup. </para><para>This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings. </para><para><code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2]</code></para><para>In a primary-to-multiple-standby setup, you might apply the following settings.</para><para><code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]</code></para><para>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless it's necessary. For more information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B"> RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ExtraConnectionAttribute"> <summary> <para> <para>Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this setting when <code>NestingLevel</code> is set to <code>"none"</code>. </para><para>Default value is <code>"false"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this setting when <code>NestingLevel</code> is set to <code>"none"</code>. </para><para>Default value is <code>"false"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_FailTasksOnLobTruncation"> <summary> <para> <para>When set to <code>true</code>, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified <code>LobMaxSize</code>.</para><para>If a task is set to limited LOB mode and this option is set to <code>true</code>, the task fails instead of truncating the LOB data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_FailTasksOnLobTruncation"> <summary> <para> <para>When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater than the specified <code>LobMaxSize</code>.</para><para>If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_FileTransferUploadStream"> <summary> <para> <para>The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.</para><para>The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart upload overview</a>. </para><para><code>FileTransferUploadStreams</code> accepts a value from 1 through 64. It defaults to 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_FullLoadErrorPercentage"> <summary> <para> <para>The maximum percentage of records that can fail to be written before a full load operation stops.</para><para>To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatEnable"> <summary> <para> <para>The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps <code>restart_lsn</code> moving and prevents storage full scenarios.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatFrequency"> <summary> <para> <para>Sets the WAL heartbeat frequency (in minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatSchema"> <summary> <para> <para>Sets the schema in which the heartbeat artifacts are created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_IamAuthEnabled"> <summary> <para> <para>If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to <code>true</code>. Then attach the appropriate IAM policy document to your service role specified by <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_IgnoreHeaderRow"> <summary> <para> <para>When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.</para><para>The default is 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_IncludeControlDetail"> <summary> <para> <para>Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_IncludeControlDetail"> <summary> <para> <para>Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_IncludeNullAndEmpty"> <summary> <para> <para>Include NULL and empty columns for records migrated to the endpoint. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_IncludeNullAndEmpty"> <summary> <para> <para>Include NULL and empty columns for records migrated to the endpoint. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_IncludeOpForFullLoad"> <summary> <para> <para>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</para><note><para>DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.</para></note><para>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</para><note><para>This setting works together with the <code>CdcInsertsOnly</code> and the <code>CdcInsertsAndUpdates</code> parameters for output to .csv files only. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_IncludePartitionValue"> <summary> <para> <para>Shows the partition value within the Kafka message output unless the partition type is <code>schema-table-type</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_IncludePartitionValue"> <summary> <para> <para>Shows the partition value within the Kinesis message output, unless the partition type is <code>schema-table-type</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_IncludeTableAlterOperation"> <summary> <para> <para>Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_IncludeTableAlterOperation"> <summary> <para> <para>Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_IncludeTransactionDetail"> <summary> <para> <para>Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_IncludeTransactionDetail"> <summary> <para> <para>Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_KmsKeyId"> <summary> <para> <para>The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the <code>KmsKeyId</code> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_KmsKeyId"> <summary> <para> <para>The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the <code>KmsKeyId</code> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_LoadTimeout"> <summary> <para> <para>The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_MaxFileSize"> <summary> <para> <para>The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_MaxFileSize"> <summary> <para> <para>The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_MaxFileSize"> <summary> <para> <para>A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.</para><para>The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_MaxKBytesPerRead"> <summary> <para> <para>Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_MaxRetryCount"> <summary> <para> <para>The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_MessageFormat"> <summary> <para> <para>The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_MessageFormat"> <summary> <para> <para>The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_MessageMaxByte"> <summary> <para> <para>The maximum size in bytes for records created on the endpoint The default is 1,000,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_NestingLevel"> <summary> <para> <para> Specifies either document or table mode. </para><para>Default value is <code>"none"</code>. Specify <code>"none"</code> to use document mode. Specify <code>"one"</code> to use table mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_NestingLevel"> <summary> <para> <para> Specifies either document or table mode. </para><para>Default value is <code>"none"</code>. Specify <code>"none"</code> to use document mode. Specify <code>"one"</code> to use table mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_NoHexPrefix"> <summary> <para> <para>Set this optional parameter to <code>true</code> to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the <code>NoHexPrefix</code> endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_NoHexPrefix"> <summary> <para> <para>Set this optional parameter to <code>true</code> to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the <code>NoHexPrefix</code> endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_NumberDatatypeScale"> <summary> <para> <para>Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.</para><para>Example: <code>numberDataTypeScale=12</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_OraclePathPrefix"> <summary> <para> <para>Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ParallelAsmReadThread"> <summary> <para> <para>Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the <code>readAheadBlocks</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_ParallelLoadThread"> <summary> <para> <para>Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.</para><para>Example: <code>parallelLoadThreads=1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_ParallelLoadThread"> <summary> <para> <para>Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.</para><para>Example: <code>parallelLoadThreads=1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ParquetTimestampInMillisecond"> <summary> <para> <para>A value that specifies the precision of any <code>TIMESTAMP</code> column values that are written to an Amazon S3 object file in .parquet format.</para><note><para>DMS supports the <code>ParquetTimestampInMillisecond</code> parameter in versions 3.1.4 and later.</para></note><para>When <code>ParquetTimestampInMillisecond</code> is set to <code>true</code> or <code>y</code>, DMS writes all <code>TIMESTAMP</code> columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.</para><para>Currently, Amazon Athena and Glue can handle only millisecond precision for <code>TIMESTAMP</code> values. Set this parameter to <code>true</code> for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.</para><note><para>DMS writes any <code>TIMESTAMP</code> column values written to an S3 file in .csv format with microsecond precision.</para><para>Setting <code>ParquetTimestampInMillisecond</code> has no effect on the string format of the timestamp column value that is inserted by setting the <code>TimestampColumnName</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ParquetVersion"> <summary> <para> <para>The version of the Apache Parquet format that you want to use: <code>parquet_1_0</code> (the default) or <code>parquet_2_0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_PartitionIncludeSchemaTable"> <summary> <para> <para>Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_PartitionIncludeSchemaTable"> <summary> <para> <para>Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_Password"> <summary> <para> <para> The password for the user account you use to access the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_Password"> <summary> <para> <para> The password for the user account you use to access the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.Password"> <summary> <para> <para>The password to be used to login to the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_Password"> <summary> <para> <para>The password for the user named in the <code>username</code> property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_PluginName"> <summary> <para> <para>Specifies the plugin to use to create a replication slot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_Port"> <summary> <para> <para> The port value for the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_Port"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_Port"> <summary> <para> <para>Endpoint TCP port. The default value is 50000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_Port"> <summary> <para> <para> The port value for the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.Port"> <summary> <para> <para>The port used by the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_Port"> <summary> <para> <para>Endpoint TCP port. The default is 5432.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_Port"> <summary> <para> <para>Transmission Control Protocol (TCP) port for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_Port"> <summary> <para> <para>The port number for Amazon Redshift. The default value is 5439.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_Port"> <summary> <para> <para>Endpoint TCP port. The default is 5000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_PreserveTransaction"> <summary> <para> <para>If set to <code>true</code>, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath"><code>CdcPath</code></a>. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath">Capturing data changes (CDC) including transaction order on the S3 target</a>.</para><note><para>This setting is supported in DMS versions 3.4.2 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_QuerySingleAlwaysOnNode"> <summary> <para> <para>Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ReadAheadBlock"> <summary> <para> <para>Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_ReadBackupOnly"> <summary> <para> <para>When this attribute is set to <code>Y</code>, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to <code>Y</code> enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ReadTableSpaceName"> <summary> <para> <para>When set to <code>true</code>, this attribute supports tablespace replication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_RemoveQuote"> <summary> <para> <para>A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose <code>true</code> to remove quotation marks. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ReplaceChar"> <summary> <para> <para>A value that specifies to replaces the invalid characters specified in <code>ReplaceInvalidChars</code>, substituting the specified characters instead. The default is <code>"?"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ReplaceInvalidChar"> <summary> <para> <para>A list of characters that you want to replace. Use with <code>ReplaceChars</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ReplacePathPrefix"> <summary> <para> <para>Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified <code>usePathPrefix</code> setting to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_RetryInterval"> <summary> <para> <para>Specifies the number of seconds that the system waits before resending a query.</para><para>Example: <code>retryInterval=6;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_Rfc4180"> <summary> <para> <para>For an S3 source, when this value is set to <code>true</code> or <code>y</code>, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to <code>false</code> or <code>n</code>, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.</para><para>For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to <code>true</code> or <code>y</code> using Amazon S3 as a target, if the data has quotation marks or newline characters in it, DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.</para><para>The default value is <code>true</code>. Valid values include <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_RowGroupLength"> <summary> <para> <para>The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only. </para><para>If you choose a value larger than the maximum, <code>RowGroupLength</code> is set to the max row group length in bytes (64 * 1024 * 1024). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_S3BucketFolder"> <summary> <para> <para>A folder path where you want DMS to store migrated graph data in the S3 bucket specified by <code>S3BucketName</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_SafeguardPolicy"> <summary> <para> <para>Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.</para><para><i>Start transactions in the database:</i> This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.</para><para><i>Exclusively use sp_repldone within a single task</i>: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SaslPassword"> <summary> <para> <para>The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SaslUsername"> <summary> <para> <para> The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret.</code> The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the Database Migration Service User Guide. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint. </para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecretsManagerOracleAsmAccessRoleArn"> <summary> <para> <para>Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the <code>SecretsManagerOracleAsmSecret</code>. This <code>SecretsManagerOracleAsmSecret</code> has the secret value that allows access to the Oracle ASM of the endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerOracleAsmSecretId</code>. Or you can specify clear-text values for <code>AsmUserName</code>, <code>AsmPassword</code>, and <code>AsmServerName</code>. You can't specify both. For more information on creating this <code>SecretsManagerOracleAsmSecret</code> and the <code>SecretsManagerOracleAsmAccessRoleArn</code> and <code>SecretsManagerOracleAsmSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecretsManagerOracleAsmSecretId"> <summary> <para> <para>Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the <code>SecretsManagerOracleAsmSecret</code> that contains the Oracle ASM connection details for the Oracle endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the DocumentDB endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MySQL endpoint connection details. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Db2 LUW endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the SQL Server endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MongoDB endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MySQL endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Oracle endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Amazon Redshift endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the SAP SAE endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecurityDbEncryption"> <summary> <para> <para>For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the <code><i>TDE_Password</i></code> part of the comma-separated value you set to the <code>Password</code> request parameter when you create the endpoint. The <code>SecurityDbEncryptian</code> setting is related to this <code>SecurityDbEncryptionName</code> setting. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption"> Supported encryption methods for using Oracle as a source for DMS </a> in the <i>Database Migration Service User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SecurityDbEncryptionName"> <summary> <para> <para>For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the <code>SecurityDbEncryption</code> setting. For more information on setting the key name value of <code>SecurityDbEncryptionName</code>, see the information and example for setting the <code>securityDbEncryptionName</code> extra connection attribute in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption"> Supported encryption methods for using Oracle as a source for DMS </a> in the <i>Database Migration Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SecurityProtocol"> <summary> <para> <para>Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include <code>ssl-encryption</code>, <code>ssl-authentication</code>, and <code>sasl-ssl</code>. <code>sasl-ssl</code> requires <code>SaslUsername</code> and <code>SaslPassword</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_ServerName"> <summary> <para> <para> The name of the server on the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_ServerName"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_ServerName"> <summary> <para> <para> The name of the server on the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ServerName"> <summary> <para> <para>The name of the Amazon Redshift cluster you are using.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ServerName"> <summary> <para> <para>The name of the server where the endpoint database resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>The KMS key ID. If you are using <code>SSE_KMS</code> for the <code>EncryptionMode</code>, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>If you are using <code>SSE_KMS</code> for the <code>EncryptionMode</code>, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows use of the key.</para><para>Here is a CLI example: <code>aws dms create-endpoint --endpoint-identifier <i>value</i> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<i>value</i>,BucketFolder=<i>value</i>,BucketName=<i>value</i>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<i>value</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_ServerTimezone"> <summary> <para> <para>Specifies the time zone for the source MySQL database.</para><para>Example: <code>serverTimezone=US/Pacific;</code></para><para>Note: Do not enclose time zones in single quotes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_ServerTimezone"> <summary> <para> <para>Specifies the time zone for the source MySQL database.</para><para>Example: <code>serverTimezone=US/Pacific;</code></para><para>Note: Do not enclose time zones in single quotes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DmsTransferSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DynamoDbSettings_ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.NeptuneSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the <code>iam:PassRole</code> action. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>Database Migration Service User Guide. </i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action. It is a required parameter that enables DMS to write and read objects from an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_SetDataCaptureChange"> <summary> <para> <para>Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_SlotName"> <summary> <para> <para>Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. </para><para>When used with the <code>CdcStartPosition</code> request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid <code>CdcStartPosition</code> setting, DMS raises an error.</para><para>For more information about setting the <code>CdcStartPosition</code> request parameter, see <a href="dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native">Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more information about using <code>CdcStartPosition</code>, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html">CreateReplicationTask</a>, <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html">StartReplicationTask</a>, and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html">ModifyReplicationTask</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_SpatialDataOptionToGeoJsonFunctionName"> <summary> <para> <para>Use this attribute to convert <code>SDO_GEOMETRY</code> to <code>GEOJSON</code> format. By default, DMS calls the <code>SDO2GEOJSON</code> custom function if present and accessible. Or you can create your own custom function that mimics the operation of <code>SDOGEOJSON</code> and set <code>SpatialDataOptionToGeoJsonFunctionName</code> to call it instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SslCaCertificateArn"> <summary> <para> <para> The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_SslCaCertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SslClientCertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SslClientKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_SslClientKeyPassword"> <summary> <para> <para> The password for the client private key used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SslMode"> <summary> <para> <para>The SSL mode used to connect to the endpoint. The default value is <code>none</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedisSettings_SslSecurityProtocol"> <summary> <para> <para>The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include <code>plaintext</code> and <code>ssl-encryption</code>. The default is <code>ssl-encryption</code>. The <code>ssl-encryption</code> option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the <code>SslCaCertificateArn </code>setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.</para><para>The <code>plaintext</code> option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_StandbyDelayTime"> <summary> <para> <para>Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.</para><para>In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KinesisSettings_StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_TargetDbType"> <summary> <para> <para>Specifies where to migrate source tables on the target, either to a single database or multiple databases.</para><para>Example: <code>targetDbType=MULTIPLE_DATABASES</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_TargetDbType"> <summary> <para> <para>Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify <code>SPECIFIC_DATABASE</code>, specify the database name using the <code>DatabaseName</code> parameter of the <code>Endpoint</code> object.</para><para>Example: <code>targetDbType=MULTIPLE_DATABASES</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_TimeFormat"> <summary> <para> <para>The time format that you want to use. Valid values are <code>auto</code> (case-sensitive), <code>'timeformat_string'</code>, <code>'epochsecs'</code>, or <code>'epochmillisecs'</code>. It defaults to 10. Using <code>auto</code> recognizes most strings, even some that aren't supported when you use a time format string. </para><para>If your date and time values use formats different from each other, set this parameter to <code>auto</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_TimestampColumnName"> <summary> <para> <para>A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.</para><note><para>DMS supports the <code>TimestampColumnName</code> parameter in versions 3.1.4 and later.</para></note><para>DMS includes an additional <code>STRING</code> column in the .csv or .parquet object files of your migrated data when you set <code>TimestampColumnName</code> to a nonblank value.</para><para>For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. </para><para>For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.</para><para>The string format for this timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.</para><para>When the <code>AddColumnName</code> parameter is set to <code>true</code>, DMS also includes a name for the timestamp column that you set with <code>TimestampColumnName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.KafkaSettings_Topic"> <summary> <para> <para>The topic to which you migrate the data. If you don't specify a topic, DMS specifies <code>"kafka-default-topic"</code> as the migration topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_TrimBlank"> <summary> <para> <para>A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose <code>true</code> to remove unneeded white space. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_TruncateColumn"> <summary> <para> <para>A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose <code>true</code> to truncate data. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_UseAlternateFolderForOnline"> <summary> <para> <para>Set this attribute to <code>true</code> in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_UseBcpFullLoad"> <summary> <para> <para>Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_UseBFile"> <summary> <para> <para>Set this attribute to Y to capture change data using the Binary Reader utility. Set <code>UseLogminerReader</code> to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC"> Using Oracle LogMiner or DMS Binary Reader for CDC</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_UseCsvNoSupValue"> <summary> <para> <para>This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to <code>true</code> for columns not included in the supplemental log, DMS uses the value specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue"><code>CsvNoSupValue</code></a>. If not set or set to <code>false</code>, DMS uses the null value for these columns.</para><note><para>This setting is supported in DMS versions 3.4.1 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_UseDirectPathFullLoad"> <summary> <para> <para>Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_UseLogminerReader"> <summary> <para> <para>Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set <code>UseLogminerReader</code> to N, also set <code>UseBfile</code> to Y. For more information on this setting and using Oracle ASM, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC"> Using Oracle LogMiner or DMS Binary Reader for CDC</a> in the <i>DMS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_UseNewMappingType"> <summary> <para> <para>Set this option to <code>true</code> for DMS to migrate documentation using the documentation type <code>_doc</code>. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_UsePathPrefix"> <summary> <para> <para>Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DocDbSettings_Username"> <summary> <para> <para>The user name you use to access the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.GcpMySQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.IBMDb2Settings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_Username"> <summary> <para> <para>The user name you use to access the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MySQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.OracleSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PostgreSQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_Username"> <summary> <para> <para>An Amazon Redshift user name for a registered user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.SybaseSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.Username"> <summary> <para> <para>The user name to be used to login to the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.S3Settings_UseTaskStartTimeForFullLoadTimestamp"> <summary> <para> <para>When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>true</code>, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.</para><para>When <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>false</code>, the full load timestamp in the timestamp column increments with the time data arrives at the target. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MicrosoftSQLServerSettings_UseThirdPartyBackupDevice"> <summary> <para> <para>When this attribute is set to <code>Y</code>, DMS processes third-party transaction log backups if they are created in native format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_WriteBufferSize"> <summary> <para> <para>The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyEndpointResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet"> <summary> Modifies an existing DMS event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value; set to <b>true</b> to activate the subscription. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para> A list of event categories for a source type that you want to subscribe to. Use the <code>DescribeEventCategories</code> action to see a list of event categories. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of DMS resource that generates the events you want to subscribe to. </para><para>Valid values: replication-instance | replication-task</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the DMS event notification subscription to be modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventSubscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyEventSubscriptionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyEventSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionName parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEventSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet"> <summary> Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. <para> Some settings are applied during the maintenance window. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.AllocatedStorage"> <summary> <para> <para>The amount of storage (in gigabytes) to be allocated for the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.AllowMajorVersionUpgrade"> <summary> <para> <para>Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.</para><para>This parameter must be set to <code>true</code> when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the replication instance's current version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.ApplyImmediately"> <summary> <para> <para>Indicates whether the changes should be applied immediately or during the next maintenance window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible. </para><para>An outage does result if these factors apply: </para><ul><li><para>This parameter is set to <code>true</code> during the maintenance window.</para></li><li><para>A newer minor version is available. </para></li><li><para>DMS has enabled automatic patching for the given engine version. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.EngineVersion"> <summary> <para> <para>The engine version number of the replication instance.</para><para>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.MultiAZ"> <summary> <para> <para> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.NetworkType"> <summary> <para> <para>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.</para><para>Default: Uses existing setting</para><para>Format: ddd:hh24:mi-ddd:hh24:mi</para><para>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</para><para>Constraints: Must be at least 30 minutes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.ReplicationInstanceClass"> <summary> <para> <para>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>"dms.c4.large"</code>.</para><para>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.ReplicationInstanceIdentifier"> <summary> <para> <para>The replication instance identifier. This parameter is stored as a lowercase string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.VpcSecurityGroupId"> <summary> <para> <para> Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet"> <summary> Modifies the settings for the specified replication subnet group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.ReplicationSubnetGroupDescription"> <summary> <para> <para>A description for the replication instance subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.ReplicationSubnetGroupIdentifier"> <summary> <para> <para>The name of the replication instance subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.SubnetId"> <summary> <para> <para>A list of subnet IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationSubnetGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyReplicationSubnetGroupResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyReplicationSubnetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationSubnetGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationSubnetGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationSubnetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet"> <summary> Modifies the specified replication task. <para> You can't modify the task endpoints. The task must be stopped before you can modify it. </para><para> For more information about DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks</a> in the <i>Database Migration Service User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.CdcStartPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para> The value can be in date, checkpoint, or LSN/SCN format.</para><para>Date Example: --cdc-start-position “2018-03-08T12:12:12”</para><para>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</para><para>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</para><note><para>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, 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>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.CdcStartTime"> <summary> <para> <para>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.CdcStopPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</para><para>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.MigrationType"> <summary> <para> <para>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> | <code>full-load-and-cdc</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.ReplicationTaskIdentifier"> <summary> <para> <para>The replication task identifier.</para><para>Constraints:</para><ul><li><para>Must contain 1-255 alphanumeric characters or hyphens.</para></li><li><para>First character must be a letter.</para></li><li><para>Cannot end with a hyphen or contain two consecutive hyphens.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.ReplicationTaskSetting"> <summary> <para> <para>JSON file that contains settings for the task, such as task metadata settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.TableMapping"> <summary> <para> <para>When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with <code>file://</code>. For example, <code>--table-mappings file://mappingfile.json</code>. When working with the DMS API, provide the JSON as the parameter value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.TaskData"> <summary> <para> <para>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSAccountAttributeCmdlet"> <summary> Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region. <para> This command does not take any parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSAccountAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeAccountAttributesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeAccountAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet"> <summary> Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters. <para> If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run. </para><para> To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task. </para><para> If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.MigrationType"> <summary> <para> <para>Name of the migration type that each provided individual assessment must support.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.ReplicationInstanceArn"> <summary> <para> <para>ARN of a replication instance on which you want to base the default list of individual assessments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.ReplicationTaskArn"> <summary> <para> <para>Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.SourceEngineName"> <summary> <para> <para>Name of a database engine that the specified replication instance supports as a source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.TargetEngineName"> <summary> <para> <para>Name of a database engine that the specified replication instance supports as a target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.Marker"> <summary> <para> <para>Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.MaxRecord"> <summary> <para> <para>Maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IndividualAssessmentNames'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeApplicableIndividualAssessmentsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeApplicableIndividualAssessmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSApplicableIndividualAssessmentCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet"> <summary> Provides a description of the certificate.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.Filter"> <summary> <para> <para>Filters applied to the certificates described in the form of key-value pairs. Valid values are <code>certificate-arn</code> and <code>certificate-id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 10</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Certificates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeCertificatesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeCertificatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet"> <summary> Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet.Filter"> <summary> <para> <para>The filters applied to the connection.</para><para>Valid filter names: endpoint-arn | replication-instance-arn</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeConnectionsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSConnectionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet"> <summary> Returns information about the endpoints for your account in the current region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.Filter"> <summary> <para> <para>Filters applied to the endpoints.</para><para>Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEndpointsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet"> <summary> Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.EngineName"> <summary> <para> <para>The databse engine used for your source or target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.Marker"> <summary> <para> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEndpointSettingsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEndpointSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EngineName parameter. The -PassThru parameter is deprecated, use -Select '^EngineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointSettingCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet"> <summary> Returns information about the type of endpoints available.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.Filter"> <summary> <para> <para>Filters applied to the endpoint types.</para><para>Valid filter names: engine-name | endpoint-type</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SupportedEndpointTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEndpointTypesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEndpointTypesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet"> <summary> Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.Duration"> <summary> <para> <para>The duration of the events to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.EndTime"> <summary> <para> <para>The end time for the events to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.EventCategory"> <summary> <para> <para>A list of event categories for the source type that you've chosen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.Filter"> <summary> <para> <para>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.SourceIdentifier"> <summary> <para> <para> The identifier of an event source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.SourceType"> <summary> <para> <para>The type of DMS resource that generates events.</para><para>Valid values: replication-instance | replication-task</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.StartTime"> <summary> <para> <para>The start time for the events to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEventsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^SourceIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet"> <summary> Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.Filter"> <summary> <para> <para>Filters applied to the event categories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.SourceType"> <summary> <para> <para> The type of DMS resource that generates events. </para><para>Valid values: replication-instance | replication-task</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventCategoryGroupList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEventCategoriesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEventCategoriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceType parameter. The -PassThru parameter is deprecated, use -Select '^SourceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet"> <summary> Lists all the event subscriptions for a customer account. The description of a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>. <para> If you specify <code>SubscriptionName</code>, this action lists the description for that subscription. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.Filter"> <summary> <para> <para>Filters applied to event subscriptions.</para><para>Valid filter names: event-subscription-arn | event-subscription-id </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the DMS event subscription to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventSubscriptionsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeEventSubscriptionsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeEventSubscriptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionName parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorCollectorCmdlet"> <summary> Returns a list of the Fleet Advisor collectors in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorCollectorCmdlet.Filter"> <summary> <para> <para> If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:</para><ul><li><para><code>collector-referenced-id</code> – The ID of the collector agent, for example <code>d4610ac5-e323-4ad9-bc50-eaf7249dfe9d</code>.</para></li><li><para><code>collector-name</code> – The name of the collector agent.</para></li></ul><para>An example is: <code>describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorCollectorCmdlet.MaxRecord"> <summary> <para> <para>Sets the maximum number of records returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorCollectorCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorCollectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Collectors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorCollectorsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorCollectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorDatabaseCmdlet"> <summary> Returns a list of Fleet Advisor databases in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorDatabaseCmdlet.Filter"> <summary> <para> <para> If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria: </para><ul><li><para><code>database-id</code> – The ID of the database.</para></li><li><para><code>database-name</code> – The name of the database.</para></li><li><para><code>database-engine</code> – The name of the database engine.</para></li><li><para><code>server-ip-address</code> – The IP address of the database server.</para></li><li><para><code>database-ip-address</code> – The IP address of the database.</para></li><li><para><code>collector-name</code> – The name of the associated Fleet Advisor collector.</para></li></ul><para>An example is: <code>describe-fleet-advisor-databases --filter Name="database-id",Values="45"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorDatabaseCmdlet.MaxRecord"> <summary> <para> <para>Sets the maximum number of records returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorDatabaseCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorDatabaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Databases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorDatabasesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorDatabasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorLsaAnalysisCmdlet"> <summary> Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorLsaAnalysisCmdlet.MaxRecord"> <summary> <para> <para>Sets the maximum number of records returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorLsaAnalysisCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorLsaAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Analysis'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorLsaAnalysisResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorLsaAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaCmdlet"> <summary> Returns a list of schemas detected by Fleet Advisor Collectors in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaCmdlet.Filter"> <summary> <para> <para> If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:</para><ul><li><para><code>complexity</code> – The schema's complexity, for example <code>Simple</code>.</para></li><li><para><code>database-id</code> – The ID of the schema's database.</para></li><li><para><code>database-ip-address</code> – The IP address of the schema's database.</para></li><li><para><code>database-name</code> – The name of the schema's database.</para></li><li><para><code>database-engine</code> – The name of the schema database's engine.</para></li><li><para><code>original-schema-name</code> – The name of the schema's database's main schema.</para></li><li><para><code>schema-id</code> – The ID of the schema, for example <code>15</code>.</para></li><li><para><code>schema-name</code> – The name of the schema.</para></li><li><para><code>server-ip-address</code> – The IP address of the schema database's server.</para></li></ul><para>An example is: <code>describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaCmdlet.MaxRecord"> <summary> <para> <para>Sets the maximum number of records returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetAdvisorSchemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorSchemasResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaObjectSummaryCmdlet"> <summary> Provides descriptions of the schemas discovered by your Fleet Advisor collectors. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaObjectSummaryCmdlet.Filter"> <summary> <para> <para> If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:</para><ul><li><para><code>schema-id</code> – The ID of the schema, for example <code>d4610ac5-e323-4ad9-bc50-eaf7249dfe9d</code>.</para></li></ul><para>Example: <code>describe-fleet-advisor-schema-object-summary --filter Name="schema-id",Values="50"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaObjectSummaryCmdlet.MaxRecord"> <summary> <para> <para>Sets the maximum number of records returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaObjectSummaryCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSFleetAdvisorSchemaObjectSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FleetAdvisorSchemaObjects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorSchemaObjectSummaryResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeFleetAdvisorSchemaObjectSummaryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSOrderableReplicationInstanceCmdlet"> <summary> Returns information about the replication instance types that can be created in the specified region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSOrderableReplicationInstanceCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSOrderableReplicationInstanceCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSOrderableReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OrderableReplicationInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeOrderableReplicationInstancesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeOrderableReplicationInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSOrderableReplicationInstanceCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet"> <summary> For internal use only<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.Filter"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PendingMaintenanceActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribePendingMaintenanceActionsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribePendingMaintenanceActionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSRefreshSchemasStatusCmdlet"> <summary> Returns the status of the RefreshSchemas operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSRefreshSchemasStatusCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSRefreshSchemasStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RefreshSchemasStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeRefreshSchemasStatusResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeRefreshSchemasStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSRefreshSchemasStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet"> <summary> Returns information about replication instances for your account in the current region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.Filter"> <summary> <para> <para>Filters applied to replication instances.</para><para>Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationInstancesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet"> <summary> Returns information about the task logs for the specified task.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstanceTaskLogs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationInstanceTaskLogsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationInstanceTaskLogsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet"> <summary> Returns information about the replication subnet groups.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.Filter"> <summary> <para> <para>Filters applied to replication subnet groups.</para><para>Valid filter names: replication-subnet-group-id</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationSubnetGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationSubnetGroupsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationSubnetGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet"> <summary> Returns information about replication tasks for your account in the current region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.Filter"> <summary> <para> <para>Filters applied to replication tasks.</para><para>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.WithoutSetting"> <summary> <para> <para>An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose <code>true</code>; otherwise, choose <code>false</code> (the default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationTasksResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationTasksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet"> <summary> Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results. <para> For more information about DMS task assessments, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a> in the <i>Database Migration Service User Guide</i>. </para><br/><br/>In the AWS.Tools.DatabaseMigrationService module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the <code>MaxRecords</code> and <code>Marker</code> parameters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.DatabaseMigrationService module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskAssessmentResultsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskAssessmentResultsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet"> <summary> Returns a paginated list of premigration assessment runs based on filter settings. <para> These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values. </para><note><para> This operation doesn't return information about individual assessments. For this information, see the <code>DescribeReplicationTaskIndividualAssessments</code> operation. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet.Filter"> <summary> <para> <para>Filters applied to the premigration assessment runs described in the form of key-value pairs.</para><para>Valid filter names: <code>replication-task-assessment-run-arn</code>, <code>replication-task-arn</code>, <code>replication-instance-arn</code>, <code>status</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet.Marker"> <summary> <para> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskAssessmentRuns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskAssessmentRunsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskAssessmentRunsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentRunCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet"> <summary> Returns a paginated list of individual assessments based on filter settings. <para> These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet.Filter"> <summary> <para> <para>Filters applied to the individual assessments described in the form of key-value pairs.</para><para>Valid filter names: <code>replication-task-assessment-run-arn</code>, <code>replication-task-arn</code>, <code>status</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet.Marker"> <summary> <para> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskIndividualAssessments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskIndividualAssessmentsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeReplicationTaskIndividualAssessmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskIndividualAssessmentCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet"> <summary> Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html"><code>Tag</code></a> data type description. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource to list tags for. This returns a list of keys (names of tags) created for the resource and their associated tag values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet.ResourceArnList"> <summary> <para> <para>List of ARNs that identify multiple DMS resources that you want to list tags for. This returns a list of keys (tag names) and their associated tag values. It also returns each tag's associated <code>ResourceArn</code> value, which is the ARN of the resource for which each listed tag is created. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet"> <summary> Returns information about the schema for the specified endpoint.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Schemas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeSchemasResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet"> <summary> Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted. <para> Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table. </para><br/><br/>In the AWS.Tools.DatabaseMigrationService module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.Filter"> <summary> <para> <para>Filters applied to table statistics.</para><para>Valid filter names: schema-name | table-name | table-state</para><para>A combination of filters creates an AND condition where each record matches all specified filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.DatabaseMigrationService module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DescribeTableStatisticsResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DescribeTableStatisticsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet"> <summary> Uploads the specified certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.CertificateIdentifier"> <summary> <para> <para>A customer-assigned name for the certificate. 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.CertificatePem"> <summary> <para> <para>The contents of a <code>.pem</code> file, which contains an X.509 certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.CertificateWallet"> <summary> <para> <para>The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a <code>.sso</code> file using the <code>fileb://</code> prefix. You can't provide the certificate inline.</para><para>Example: <code>filebase64("${path.root}/rds-ca-2019-root.sso")</code></para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.Tag"> <summary> <para> <para>The tags associated with the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Certificate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ImportCertificateResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ImportCertificateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CertificatePem parameter. The -PassThru parameter is deprecated, use -Select '^CertificatePem' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.ImportDMSCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet"> <summary> Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RefreshSchemasStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.RefreshSchemasResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.RefreshSchemasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.InvokeDMSSchemaRefreshCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet"> <summary> Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the task that you want to move.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet.TargetReplicationInstanceArn"> <summary> <para> <para>The ARN of the replication instance where you want to move the task to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.MoveReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.MoveReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.MoveDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet"> <summary> Creates an endpoint using the provided settings. <note><para> For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on the <code>CreateEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_AcceptAnyDate"> <summary> <para> <para>A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose <code>true</code> or <code>false</code> (the default).</para><para>This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AccessAlternateDirectly"> <summary> <para> <para>Set this attribute to <code>false</code> in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_AddColumnName"> <summary> <para> <para>An optional parameter that, when set to <code>true</code> or <code>y</code>, you can use to add column name information to the .csv output file.</para><para>The default value is <code>false</code>. Valid values are <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AdditionalArchivedLogDestId"> <summary> <para> <para>Set this attribute with <code>ArchivedLogDestId</code> in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.</para><para>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless necessary. For additional information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B">RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AddSupplementalLogging"> <summary> <para> <para>Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.</para><para>If you use this option, you still need to enable database-level supplemental logging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_AddTrailingPaddingCharacter"> <summary> <para> <para>Use the S3 target endpoint setting <code>AddTrailingPaddingCharacter</code> to add padding on string data. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_AfterConnectScript"> <summary> <para> <para>Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.</para><para>For this parameter, provide the code of the script itself, not the name of a file containing the script. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_AfterConnectScript"> <summary> <para> <para>Specifies a script to run immediately after DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails.</para><para>For this parameter, provide the code of the script itself, not the name of a file containing the script.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_AfterConnectScript"> <summary> <para> <para>For use with change data capture (CDC) only, this attribute has DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data.</para><para>Example: <code>afterConnectScript=SET session_replication_role='replica'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_AfterConnectScript"> <summary> <para> <para>Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AllowSelectNestedTable"> <summary> <para> <para>Set this attribute to <code>true</code> to enable replication of Oracle tables containing columns that are nested tables or defined types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ArchivedLogDestId"> <summary> <para> <para>Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the <code>AdditionalArchivedLogDestId</code> option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ArchivedLogsOnly"> <summary> <para> <para>When this field is set to <code>Y</code>, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AsmPassword"> <summary> <para> <para>For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the <code><i>asm_user_password</i></code> value. You set this value as part of the comma-separated value that you set to the <code>Password</code> request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AsmServer"> <summary> <para> <para>For an Oracle source endpoint, your ASM server address. You can set this value from the <code>asm_server</code> value. You set <code>asm_server</code> as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_AsmUser"> <summary> <para> <para>For an Oracle source endpoint, your ASM user name. You can set this value from the <code>asm_user</code> value. You set <code>asm_user</code> as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration">Configuration for change data capture (CDC) on an Oracle source database</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_AuthMechanism"> <summary> <para> <para> The authentication mechanism you use to access the MongoDB source endpoint.</para><para>For the default value, in MongoDB version 2.x, <code>"default"</code> is <code>"mongodb_cr"</code>. For MongoDB version 3.x or later, <code>"default"</code> is <code>"scram_sha_1"</code>. This setting isn't used when <code>AuthType</code> is set to <code>"no"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_AuthPassword"> <summary> <para> <para>The password provided with the <code>auth-role</code> and <code>auth-token</code> options of the <code>AuthType</code> setting for a Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_AuthSource"> <summary> <para> <para> The MongoDB database name. This setting isn't used when <code>AuthType</code> is set to <code>"no"</code>. </para><para>The default is <code>"admin"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_AuthType"> <summary> <para> <para> The authentication type you use to access the MongoDB source endpoint.</para><para>When when set to <code>"no"</code>, user name and password parameters are not used and can be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_AuthType"> <summary> <para> <para>The type of authentication to perform when connecting to a Redis target. Options include <code>none</code>, <code>auth-token</code>, and <code>auth-role</code>. The <code>auth-token</code> option requires an <code>AuthPassword</code> value to be provided. The <code>auth-role</code> option requires <code>AuthUserName</code> and <code>AuthPassword</code> values to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_AuthUserName"> <summary> <para> <para>The user name provided with the <code>auth-role</code> option of the <code>AuthType</code> setting for a Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_BcpPacketSize"> <summary> <para> <para>The maximum size of the packets (in bytes) used to transfer data using BCP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_Broker"> <summary> <para> <para>A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form <code><i>broker-hostname-or-ip</i>:<i>port</i></code>. For example, <code>"ec2-12-345-678-901.compute-1.amazonaws.com:2345"</code>. For more information and examples of specifying a list of broker locations, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html">Using Apache Kafka as a target for Database Migration Service</a> in the <i>Database Migration Service User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_BucketFolder"> <summary> <para> <para>An S3 folder where the comma-separated-value (.csv) files are stored before being uploaded to the target Redshift cluster. </para><para>For full load mode, DMS converts source records into .csv files and loads them to the <i>BucketFolder/TableID</i> path. DMS uses the Redshift <code>COPY</code> command to upload the .csv files to the target table. The files are deleted once the <code>COPY</code> operation has finished. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html">COPY</a> in the <i>Amazon Redshift Database Developer Guide</i>.</para><para>For change-data-capture (CDC) mode, DMS creates a <i>NetChanges</i> table, and loads the .csv files to this <i>BucketFolder/NetChangesTableID</i> path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_BucketFolder"> <summary> <para> <para> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <code><i>bucketFolder</i>/<i>schema_name</i>/<i>table_name</i>/</code>. If this parameter isn't specified, then the path used is <code><i>schema_name</i>/<i>table_name</i>/</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DmsTransferSettings_BucketName"> <summary> <para> <para> The name of the S3 bucket to use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_BucketName"> <summary> <para> <para>The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_BucketName"> <summary> <para> <para> The name of the S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CannedAclForObject"> <summary> <para> <para>A value that enables DMS to specify a predefined (canned) access control list for objects created in an Amazon S3 bucket as .csv or .parquet files. For more information about Amazon S3 canned ACLs, see <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">Canned ACL</a> in the <i>Amazon S3 Developer Guide.</i></para><para>The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_CaptureDdl"> <summary> <para> <para>To capture DDL events, DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts.</para><para>If this value is set to <code>N</code>, you don't have to create tables or triggers on the source database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_CaseSensitiveName"> <summary> <para> <para>If Amazon Redshift is configured to support case sensitive schema names, set <code>CaseSensitiveNames</code> to <code>true</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CdcInsertsAndUpdate"> <summary> <para> <para>A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is <code>false</code>, but when <code>CdcInsertsAndUpdates</code> is set to <code>true</code> or <code>y</code>, only INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. </para><para>For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the <code>IncludeOpForFullLoad</code> parameter. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to either <code>I</code> or <code>U</code> to indicate INSERT and UPDATE operations at the source. But if <code>IncludeOpForFullLoad</code> is set to <code>false</code>, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para><note><para>DMS supports the use of the <code>CdcInsertsAndUpdates</code> parameter in versions 3.3.1 and later.</para><para><code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CdcInsertsOnly"> <summary> <para> <para>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</para><para>If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para><note><para>DMS supports the interaction described preceding between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later. </para><para><code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CdcMaxBatchInterval"> <summary> <para> <para>Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.</para><para>When <code>CdcMaxBatchInterval</code> and <code>CdcMinFileSize</code> are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.</para><para>The default value is 60 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CdcMinFileSize"> <summary> <para> <para>Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.</para><para>When <code>CdcMinFileSize</code> and <code>CdcMaxBatchInterval</code> are both specified, the file write is triggered by whichever parameter condition is met first within an DMS CloudFormation template.</para><para>The default value is 32 MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CdcPath"> <summary> <para> <para>Specifies the folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If <code>CdcPath</code> is set, DMS reads CDC files from this path and replicates the data changes to the target endpoint. For an S3 target if you set <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions"><code>PreserveTransactions</code></a> to <code>true</code>, DMS verifies that you have set this parameter to a folder path on your S3 target where DMS can save the transaction order for the CDC load. DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder"><code>BucketFolder</code></a> and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName"><code>BucketName</code></a>.</para><para>For example, if you specify <code>CdcPath</code> as <code>MyChangedData</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> but do not specify <code>BucketFolder</code>, DMS creates the CDC folder path following: <code>MyTargetBucket/MyChangedData</code>.</para><para>If you specify the same <code>CdcPath</code>, and you specify <code>BucketName</code> as <code>MyTargetBucket</code> and <code>BucketFolder</code> as <code>MyTargetData</code>, DMS creates the CDC folder path following: <code>MyTargetBucket/MyTargetData/MyChangedData</code>.</para><para>For more information on CDC including transaction order on an S3 target, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath">Capturing data changes (CDC) including transaction order on the S3 target</a>.</para><note><para>This setting is supported in DMS versions 3.4.2 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.CertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_CharLengthSemantic"> <summary> <para> <para>Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to <code>CHAR</code>. Otherwise, the character column length is in bytes.</para><para>Example: <code>charLengthSemantics=CHAR;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_CleanSourceMetadataOnMismatch"> <summary> <para> <para>Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_CleanSourceMetadataOnMismatch"> <summary> <para> <para>Adjusts the behavior of DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CompressionType"> <summary> <para> <para>An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_CompUpdate"> <summary> <para> <para>If you set <code>CompUpdate</code> to <code>true</code> Amazon Redshift applies automatic compression if the table is empty. This applies even if the table columns already have encodings other than <code>RAW</code>. If you set <code>CompUpdate</code> to <code>false</code>, automatic compression is disabled and existing column encodings aren't changed. The default is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ConnectionTimeout"> <summary> <para> <para>A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_ControlTablesFileGroup"> <summary> <para> <para>Specifies a file group for the DMS internal tables. When the replication task starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, awsdms_changes) are created for the specified file group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CsvDelimiter"> <summary> <para> <para> The delimiter used to separate columns in the .csv file for both source and target. The default is a comma. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CsvNoSupValue"> <summary> <para> <para>This setting only applies if your Amazon S3 output files during a change data capture (CDC) load are written in .csv format. If <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue"><code>UseCsvNoSupValue</code></a> is set to true, specify a string value that you want DMS to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of the <code>UseCsvNoSupValue</code> setting.</para><note><para>This setting is supported in DMS versions 3.4.1 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CsvNullValue"> <summary> <para> <para>An optional parameter that specifies how DMS treats null values. While handling the null value, you can use this parameter to pass a user-defined string as null when writing to the target. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value. So, if you set this parameter value to the empty string ("" or ''), DMS treats the empty string as the null value instead of <code>NULL</code>.</para><para>The default value is <code>NULL</code>. Valid values include any valid string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_CsvRowDelimiter"> <summary> <para> <para> The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage return (<code>\n</code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_CurrentLsn"> <summary> <para> <para>For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DatabaseName"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_DatabaseName"> <summary> <para> <para> The database name on the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code> or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_DatabaseName"> <summary> <para> <para> The database name on the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on either the <code>CreateEndpoint</code> or <code>ModifyEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_DatabaseName"> <summary> <para> <para>The name of the Amazon Redshift data warehouse (service) that you are working with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_DatabaseName"> <summary> <para> <para>Database name for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DataFormat"> <summary> <para> <para>The format of the data that you want to use for output. You can choose one of the following: </para><ul><li><para><code>csv</code> : This is a row-based file format with comma-separated values (.csv). </para></li><li><para><code>parquet</code> : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DataPageSize"> <summary> <para> <para>The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_DateFormat"> <summary> <para> <para>The date format that you are using. Valid values are <code>auto</code> (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using <code>auto</code> recognizes most strings, even some that aren't supported when you use a date format string. </para><para>If your date and time values use formats different from each other, set this to <code>auto</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DatePartitionDelimiter"> <summary> <para> <para>Specifies a date separating delimiter to use during folder partitioning. The default value is <code>SLASH</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DatePartitionEnabled"> <summary> <para> <para>When set to <code>true</code>, this parameter partitions S3 bucket folders based on transaction commit dates. The default value is <code>false</code>. For more information about date-based folder partitioning, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning">Using date-based folder partitioning</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DatePartitionSequence"> <summary> <para> <para>Identifies the sequence of the date format to use during folder partitioning. The default value is <code>YYYYMMDD</code>. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DatePartitionTimezone"> <summary> <para> <para>When creating an S3 target endpoint, set <code>DatePartitionTimezone</code> to convert the current UTC time into a specified time zone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The time zone format is Area/Location. Use this parameter when <code>DatePartitionedEnabled</code> is set to <code>true</code>, as shown in the following example.</para><para><code>s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", "DatePartitionTimezone":"<i>Asia/Seoul</i>", "BucketName": "dms-nattarat-test"}'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_DdlArtifactsSchema"> <summary> <para> <para>The schema in which the operational DDL database artifacts are created.</para><para>Example: <code>ddlArtifactsSchema=xyzddlschema;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_DictPageSizeLimit"> <summary> <para> <para>The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of <code>PLAIN</code>. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to <code>PLAIN</code> encoding. This size is used for .parquet file format only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_DirectPathNoLog"> <summary> <para> <para>When set to <code>true</code>, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_DirectPathParallelLoad"> <summary> <para> <para>When set to <code>true</code>, this attribute specifies a parallel load when <code>useDirectPathFullLoad</code> is set to <code>Y</code>. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to <code>"one"</code>. </para><para>Must be a positive value greater than <code>0</code>. Default value is <code>1000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to <code>"one"</code>. </para><para>Must be a positive value greater than <code>0</code>. Default value is <code>1000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_EmptyAsNull"> <summary> <para> <para>A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of <code>true</code> sets empty CHAR and VARCHAR fields to null. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_EnableHomogenousTablespace"> <summary> <para> <para>Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_EnableStatistic"> <summary> <para> <para>A value that enables statistics for Parquet pages and row groups. Choose <code>true</code> to enable statistics, <code>false</code> to disable. Statistics include <code>NULL</code>, <code>DISTINCT</code>, <code>MAX</code>, and <code>MIN</code> values. This parameter defaults to <code>true</code>. This value is used for .parquet file format only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_EncodingType"> <summary> <para> <para>The type of encoding you are using: </para><ul><li><para><code>RLE_DICTIONARY</code> uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.</para></li><li><para><code>PLAIN</code> doesn't use encoding at all. Values are stored as they are.</para></li><li><para><code>PLAIN_DICTIONARY</code> builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_EncryptionMode"> <summary> <para> <para>The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either <code>SSE_S3</code> (the default) or <code>SSE_KMS</code>. </para><note><para>For the <code>ModifyEndpoint</code> operation, you can change the existing value of the <code>EncryptionMode</code> parameter from <code>SSE_KMS</code> to <code>SSE_S3</code>. But you can’t change the existing value from <code>SSE_S3</code> to <code>SSE_KMS</code>.</para></note><para>To use <code>SSE_S3</code>, create an Identity and Access Management (IAM) role with a policy that allows <code>"arn:aws:s3:::*"</code> to use the following actions: <code>"s3:PutObject", "s3:ListBucket"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_EncryptionMode"> <summary> <para> <para>The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either <code>SSE_S3</code> (the default) or <code>SSE_KMS</code>. </para><note><para>For the <code>ModifyEndpoint</code> operation, you can change the existing value of the <code>EncryptionMode</code> parameter from <code>SSE_KMS</code> to <code>SSE_S3</code>. But you can’t change the existing value from <code>SSE_S3</code> to <code>SSE_KMS</code>.</para></note><para>To use <code>SSE_S3</code>, you need an Identity and Access Management (IAM) role with permission to allow <code>"arn:aws:s3:::dms-*"</code> to use the following actions:</para><ul><li><para><code>s3:CreateBucket</code></para></li><li><para><code>s3:ListBucket</code></para></li><li><para><code>s3:DeleteBucket</code></para></li><li><para><code>s3:GetBucketLocation</code></para></li><li><para><code>s3:GetObject</code></para></li><li><para><code>s3:PutObject</code></para></li><li><para><code>s3:DeleteObject</code></para></li><li><para><code>s3:GetObjectVersion</code></para></li><li><para><code>s3:GetBucketPolicy</code></para></li><li><para><code>s3:PutBucketPolicy</code></para></li><li><para><code>s3:DeleteBucketPolicy</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.EndpointIdentifier"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.EndpointType"> <summary> <para> <para>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_EndpointUri"> <summary> <para> <para>The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.EngineName"> <summary> <para> <para>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>, and <code>"babelfish"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_ErrorRetryDuration"> <summary> <para> <para>The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_ErrorRetryDuration"> <summary> <para> <para>The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_EventsPollInterval"> <summary> <para> <para>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</para><para>Example: <code>eventsPollInterval=5;</code></para><para>In the example, DMS checks for changes in the binary logs every five seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_EventsPollInterval"> <summary> <para> <para>Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.</para><para>Example: <code>eventsPollInterval=5;</code></para><para>In the example, DMS checks for changes in the binary logs every five seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_ExecuteTimeout"> <summary> <para> <para>Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.</para><para>Example: <code>executeTimeout=100;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ExpectedBucketOwner"> <summary> <para> <para>To specify a bucket owner and prevent sniping, you can use the <code>ExpectedBucketOwner</code> endpoint setting. </para><para>Example: <code>--s3-settings='{"ExpectedBucketOwner": "<i>AWS_Account_ID</i>"}'</code></para><para>When you make a request to test a connection or perform a migration, S3 checks the account ID of the bucket owner against the specified parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ExplicitId"> <summary> <para> <para>This setting is only valid for a full-load migration task. Set <code>ExplicitIds</code> to <code>true</code> to have tables with <code>IDENTITY</code> columns override their auto-generated values with explicit values loaded from the source data files used to populate the tables. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ExternalTableDefinition"> <summary> <para> <para>The external table definition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ExternalTableDefinition"> <summary> <para> <para> Specifies how tables are defined in the S3 source files only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ExtraArchivedLogDestId"> <summary> <para> <para>Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the <code>dest_id</code> column in the <code>v$archived_log</code> view. Use this setting with the <code>archivedLogDestId</code> extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup. </para><para>This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings. </para><para><code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2]</code></para><para>In a primary-to-multiple-standby setup, you might apply the following settings.</para><para><code>archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]</code></para><para>Although DMS supports the use of the Oracle <code>RESETLOGS</code> option to open the database, never use <code>RESETLOGS</code> unless it's necessary. For more information about <code>RESETLOGS</code>, see <a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B"> RMAN Data Repair Concepts</a> in the <i>Oracle Database Backup and Recovery User's Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ExtraConnectionAttribute"> <summary> <para> <para>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></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this setting when <code>NestingLevel</code> is set to <code>"none"</code>. </para><para>Default value is <code>"false"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this setting when <code>NestingLevel</code> is set to <code>"none"</code>. </para><para>Default value is <code>"false"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_FailTasksOnLobTruncation"> <summary> <para> <para>When set to <code>true</code>, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified <code>LobMaxSize</code>.</para><para>If a task is set to limited LOB mode and this option is set to <code>true</code>, the task fails instead of truncating the LOB data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_FailTasksOnLobTruncation"> <summary> <para> <para>When set to <code>true</code>, this value causes a task to fail if the actual size of a LOB column is greater than the specified <code>LobMaxSize</code>.</para><para>If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_FileTransferUploadStream"> <summary> <para> <para>The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.</para><para>The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart upload overview</a>. </para><para><code>FileTransferUploadStreams</code> accepts a value from 1 through 64. It defaults to 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_FullLoadErrorPercentage"> <summary> <para> <para>The maximum percentage of records that can fail to be written before a full load operation stops.</para><para>To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatEnable"> <summary> <para> <para>The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps <code>restart_lsn</code> moving and prevents storage full scenarios.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatFrequency"> <summary> <para> <para>Sets the WAL heartbeat frequency (in minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_HeartbeatSchema"> <summary> <para> <para>Sets the schema in which the heartbeat artifacts are created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_IamAuthEnabled"> <summary> <para> <para>If you want Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to <code>true</code>. Then attach the appropriate IAM policy document to your service role specified by <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_IgnoreHeaderRow"> <summary> <para> <para>When this value is set to 1, DMS ignores the first row header in a .csv file. A value of 1 turns on the feature; a value of 0 turns off the feature.</para><para>The default is 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_IncludeControlDetail"> <summary> <para> <para>Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_IncludeControlDetail"> <summary> <para> <para>Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_IncludeNullAndEmpty"> <summary> <para> <para>Include NULL and empty columns for records migrated to the endpoint. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_IncludeNullAndEmpty"> <summary> <para> <para>Include NULL and empty columns for records migrated to the endpoint. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_IncludeOpForFullLoad"> <summary> <para> <para>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</para><note><para>DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.</para></note><para>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</para><note><para>This setting works together with the <code>CdcInsertsOnly</code> and the <code>CdcInsertsAndUpdates</code> parameters for output to .csv files only. For more information about how these settings work together, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>Database Migration Service User Guide.</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_IncludePartitionValue"> <summary> <para> <para>Shows the partition value within the Kafka message output unless the partition type is <code>schema-table-type</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_IncludePartitionValue"> <summary> <para> <para>Shows the partition value within the Kinesis message output, unless the partition type is <code>schema-table-type</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_IncludeTableAlterOperation"> <summary> <para> <para>Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_IncludeTableAlterOperation"> <summary> <para> <para>Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_IncludeTransactionDetail"> <summary> <para> <para>Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_IncludeTransactionDetail"> <summary> <para> <para>Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_KmsKeyId"> <summary> <para> <para>The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the <code>KmsKeyId</code> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KmsKeyId"> <summary> <para> <para>An KMS key identifier that is used to encrypt the connection parameters for the endpoint.</para><para>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_KmsKeyId"> <summary> <para> <para>The KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the <code>KmsKeyId</code> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_LoadTimeout"> <summary> <para> <para>The amount of time to wait (in milliseconds) before timing out of operations performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_MaxFileSize"> <summary> <para> <para>The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to store the next batch of migrated graph data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_MaxFileSize"> <summary> <para> <para>Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.</para><para>Example: <code>maxFileSize=512</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_MaxFileSize"> <summary> <para> <para>The maximum size (in KB) of any .csv file used to load data on an S3 bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_MaxFileSize"> <summary> <para> <para>A value that specifies the maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load.</para><para>The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_MaxKBytesPerRead"> <summary> <para> <para>Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_MaxRetryCount"> <summary> <para> <para>The number of times for DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_MessageFormat"> <summary> <para> <para>The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_MessageFormat"> <summary> <para> <para>The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_MessageMaxByte"> <summary> <para> <para>The maximum size in bytes for records created on the endpoint The default is 1,000,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_NestingLevel"> <summary> <para> <para> Specifies either document or table mode. </para><para>Default value is <code>"none"</code>. Specify <code>"none"</code> to use document mode. Specify <code>"one"</code> to use table mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_NestingLevel"> <summary> <para> <para> Specifies either document or table mode. </para><para>Default value is <code>"none"</code>. Specify <code>"none"</code> to use document mode. Specify <code>"one"</code> to use table mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_NoHexPrefix"> <summary> <para> <para>Set this optional parameter to <code>true</code> to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the <code>NoHexPrefix</code> endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_NoHexPrefix"> <summary> <para> <para>Set this optional parameter to <code>true</code> to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the <code>NoHexPrefix</code> endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_NumberDatatypeScale"> <summary> <para> <para>Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.</para><para>Example: <code>numberDataTypeScale=12</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_OraclePathPrefix"> <summary> <para> <para>Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ParallelAsmReadThread"> <summary> <para> <para>Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the <code>readAheadBlocks</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_ParallelLoadThread"> <summary> <para> <para>Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.</para><para>Example: <code>parallelLoadThreads=1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_ParallelLoadThread"> <summary> <para> <para>Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.</para><para>Example: <code>parallelLoadThreads=1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ParquetTimestampInMillisecond"> <summary> <para> <para>A value that specifies the precision of any <code>TIMESTAMP</code> column values that are written to an Amazon S3 object file in .parquet format.</para><note><para>DMS supports the <code>ParquetTimestampInMillisecond</code> parameter in versions 3.1.4 and later.</para></note><para>When <code>ParquetTimestampInMillisecond</code> is set to <code>true</code> or <code>y</code>, DMS writes all <code>TIMESTAMP</code> columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.</para><para>Currently, Amazon Athena and Glue can handle only millisecond precision for <code>TIMESTAMP</code> values. Set this parameter to <code>true</code> for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.</para><note><para>DMS writes any <code>TIMESTAMP</code> column values written to an S3 file in .csv format with microsecond precision.</para><para>Setting <code>ParquetTimestampInMillisecond</code> has no effect on the string format of the timestamp column value that is inserted by setting the <code>TimestampColumnName</code> parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ParquetVersion"> <summary> <para> <para>The version of the Apache Parquet format that you want to use: <code>parquet_1_0</code> (the default) or <code>parquet_2_0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_PartitionIncludeSchemaTable"> <summary> <para> <para>Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_PartitionIncludeSchemaTable"> <summary> <para> <para>Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_Password"> <summary> <para> <para> The password for the user account you use to access the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_Password"> <summary> <para> <para> The password for the user account you use to access the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Password"> <summary> <para> <para>The password to be used to log in to the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_Password"> <summary> <para> <para>The password for the user named in the <code>username</code> property.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_Password"> <summary> <para> <para>Endpoint connection password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_PluginName"> <summary> <para> <para>Specifies the plugin to use to create a replication slot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_Port"> <summary> <para> <para> The port value for the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_Port"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_Port"> <summary> <para> <para>Endpoint TCP port. The default value is 50000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_Port"> <summary> <para> <para> The port value for the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_Port"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Port"> <summary> <para> <para>The port used by the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_Port"> <summary> <para> <para>Endpoint TCP port. The default is 5432.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_Port"> <summary> <para> <para>Transmission Control Protocol (TCP) port for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_Port"> <summary> <para> <para>The port number for Amazon Redshift. The default value is 5439.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_Port"> <summary> <para> <para>Endpoint TCP port. The default is 5000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_PreserveTransaction"> <summary> <para> <para>If set to <code>true</code>, DMS saves the transaction order for a change data capture (CDC) load on the Amazon S3 target specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath"><code>CdcPath</code></a>. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath">Capturing data changes (CDC) including transaction order on the S3 target</a>.</para><note><para>This setting is supported in DMS versions 3.4.2 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_QuerySingleAlwaysOnNode"> <summary> <para> <para>Cleans and recreates table metadata information on the replication instance when a mismatch occurs. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ReadAheadBlock"> <summary> <para> <para>Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_ReadBackupOnly"> <summary> <para> <para>When this attribute is set to <code>Y</code>, DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication. Setting this parameter to <code>Y</code> enables you to control active transaction log file growth during full load and ongoing replication tasks. However, it can add some source latency to ongoing replication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ReadTableSpaceName"> <summary> <para> <para>When set to <code>true</code>, this attribute supports tablespace replication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_RemoveQuote"> <summary> <para> <para>A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose <code>true</code> to remove quotation marks. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ReplaceChar"> <summary> <para> <para>A value that specifies to replaces the invalid characters specified in <code>ReplaceInvalidChars</code>, substituting the specified characters instead. The default is <code>"?"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ReplaceInvalidChar"> <summary> <para> <para>A list of characters that you want to replace. Use with <code>ReplaceChars</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ReplacePathPrefix"> <summary> <para> <para>Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified <code>usePathPrefix</code> setting to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ResourceIdentifier"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_RetryInterval"> <summary> <para> <para>Specifies the number of seconds that the system waits before resending a query.</para><para>Example: <code>retryInterval=6;</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_Rfc4180"> <summary> <para> <para>For an S3 source, when this value is set to <code>true</code> or <code>y</code>, each leading double quotation mark has to be followed by an ending double quotation mark. This formatting complies with RFC 4180. When this value is set to <code>false</code> or <code>n</code>, string literals are copied to the target as is. In this case, a delimiter (row or column) signals the end of the field. Thus, you can't use a delimiter as part of the string, because it signals the end of the value.</para><para>For an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using .csv file format only. When this value is set to <code>true</code> or <code>y</code> using Amazon S3 as a target, if the data has quotation marks or newline characters in it, DMS encloses the entire column with an additional pair of double quotation marks ("). Every quotation mark within the data is repeated twice.</para><para>The default value is <code>true</code>. Valid values include <code>true</code>, <code>false</code>, <code>y</code>, and <code>n</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_RowGroupLength"> <summary> <para> <para>The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only. </para><para>If you choose a value larger than the maximum, <code>RowGroupLength</code> is set to the max row group length in bytes (64 * 1024 * 1024). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_S3BucketFolder"> <summary> <para> <para>A folder path where you want DMS to store migrated graph data in the S3 bucket specified by <code>S3BucketName</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL source data to graph data before storing it in these .csv files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_SafeguardPolicy"> <summary> <para> <para>Use this attribute to minimize the need to access the backup log and enable DMS to prevent truncation using one of the following two methods.</para><para><i>Start transactions in the database:</i> This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.</para><para><i>Exclusively use sp_repldone within a single task</i>: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SaslPassword"> <summary> <para> <para>The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SaslUsername"> <summary> <para> <para> The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret.</code> The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the Database Migration Service User Guide. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint. </para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the SQL Server endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_SecretsManagerAccessRoleArn"> <summary> <para> <para>The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in <code>SecretsManagerSecret</code>. The role must allow the <code>iam:PassRole</code> action. <code>SecretsManagerSecret</code> has the value of the Amazon Web Services Secrets Manager secret that allows access to the SAP ASE endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerSecretId</code>. Or you can specify clear-text values for <code>UserName</code>, <code>Password</code>, <code>ServerName</code>, and <code>Port</code>. You can't specify both. For more information on creating this <code>SecretsManagerSecret</code> and the <code>SecretsManagerAccessRoleArn</code> and <code>SecretsManagerSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecretsManagerOracleAsmAccessRoleArn"> <summary> <para> <para>Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the <code>SecretsManagerOracleAsmSecret</code>. This <code>SecretsManagerOracleAsmSecret</code> has the secret value that allows access to the Oracle ASM of the endpoint.</para><note><para>You can specify one of two sets of values for these permissions. You can specify the values for this setting and <code>SecretsManagerOracleAsmSecretId</code>. Or you can specify clear-text values for <code>AsmUserName</code>, <code>AsmPassword</code>, and <code>AsmServerName</code>. You can't specify both. For more information on creating this <code>SecretsManagerOracleAsmSecret</code> and the <code>SecretsManagerOracleAsmAccessRoleArn</code> and <code>SecretsManagerOracleAsmSecretId</code> required to access it, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager">Using secrets to access Database Migration Service resources</a> in the <i>Database Migration Service User Guide</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecretsManagerOracleAsmSecretId"> <summary> <para> <para>Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the <code>SecretsManagerOracleAsmSecret</code> that contains the Oracle ASM connection details for the Oracle endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the DocumentDB endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MySQL endpoint connection details. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Db2 LUW endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the SQL Server endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MongoDB endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the MySQL endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Oracle endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the PostgreSQL endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the Amazon Redshift endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_SecretsManagerSecretId"> <summary> <para> <para>The full ARN, partial ARN, or friendly name of the <code>SecretsManagerSecret</code> that contains the SAP SAE endpoint connection details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecurityDbEncryption"> <summary> <para> <para>For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the <code><i>TDE_Password</i></code> part of the comma-separated value you set to the <code>Password</code> request parameter when you create the endpoint. The <code>SecurityDbEncryptian</code> setting is related to this <code>SecurityDbEncryptionName</code> setting. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption"> Supported encryption methods for using Oracle as a source for DMS </a> in the <i>Database Migration Service User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SecurityDbEncryptionName"> <summary> <para> <para>For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the <code>SecurityDbEncryption</code> setting. For more information on setting the key name value of <code>SecurityDbEncryptionName</code>, see the information and example for setting the <code>securityDbEncryptionName</code> extra connection attribute in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption"> Supported encryption methods for using Oracle as a source for DMS </a> in the <i>Database Migration Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SecurityProtocol"> <summary> <para> <para>Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include <code>ssl-encryption</code>, <code>ssl-authentication</code>, and <code>sasl-ssl</code>. <code>sasl-ssl</code> requires <code>SaslUsername</code> and <code>SaslPassword</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_ServerName"> <summary> <para> <para> The name of the server on the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_ServerName"> <summary> <para> <para>Endpoint TCP port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_ServerName"> <summary> <para> <para> The name of the server on the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ServerName"> <summary> <para> <para>The name of the Amazon Redshift cluster you are using.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ServerName"> <summary> <para> <para>The name of the server where the endpoint database resides.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_ServerName"> <summary> <para> <para>Fully qualified domain name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>The KMS key ID. If you are using <code>SSE_KMS</code> for the <code>EncryptionMode</code>, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>If you are using <code>SSE_KMS</code> for the <code>EncryptionMode</code>, provide the KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management (IAM) user permissions and allows use of the key.</para><para>Here is a CLI example: <code>aws dms create-endpoint --endpoint-identifier <i>value</i> --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=<i>value</i>,BucketFolder=<i>value</i>,BucketName=<i>value</i>,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=<i>value</i></code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_ServerTimezone"> <summary> <para> <para>Specifies the time zone for the source MySQL database.</para><para>Example: <code>serverTimezone=US/Pacific;</code></para><para>Note: Do not enclose time zones in single quotes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_ServerTimezone"> <summary> <para> <para>Specifies the time zone for the source MySQL database.</para><para>Example: <code>serverTimezone=US/Pacific;</code></para><para>Note: Do not enclose time zones in single quotes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DmsTransferSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DynamoDbSettings_ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.NeptuneSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the <code>iam:PassRole</code> action. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole">Creating an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>Database Migration Service User Guide. </i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the <code>iam:PassRole</code> action. It is a required parameter that enables DMS to write and read objects from an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ServiceAccessRoleArn"> <summary> <para> <para> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_SetDataCaptureChange"> <summary> <para> <para>Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_SlotName"> <summary> <para> <para>Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. </para><para>When used with the <code>CdcStartPosition</code> request parameter for the DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of <code>CdcStartPosition</code>. If the specified slot doesn't exist or the task doesn't have a valid <code>CdcStartPosition</code> setting, DMS raises an error.</para><para>For more information about setting the <code>CdcStartPosition</code> request parameter, see <a href="dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native">Determining a CDC native start point</a> in the <i>Database Migration Service User Guide</i>. For more information about using <code>CdcStartPosition</code>, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html">CreateReplicationTask</a>, <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html">StartReplicationTask</a>, and <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html">ModifyReplicationTask</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_SpatialDataOptionToGeoJsonFunctionName"> <summary> <para> <para>Use this attribute to convert <code>SDO_GEOMETRY</code> to <code>GEOJSON</code> format. By default, DMS calls the <code>SDO2GEOJSON</code> custom function if present and accessible. Or you can create your own custom function that mimics the operation of <code>SDOGEOJSON</code> and set <code>SpatialDataOptionToGeoJsonFunctionName</code> to call it instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SslCaCertificateArn"> <summary> <para> <para> The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_SslCaCertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SslClientCertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SslClientKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_SslClientKeyPassword"> <summary> <para> <para> The password for the client private key used to securely connect to a Kafka target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SslMode"> <summary> <para> <para>The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is <code>none</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedisSettings_SslSecurityProtocol"> <summary> <para> <para>The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include <code>plaintext</code> and <code>ssl-encryption</code>. The default is <code>ssl-encryption</code>. The <code>ssl-encryption</code> option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the <code>SslCaCertificateArn </code>setting. If an ARN isn't given for a CA, DMS uses the Amazon root CA.</para><para>The <code>plaintext</code> option doesn't provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_StandbyDelayTime"> <summary> <para> <para>Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.</para><para>In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KinesisSettings_StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_TargetDbType"> <summary> <para> <para>Specifies where to migrate source tables on the target, either to a single database or multiple databases.</para><para>Example: <code>targetDbType=MULTIPLE_DATABASES</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_TargetDbType"> <summary> <para> <para>Specifies where to migrate source tables on the target, either to a single database or multiple databases. If you specify <code>SPECIFIC_DATABASE</code>, specify the database name using the <code>DatabaseName</code> parameter of the <code>Endpoint</code> object.</para><para>Example: <code>targetDbType=MULTIPLE_DATABASES</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_TimeFormat"> <summary> <para> <para>The time format that you want to use. Valid values are <code>auto</code> (case-sensitive), <code>'timeformat_string'</code>, <code>'epochsecs'</code>, or <code>'epochmillisecs'</code>. It defaults to 10. Using <code>auto</code> recognizes most strings, even some that aren't supported when you use a time format string. </para><para>If your date and time values use formats different from each other, set this parameter to <code>auto</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_TimestampColumnName"> <summary> <para> <para>A value that when nonblank causes DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.</para><note><para>DMS supports the <code>TimestampColumnName</code> parameter in versions 3.1.4 and later.</para></note><para>DMS includes an additional <code>STRING</code> column in the .csv or .parquet object files of your migrated data when you set <code>TimestampColumnName</code> to a nonblank value.</para><para>For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. </para><para>For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.</para><para>The string format for this timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.</para><para>When the <code>AddColumnName</code> parameter is set to <code>true</code>, DMS also includes a name for the timestamp column that you set with <code>TimestampColumnName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KafkaSettings_Topic"> <summary> <para> <para>The topic to which you migrate the data. If you don't specify a topic, DMS specifies <code>"kafka-default-topic"</code> as the migration topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_TrimBlank"> <summary> <para> <para>A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose <code>true</code> to remove unneeded white space. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_TrimSpaceInChar"> <summary> <para> <para>Use the <code>TrimSpaceInChar</code> source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_TruncateColumn"> <summary> <para> <para>A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose <code>true</code> to truncate data. The default is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_UseAlternateFolderForOnline"> <summary> <para> <para>Set this attribute to <code>true</code> in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_UseBcpFullLoad"> <summary> <para> <para>Use this to attribute to transfer data for full-load operations using BCP. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_UseBFile"> <summary> <para> <para>Set this attribute to Y to capture change data using the Binary Reader utility. Set <code>UseLogminerReader</code> to N to set this attribute to Y. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC"> Using Oracle LogMiner or DMS Binary Reader for CDC</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_UseCsvNoSupValue"> <summary> <para> <para>This setting applies if the S3 output files during a change data capture (CDC) load are written in .csv format. If set to <code>true</code> for columns not included in the supplemental log, DMS uses the value specified by <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue"><code>CsvNoSupValue</code></a>. If not set or set to <code>false</code>, DMS uses the null value for these columns.</para><note><para>This setting is supported in DMS versions 3.4.1 and later.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_UseDirectPathFullLoad"> <summary> <para> <para>Set this attribute to Y to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_UseLogminerReader"> <summary> <para> <para>Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set <code>UseLogminerReader</code> to N, also set <code>UseBfile</code> to Y. For more information on this setting and using Oracle ASM, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC"> Using Oracle LogMiner or DMS Binary Reader for CDC</a> in the <i>DMS User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_UseNewMappingType"> <summary> <para> <para>Set this option to <code>true</code> for DMS to migrate documentation using the documentation type <code>_doc</code>. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_UsePathPrefix"> <summary> <para> <para>Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DocDbSettings_Username"> <summary> <para> <para>The user name you use to access the DocumentDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.GcpMySQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.IBMDb2Settings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_Username"> <summary> <para> <para>The user name you use to access the MongoDB source endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MySQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.OracleSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PostgreSQLSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_Username"> <summary> <para> <para>An Amazon Redshift user name for a registered user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.SybaseSettings_Username"> <summary> <para> <para>Endpoint connection user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Username"> <summary> <para> <para>The user name to be used to log in to the endpoint database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.S3Settings_UseTaskStartTimeForFullLoadTimestamp"> <summary> <para> <para>When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>true</code>, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.</para><para>When <code>useTaskStartTimeForFullLoadTimestamp</code> is set to <code>false</code>, the full load timestamp in the timestamp column increments with the time data arrives at the target. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MicrosoftSQLServerSettings_UseThirdPartyBackupDevice"> <summary> <para> <para>When this attribute is set to <code>Y</code>, DMS processes third-party transaction log backups if they are created in native format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_WriteBufferSize"> <summary> <para> <para>The size (in KB) of the in-memory file write buffer used when generating .csv files on the local disk at the DMS replication instance. The default value is 1000 (buffer size is 1000KB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateEndpointResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EndpointIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet"> <summary> Creates an DMS event notification subscription. <para> You can specify the type of source (<code>SourceType</code>) you want to be notified of, provide a list of DMS source IDs (<code>SourceIds</code>) that triggers the events, and provide a list of event categories (<code>EventCategories</code>) for events you want to be notified of. If you specify both the <code>SourceType</code> and <code>SourceIds</code>, such as <code>SourceType = replication-instance</code> and <code>SourceIdentifier = my-replinstance</code>, you will be notified of all the replication instance events for the specified source. If you specify a <code>SourceType</code> but don't specify a <code>SourceIdentifier</code>, you receive notice of the events for that source type for all your DMS sources. If you don't specify either <code>SourceType</code> nor <code>SourceIdentifier</code>, you will be notified of events generated from all DMS sources belonging to your customer account. </para><para> For more information about DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value; set to <code>true</code> to activate the subscription, or set to <code>false</code> to create the subscription but not activate it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para>A list of event categories for a source type that you want to subscribe to. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.SourceId"> <summary> <para> <para>A list of identifiers for which DMS provides notification events.</para><para>If you don't specify a value, notifications are provided for all sources.</para><para>If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value isn't specified, all events are returned. </para><para>Valid values: <code>replication-instance</code> | <code>replication-task</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the DMS event notification subscription. This name must be less than 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the event subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventSubscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateEventSubscriptionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateEventSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionName parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEventSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet"> <summary> Creates a Fleet Advisor collector using the specified parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.CollectorName"> <summary> <para> <para>The name of your Fleet Advisor collector (for example, <code>sample-collector</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.Description"> <summary> <para> <para>A summary description of your Fleet Advisor collector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.S3BucketName"> <summary> <para> <para>The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.ServiceAccessRoleArn"> <summary> <para> <para>The IAM role that grants permissions to access the specified Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CollectorReferencedId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateFleetAdvisorCollectorResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateFleetAdvisorCollectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CollectorName parameter. The -PassThru parameter is deprecated, use -Select '^CollectorName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSFleetAdvisorCollectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet"> <summary> Creates the replication instance using the specified parameters. <para> DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole">Creating the IAM Roles to Use With the CLI and DMS API</a>. For information on the required permissions, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions">IAM Permissions Needed to Use DMS</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.AllocatedStorage"> <summary> <para> <para>The amount of storage (in gigabytes) to be initially allocated for the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to <code>true</code>.</para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example: <code>us-east-1d</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.DnsNameServer"> <summary> <para> <para>A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: <code>"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.EngineVersion"> <summary> <para> <para>The engine version number of the replication instance.</para><para>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.KmsKeyId"> <summary> <para> <para>An KMS key identifier that is used to encrypt the data on the replication instance.</para><para>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.MultiAZ"> <summary> <para> <para> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.NetworkType"> <summary> <para> <para>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para>Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.</para><para>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.PubliclyAccessible"> <summary> <para> <para> Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.ReplicationInstanceClass"> <summary> <para> <para>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>"dms.c4.large"</code>.</para><para>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.ReplicationInstanceIdentifier"> <summary> <para> <para>The replication instance identifier. This parameter is stored as a lowercase string.</para><para>Constraints:</para><ul><li><para>Must contain 1-63 alphanumeric characters or hyphens.</para></li><li><para>First character must be a letter.</para></li><li><para>Can't end with a hyphen or contain two consecutive hyphens.</para></li></ul><para>Example: <code>myrepinstance</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.ReplicationSubnetGroupIdentifier"> <summary> <para> <para>A subnet group to associate with the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.ResourceIdentifier"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.VpcSecurityGroupId"> <summary> <para> <para> Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateReplicationInstanceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateReplicationInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet"> <summary> Creates a replication subnet group given a list of the subnet IDs in a VPC. <para> The VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the service will throw a <code>ReplicationSubnetGroupDoesNotCoverEnoughAZs</code> exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.ReplicationSubnetGroupDescription"> <summary> <para> <para>The description for the subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.ReplicationSubnetGroupIdentifier"> <summary> <para> <para>The name for the replication subnet group. This value is stored as a lowercase string.</para><para>Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".</para><para>Example: <code>mySubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.SubnetId"> <summary> <para> <para>One or more subnet IDs to be assigned to the subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationSubnetGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateReplicationSubnetGroupResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateReplicationSubnetGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationSubnetGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationSubnetGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationSubnetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet"> <summary> Creates a replication task using the specified parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.CdcStartPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para> The value can be in date, checkpoint, or LSN/SCN format.</para><para>Date Example: --cdc-start-position “2018-03-08T12:12:12”</para><para>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</para><para>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</para><note><para>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, 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>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.CdcStartTime"> <summary> <para> <para>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.CdcStopPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</para><para>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.MigrationType"> <summary> <para> <para>The migration type. Valid values: <code>full-load</code> | <code>cdc</code> | <code>full-load-and-cdc</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.ReplicationTaskIdentifier"> <summary> <para> <para>An identifier for the replication task.</para><para>Constraints:</para><ul><li><para>Must contain 1-255 alphanumeric characters or hyphens.</para></li><li><para>First character must be a letter.</para></li><li><para>Cannot end with a hyphen or contain two consecutive hyphens.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.ReplicationTaskSetting"> <summary> <para> <para>Overall settings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html">Specifying Task Settings for Database Migration Service Tasks</a> in the <i>Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.ResourceIdentifier"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.SourceEndpointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.TableMapping"> <summary> <para> <para>The table mappings for the task, in JSON format. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html">Using Table Mapping to Specify Task Settings</a> in the <i>Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the replication task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.TargetEndpointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.TaskData"> <summary> <para> <para>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html">Specifying Supplemental Data for Task Settings</a> in the <i>Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CreateReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSCertificateCmdlet"> <summary> Deletes the specified certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSCertificateCmdlet.CertificateArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSCertificateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Certificate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteCertificateResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteCertificateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSCertificateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CertificateArn parameter. The -PassThru parameter is deprecated, use -Select '^CertificateArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet"> <summary> Deletes the connection between a replication instance and an endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteConnectionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEndpointCmdlet"> <summary> Deletes the specified endpoint. <note><para> All tasks associated with the endpoint must be deleted before you can delete the endpoint. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEndpointCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteEndpointResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEventSubscriptionCmdlet"> <summary> Deletes an DMS event subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the DMS event notification subscription to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEventSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventSubscription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteEventSubscriptionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteEventSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEventSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SubscriptionName parameter. The -PassThru parameter is deprecated, use -Select '^SubscriptionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSEventSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorCollectorCmdlet"> <summary> Deletes the specified Fleet Advisor collector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorCollectorCmdlet.CollectorReferencedId"> <summary> <para> <para>The reference ID of the Fleet Advisor collector to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorCollectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteFleetAdvisorCollectorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorCollectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorDatabaseIdCmdlet"> <summary> Deletes the specified Fleet Advisor collector databases. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorDatabaseIdCmdlet.DatabaseId"> <summary> <para> <para>The IDs of the Fleet Advisor collector databases to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorDatabaseIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatabaseIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteFleetAdvisorDatabasesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteFleetAdvisorDatabasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSFleetAdvisorDatabaseIdCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationInstanceCmdlet"> <summary> Deletes the specified replication instance. <note><para> You must delete any migration tasks that are associated with the replication instance before you can delete it. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationInstanceCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteReplicationInstanceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteReplicationInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationSubnetGroupCmdlet"> <summary> Deletes a subnet group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationSubnetGroupCmdlet.ReplicationSubnetGroupIdentifier"> <summary> <para> <para>The subnet group name of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationSubnetGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteReplicationSubnetGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationSubnetGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationSubnetGroupIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationSubnetGroupIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationSubnetGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskCmdlet"> <summary> Deletes the specified replication task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication task to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskAssessmentRunCmdlet"> <summary> Deletes the record of a single premigration assessment run. <para> This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskAssessmentRunCmdlet.ReplicationTaskAssessmentRunArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the premigration assessment run to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskAssessmentRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskAssessmentRun'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.DeleteReplicationTaskAssessmentRunResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.DeleteReplicationTaskAssessmentRunResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskAssessmentRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskAssessmentRunArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskAssessmentRunArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSReplicationTaskAssessmentRunCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet"> <summary> Removes metadata tags from an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html"><code>Tag</code></a> data type description. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag key (name) of the tag to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.RemoveTagsFromResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet"> <summary> Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.ForceFailover"> <summary> <para> <para>If this parameter is <code>true</code>, the reboot is conducted through a Multi-AZ failover. If the instance isn't configured for Multi-AZ, then you can't specify <code>true</code>. ( <code>--force-planned-failover</code> and <code>--force-failover</code> can't both be set to <code>true</code>.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.ForcePlannedFailover"> <summary> <para> <para>If this parameter is <code>true</code>, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn''t configured for Multi-AZ, then you can't specify <code>true</code>. ( <code>--force-planned-failover</code> and <code>--force-failover</code> can't both be set to <code>true</code>.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.RebootReplicationInstanceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.RebootReplicationInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestartDMSReplicationInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet"> <summary> Reloads the target database table with the source data. <para> You can only use this operation with a task in the <code>RUNNING</code> state, otherwise the service will throw an <code>InvalidResourceStateFault</code> exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.ReloadOption"> <summary> <para> <para>Options for reload. Specify <code>data-reload</code> to reload the data and re-validate it if validation is enabled. Specify <code>validate-only</code> to re-validate the table. This option applies only when validation is enabled for the task. </para><para>Valid values: data-reload, validate-only</para><para>Default value is data-reload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.TablesToReload"> <summary> <para> <para>The name and schema of the table to be reloaded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ReloadTablesResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ReloadTablesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RestoreDMSTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet"> <summary> Adds metadata tags to an DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html"><code>Tag</code></a> data type description. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).</para><para>For DMS, you can tag a replication instance, an endpoint, or a replication task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.AddTagsToResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StartDMSFleetAdvisorLsaAnalysisCmdlet"> <summary> Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSFleetAdvisorLsaAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LsaAnalysisId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.RunFleetAdvisorLsaAnalysisResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.RunFleetAdvisorLsaAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSFleetAdvisorLsaAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet"> <summary> Starts the replication task. <para> For more information about DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks </a> in the <i>Database Migration Service User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.CdcStartPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para> The value can be in date, checkpoint, or LSN/SCN format.</para><para>Date Example: --cdc-start-position “2018-03-08T12:12:12”</para><para>Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"</para><para>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</para><note><para>When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the <code>slotName</code> extra connection attribute to the name of this logical replication slot. For more information, 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>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.CdcStartTime"> <summary> <para> <para>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</para><para>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.CdcStopPosition"> <summary> <para> <para>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</para><para>Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication task to be started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.StartReplicationTaskType"> <summary> <para> <para>The type of replication task to start.</para><para>When the migration type is <code>full-load</code> or <code>full-load-and-cdc</code>, the only valid value for the first run of the task is <code>start-replication</code>. You use <code>reload-target</code> to restart the task and <code>resume-processing</code> to resume the task.</para><para>When the migration type is <code>cdc</code>, you use <code>start-replication</code> to start or restart the task, and <code>resume-processing</code> to resume the task. <code>reload-target</code> is not a valid value for a task with migration type of <code>cdc</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.StartReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.StartReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentCmdlet"> <summary> Starts the replication task assessment for unsupported data types in the source database. <para> You can only use this operation for a task if the following conditions are true: </para><ul><li><para> The task must be in the <code>stopped</code> state. </para></li><li><para> The task must have successful connections to the source and target. </para></li></ul><para> If either of these conditions are not met, an <code>InvalidResourceStateFault</code> error will result. </para><para> For information about DMS task assessments, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html">Creating a task assessment report</a> in the <i>Database Migration Service User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentCmdlet.ReplicationTaskArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the replication task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.StartReplicationTaskAssessmentResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.StartReplicationTaskAssessmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet"> <summary> Starts a new premigration assessment run for one or more individual assessments of a migration task. <para> The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.AssessmentRunName"> <summary> <para> <para>Unique name to identify the assessment run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.Exclude"> <summary> <para> <para>Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</para><note><para>You can't set a value for <code>Exclude</code> if you also set a value for <code>IncludeOnly</code> in the API operation.</para><para>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.IncludeOnly"> <summary> <para> <para>Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</para><note><para>You can't set a value for <code>IncludeOnly</code> if you also set a value for <code>Exclude</code> in the API operation. </para><para>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ReplicationTaskArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ResultEncryptionMode"> <summary> <para> <para>Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:</para><ul><li><para><code>"SSE_S3"</code> – The server-side encryption provided as a default by Amazon S3.</para></li><li><para><code>"SSE_KMS"</code> – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ResultKmsKeyArn"> <summary> <para> <para>ARN of a custom KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>"SSE_KMS</code>".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ResultLocationBucket"> <summary> <para> <para>Amazon S3 bucket where you want DMS to store the results of this assessment run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ResultLocationFolder"> <summary> <para> <para>Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.ServiceAccessRoleArn"> <summary> <para> <para>ARN of the service role needed to start the assessment run. The role must allow the <code>iam:PassRole</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskAssessmentRun'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.StartReplicationTaskAssessmentRunResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.StartReplicationTaskAssessmentRunResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StartDMSReplicationTaskAssessmentRunCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskCmdlet"> <summary> Stops the replication task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskCmdlet.ReplicationTaskArn"> <summary> <para> <para>The Amazon Resource Name(ARN) of the replication task to be stopped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTask'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.StopReplicationTaskResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.StopReplicationTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskAssessmentRunCmdlet"> <summary> Cancels a single premigration assessment run. <para> This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskAssessmentRunCmdlet.ReplicationTaskAssessmentRunArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the premigration assessment run to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskAssessmentRunCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationTaskAssessmentRun'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.CancelReplicationTaskAssessmentRunResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CancelReplicationTaskAssessmentRunResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskAssessmentRunCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationTaskAssessmentRunArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationTaskAssessmentRunArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.StopDMSReplicationTaskAssessmentRunCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.TestDMSConnectionCmdlet"> <summary> Tests the connection between the replication instance and the endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.TestDMSConnectionCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.TestDMSConnectionCmdlet.ReplicationInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the replication instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.TestDMSConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.TestConnectionResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.TestConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.TestDMSConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.UpdateDMSSubscriptionsToEventBridgeCmdlet"> <summary> Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the <code>Force</code> option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be available when you use Amazon EventBridge. <para> To call this operation, make sure that you have certain permissions added to your user account. For more information, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge">Migrating event subscriptions to Amazon EventBridge</a> in the <i>Amazon Web Services Database Migration Service User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.UpdateDMSSubscriptionsToEventBridgeCmdlet.ForceMove"> <summary> <para> <para>When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.6 or higher. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.UpdateDMSSubscriptionsToEventBridgeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Result'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.UpdateSubscriptionsToEventBridgeResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.UpdateSubscriptionsToEventBridgeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.UpdateDMSSubscriptionsToEventBridgeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ForceMove parameter. The -PassThru parameter is deprecated, use -Select '^ForceMove' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.UpdateDMSSubscriptionsToEventBridgeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |