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

Syntax

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

Description

Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

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. If you don't set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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)
-ReplicationConfigIdentifier <String>
A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action. You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReplicationSetting <String>
Optional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReplicationSettings
-ReplicationType <MigrationTypeValue>
The type of DMS Serverless replication to provision using this replication configuration.Possible values:
  • "full-load"
  • "cdc"
  • "full-load-and-cdc"
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceIdentifier <String>
Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags.
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.CreateReplicationConfigResponse). Specifying the name of a property of type Amazon.DatabaseMigrationService.Model.CreateReplicationConfigResponse 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupplementalSetting <String>
Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSupplementalSettings
-TableMapping <String>
JSON table mappings for DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTableMappings
-Tag <Tag[]>
One or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TargetEndpointArn <String>
The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
Required?True
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.CreateReplicationConfigResponse
This cmdlet returns an Amazon.DatabaseMigrationService.Model.ReplicationConfig object. The service call response (type Amazon.DatabaseMigrationService.Model.CreateReplicationConfigResponse) can be returned by specifying '-Select *'.
User Guide
Schema Conversion User Guide
AWS Tools for PowerShell User Guide

Supported Version

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