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 ModifyReplicationInstance API operation.

Syntax

Edit-DMSReplicationInstance
-ReplicationInstanceArn <String>
-AllocatedStorage <Int32>
-AllowMajorVersionUpgrade <Boolean>
-ApplyImmediately <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-EngineVersion <String>
-MultiAZ <Boolean>
-NetworkType <String>
-PreferredMaintenanceWindow <String>
-ReplicationInstanceClass <String>
-ReplicationInstanceIdentifier <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDatabaseMigrationServiceConfig>

Description

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. Some settings are applied during the maintenance window.

Parameters

-AllocatedStorage <Int32>
The amount of storage (in gigabytes) to be allocated for the replication instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AllowMajorVersionUpgrade <Boolean>
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.This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApplyImmediately <Boolean>
Indicates whether the changes should be applied immediately or during the next maintenance window.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible. An outage does result if these factors apply:
  • This parameter is set to true during the maintenance window.
  • A newer minor version is available.
  • DMS has enabled automatic patching for the given engine version.
When AutoMinorVersionUpgrade is enabled, DMS uses the current default engine version when you modify a replication instance. For example, if you set EngineVersion to a lower version number than the current default version, DMS uses the default version.If AutoMinorVersionUpgradeisn’t enabled when you modify a replication instance, DMS uses the engine version specified by the EngineVersion parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDatabaseMigrationServiceConfig>
Amazon.PowerShell.Cmdlets.DMS.AmazonDatabaseMigrationServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The engine version number of the replication instance.When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-MultiAZ <Boolean>
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkType <String>
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ReplicationInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^ReplicationInstanceArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
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.Default: Uses existing settingFormat: ddd:hh24:mi-ddd:hh24:miValid Days: Mon | Tue | Wed | Thu | Fri | Sat | SunConstraints: Must be at least 30 minutes
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationInstanceArn <String>
The Amazon Resource Name (ARN) of the replication instance.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReplicationInstanceClass <String>
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to "dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationInstanceIdentifier <String>
The replication instance identifier. This parameter is stored as a lowercase string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcSecurityGroupIds

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.ReplicationInstance or Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse
This cmdlet returns an Amazon.DatabaseMigrationService.Model.ReplicationInstance object. The service call response (type Amazon.DatabaseMigrationService.Model.ModifyReplicationInstanceResponse) 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