AWS Tools for Windows PowerShell
Command Reference

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

Synopsis

Calls the AWS Database Migration Service ModifyReplicationConfig API operation.

Syntax

Edit-DMSReplicationConfig
-ReplicationConfigArn <String>
-ComputeConfig_AvailabilityZone <String>
-ComputeConfig_DnsNameServer <String>
-ComputeConfig_KmsKeyId <String>
-ComputeConfig_MaxCapacityUnit <Int32>
-ComputeConfig_MinCapacityUnit <Int32>
-ComputeConfig_MultiAZ <Boolean>
-ComputeConfig_PreferredMaintenanceWindow <String>
-ReplicationConfigIdentifier <String>
-ReplicationSetting <String>
-ComputeConfig_ReplicationSubnetGroupId <String>
-ReplicationType <MigrationTypeValue>
-SourceEndpointArn <String>
-SupplementalSetting <String>
-TableMapping <String>
-TargetEndpointArn <String>
-ComputeConfig_VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDatabaseMigrationServiceConfig>

Description

Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it. Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.

Parameters

-ClientConfig <AmazonDatabaseMigrationServiceConfig>
Amazon.PowerShell.Cmdlets.DMS.AmazonDatabaseMigrationServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_AvailabilityZone <String>
The Availability Zone where the DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration's Amazon Web Services Region, for example, "us-west-2". You can't set this parameter if the MultiAZ parameter is set to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_DnsNameServer <String>
A list of custom DNS name servers supported for the DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfig_DnsNameServers
-ComputeConfig_KmsKeyId <String>
An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to encrypt the data during DMS Serverless replication.If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_MaxCapacityUnit <Int32>
Specifies the maximum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for DMS Serverless is 384. The MaxCapacityUnits parameter is the only DCU parameter you are required to specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfig_MaxCapacityUnits
-ComputeConfig_MinCapacityUnit <Int32>
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. You don't have to specify a value for the MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity of available source tables to identify an optimum setting for this parameter. If there is no current source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to the minimum DCU value allowed, 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfig_MinCapacityUnits
-ComputeConfig_MultiAZ <Boolean>
Specifies whether the DMS Serverless replication is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur for the DMS Serverless replication, in Universal Coordinated Time (UTC). The format is ddd:hh24:mi-ddd:hh24:mi.The default is a 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region. This maintenance occurs on a random day of the week. Valid values for days of the week include Mon, Tue, Wed, Thu, Fri, Sat, and Sun.Constraints include a minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_ReplicationSubnetGroupId <String>
Specifies a subnet group identifier to associate with the DMS Serverless replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeConfig_VpcSecurityGroupId <String[]>
Specifies the virtual private cloud (VPC) security group to use with the DMS Serverless replication. The VPC security group must work with the VPC containing the replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeConfig_VpcSecurityGroupIds
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ReplicationConfigArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationConfigArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationConfigArn <String>
The Amazon Resource Name of the replication to modify.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReplicationConfigIdentifier <String>
The new replication config to apply to the replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationSetting <String>
The settings for the replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReplicationSettings
-ReplicationType <MigrationTypeValue>
The type of replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceEndpointArn <String>
The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupplementalSetting <String>
Additional settings for the replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupplementalSettings
-TableMapping <String>
Table mappings specified in the replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableMappings
-TargetEndpointArn <String>
The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

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

Outputs

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

Supported Version

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