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> </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 AWS DMS resource that the pending maintenance action applies to.</para> </para> </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. </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.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.MongoDbSettings_AuthMechanism"> <summary> <para> <para> The authentication mechanism you use to access the MongoDB source endpoint.</para><para>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </para><para>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_AuthSource"> <summary> <para> <para> The MongoDB database name. This attribute is not used when <code>authType=NO</code>. </para><para>The default is admin.</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>Valid values: NO, PASSWORD </para><para>When NO is selected, user name and password parameters are not used and can be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_BucketFolder"> <summary> <para> <para>The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket. </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 is not 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 S3 bucket you want to use</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_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>AWS Database Migration Service User Guide.</i>.</para><note><para>AWS DMS supports this interaction between <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> in versions 3.1.4 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.S3Settings_CompressionType"> <summary> <para> <para> An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats. </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.S3Settings_CsvDelimiter"> <summary> <para> <para> The delimiter used to separate columns in the source files. The default is a comma. </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 source files. The default is a carriage return (<code>\n</code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.DatabaseName"> <summary> <para> <para>The name of the endpoint database.</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.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.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_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.MongoDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this attribute when <code>NestingLevel</code> is set to ONE. </para><para>Must be a positive value greater than 0. Default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.RedshiftSettings_EmptyAsNull"> <summary> <para> <para>A value that specifies whether AWS 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.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>. To use <code>SSE_S3</code>, create an AWS 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>. To use <code>SSE_S3</code>, you need an AWS 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; must contain only ASCII letters, digits, and hyphens; and must not 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 Elasticsearch cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.EngineName"> <summary> <para> <para>The type of engine for the endpoint. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_ErrorRetryDuration"> <summary> <para> <para>The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.</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> The external table definition. </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.MongoDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this attribute when <code>NestingLevel</code> is set to NONE. </para><para>Default value is false. </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> </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> </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>AWS DMS supports <code>IncludeOpForFullLoad</code> 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 <code>CdcInsertsOnly</code> 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>AWS Database Migration Service User Guide.</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.MongoDbSettings_KmsKeyId"> <summary> <para> <para>The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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, beginning from when you begin loading.</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 transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).</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>.</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>Valid values: NONE, ONE</para><para>Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.</para> </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.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.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.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.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.Port"> <summary> <para> <para>The port used by the endpoint database.</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.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.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.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.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.RedshiftSettings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>The AWS 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 AWS KMS key ID. The key that you use needs an attached policy that enables AWS 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.DmsTransferSettings_ServiceAccessRoleArn"> <summary> <para> <para> The IAM role that has permission to access the Amazon S3 bucket. </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 access IAM role. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ElasticsearchSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by service to access the IAM role.</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 Amazon Kinesis data stream.</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.</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 access IAM role. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSEndpointCmdlet.ServiceAccessRoleArn"> <summary> <para> <para> The Amazon Resource Name (ARN) for the service access role you want to use to modify the 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.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.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 includes a timestamp column in the Amazon S3 target endpoint data. AWS DMS includes an additional column in the migrated data when you set <code>timestampColumnName</code> to a non-blank value. </para><note><para>AWS DMS supports <code>TimestampColumnName</code> in versions 3.1.4 and later.</para></note><para>For a full load, each row of the timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a CDC load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The format for the timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. For CDC, the microsecond precision depends on the commit timestamp supported by DMS for the source database. When the <code>AddColumnName</code> setting is set to <code>true</code>, DMS also includes the name for the timestamp column that you set as the nonblank value of <code>timestampColumnName</code>.</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.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.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.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.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.RedshiftSettings_WriteBufferSize"> <summary> <para> <para>The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance. </para> </para> </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 AWS 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 AWS 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 AWS DMS event notification subscription to be modified.</para> </para> </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> Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version. </para> </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> </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 cannot 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.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.</para><para> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code></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.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.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 AWS DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks</a> in the <i>AWS 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> </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:3018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 3018-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 from 1 to 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 target metadata settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.EditDMSReplicationTaskCmdlet.TableMapping"> <summary> <para> <para>When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with <code>file://</code>. When working with the DMS API, provide the JSON as the parameter value, for example: <code>--table-mappings file://mappingfile.json</code></para> </para> </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 AWS DMS attributes for a customer account. These attributes include AWS 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="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet"> <summary> Provides a description of the certificate.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSCertificateCmdlet.Filter"> <summary> <para> <para>Filters applied to the certificate described in the form of key-value pairs.</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 vlue 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe action.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet"> <summary> Returns information about the type of endpoints available.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEndpointTypeCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe action.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 AWS 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>AWS Database Migration User Guide.</i><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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 the action.</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 AWS 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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>AWS Database Migration Service User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.Filter"> <summary> <para> <para>Filters applied to the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventCategoryCmdlet.SourceType"> <summary> <para> <para> The type of AWS DMS resource that generates events. </para><para>Valid values: replication-instance | replication-task</para> </para> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.Filter"> <summary> <para> <para>Filters applied to the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the AWS 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSPendingMaintenanceActionCmdlet"> <summary> For internal use only<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet"> <summary> Returns information about replication instances for your account in the current region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe action.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationInstanceTaskLogCmdlet"> <summary> Returns information about the task logs for the specified task.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet"> <summary> Returns information about the replication subnet groups.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationSubnetGroupCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe action.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe action.</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSReplicationTaskAssessmentResultCmdlet"> <summary> Returns the task assessment results from Amazon S3. This action always returns the latest results. </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 will return only one result and ignore the values of the max-records and marker 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> </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="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet"> <summary> Lists all tags for an AWS DMS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DMS.GetDMSSchemaCmdlet"> <summary> Returns information about the schema for the specified endpoint.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.Marker, for subsequent calls, to this parameter. </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> </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 AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.GetDMSTableStatisticCmdlet.Filter"> <summary> <para> <para>Filters applied to the describe table statistics action.</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> </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="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; must contain only ASCII letters, digits, and hyphens; and must not 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.</para> </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.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.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. </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.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.MongoDbSettings_AuthMechanism"> <summary> <para> <para> The authentication mechanism you use to access the MongoDB source endpoint.</para><para>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </para><para>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_AuthSource"> <summary> <para> <para> The MongoDB database name. This attribute is not used when <code>authType=NO</code>. </para><para>The default is admin.</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>Valid values: NO, PASSWORD </para><para>When NO is selected, user name and password parameters are not used and can be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_BucketFolder"> <summary> <para> <para>The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket. </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 is not 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 S3 bucket you want to use</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_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>AWS Database Migration Service User Guide.</i>.</para><note><para>AWS DMS supports this interaction between <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> in versions 3.1.4 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.S3Settings_CompressionType"> <summary> <para> <para> An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats. </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.S3Settings_CsvDelimiter"> <summary> <para> <para> The delimiter used to separate columns in the source files. The default is a comma. </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 source files. The default is a carriage return (<code>\n</code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.DatabaseName"> <summary> <para> <para>The name of the endpoint database.</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.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.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_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.MongoDbSettings_DocsToInvestigate"> <summary> <para> <para> Indicates the number of documents to preview to determine the document organization. Use this attribute when <code>NestingLevel</code> is set to ONE. </para><para>Must be a positive value greater than 0. Default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.RedshiftSettings_EmptyAsNull"> <summary> <para> <para>A value that specifies whether AWS 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.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>. To use <code>SSE_S3</code>, create an AWS 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>. To use <code>SSE_S3</code>, you need an AWS 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; must contain only ASCII letters, digits, and hyphens; and must not 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 Elasticsearch cluster.</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>redshift</code>, <code>s3</code>, <code>db2</code>, <code>azuredb</code>, <code>sybase</code>, <code>dynamodb</code>, <code>mongodb</code>, and <code>sqlserver</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_ErrorRetryDuration"> <summary> <para> <para>The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.</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> The external table definition. </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 AWS DMS Endpoints</a> in the <i>AWS Database Migration Service User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_ExtractDocId"> <summary> <para> <para> Specifies the document ID. Use this attribute when <code>NestingLevel</code> is set to NONE. </para><para>Default value is false. </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> </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> </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>AWS DMS supports <code>IncludeOpForFullLoad</code> 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 <code>CdcInsertsOnly</code> 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>AWS Database Migration Service User Guide.</i>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.KmsKeyId"> <summary> <para> <para>An AWS 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 AWS DMS uses your default encryption key.</para><para>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.MongoDbSettings_KmsKeyId"> <summary> <para> <para>The AWS 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 AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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, beginning from when you begin loading.</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 transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).</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>.</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>Valid values: NONE, ONE</para><para>Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.</para> </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.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.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.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.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.Port"> <summary> <para> <para>The port used by the endpoint database.</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.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.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.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.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.RedshiftSettings_ServerSideEncryptionKmsKeyId"> <summary> <para> <para>The AWS 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 AWS KMS key ID. The key that you use needs an attached policy that enables AWS 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.DmsTransferSettings_ServiceAccessRoleArn"> <summary> <para> <para> The IAM role that has permission to access the Amazon S3 bucket. </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 access IAM role. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSEndpointCmdlet.ElasticsearchSettings_ServiceAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) used by service to access the IAM role.</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 Amazon Kinesis data stream.</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.</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 access IAM role. </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. </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.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.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 includes a timestamp column in the Amazon S3 target endpoint data. AWS DMS includes an additional column in the migrated data when you set <code>timestampColumnName</code> to a non-blank value. </para><note><para>AWS DMS supports <code>TimestampColumnName</code> in versions 3.1.4 and later.</para></note><para>For a full load, each row of the timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a CDC load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The format for the timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. For CDC, the microsecond precision depends on the commit timestamp supported by DMS for the source database. When the <code>AddColumnName</code> setting is set to <code>true</code>, DMS also includes the name for the timestamp column that you set as the nonblank value of <code>timestampColumnName</code>.</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.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.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.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.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.RedshiftSettings_WriteBufferSize"> <summary> <para> <para>The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance. </para> </para> </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 AWS 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 AWS 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 AWS DMS sources. If you don't specify either <code>SourceType</code> nor <code>SourceIdentifier</code>, you will be notified of events generated from all AWS DMS sources belonging to your customer account. </para><para> For more information about AWS 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>AWS 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>AWS 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 AWS 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 AWS 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 is not 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 AWS 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.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. </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>Indicates whether minor engine upgrades will be 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 AWS Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's AWS 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 DNS name servers supported for the replication instance.</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.NewDMSReplicationInstanceCmdlet.KmsKeyId"> <summary> <para> <para>An AWS 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 AWS DMS uses your default encryption key.</para><para>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS 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 cannot 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.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 AWS 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 specified by the replication instance class.</para><para> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code></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 from 1 to 63 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>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.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.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. </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.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> </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:3018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 3018-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 from 1 to 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">Task Settings</a> in the <i>AWS Database Migration User Guide.</i></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">Table Mapping</a> in the <i>AWS Database Migration 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.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 deleted certificate.</para> </para> </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.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.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 AWS 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.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.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.PassThru"> <summary> Returns the value passed to the ReplicationSubnetGroupIdentifier parameter. By default, this cmdlet does not generate any output. </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.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 a DMS resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.RemoveDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>An AWS 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.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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>.)</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.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. </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.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 AWS 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DMS.SetDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).</para><para>For AWS 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.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </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.StartDMSReplicationTaskCmdlet"> <summary> Starts the replication task. <para> For more information about AWS DMS tasks, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html">Working with Migration Tasks </a> in the <i>AWS 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> </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:3018-02-09T12:12:12”</para><para>Commit time example: --cdc-stop-position “commit_time: 3018-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.</para> </para> </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. </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.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.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> </members> </doc> |