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 Elastic Disaster Recovery Service UpdateReplicationConfiguration API operation.

Syntax

Update-EDRSReplicationConfiguration
-SourceServerID <String>
-AssociateDefaultSecurityGroup <Boolean>
-AutoReplicateNewDisk <Boolean>
-BandwidthThrottling <Int64>
-CreatePublicIP <Boolean>
-DataPlaneRouting <ReplicationConfigurationDataPlaneRouting>
-DefaultLargeStagingDiskType <ReplicationConfigurationDefaultLargeStagingDiskType>
-EbsEncryption <ReplicationConfigurationEbsEncryption>
-EbsEncryptionKeyArn <String>
-Name <String>
-PitPolicy <PITPolicyRule[]>
-ReplicatedDisk <ReplicationConfigurationReplicatedDisk[]>
-ReplicationServerInstanceType <String>
-ReplicationServersSecurityGroupsIDs <String[]>
-StagingAreaSubnetId <String>
-StagingAreaTag <Hashtable>
-UseDedicatedReplicationServer <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonDrsConfig>

Description

Allows you to update a ReplicationConfiguration by Source Server ID.

Parameters

-AssociateDefaultSecurityGroup <Boolean>
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoReplicateNewDisk <Boolean>
Whether to allow the AWS replication agent to automatically replicate newly added disks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAutoReplicateNewDisks
-BandwidthThrottling <Int64>
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonDrsConfig>
Amazon.PowerShell.Cmdlets.EDRS.AmazonDrsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreatePublicIP <Boolean>
Whether to create a Public IP for the Recovery Instance by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataPlaneRouting <ReplicationConfigurationDataPlaneRouting>
The data plane routing mechanism that will be used for replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultLargeStagingDiskType <ReplicationConfigurationDefaultLargeStagingDiskType>
The Staging Disk EBS volume type to be used during replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EbsEncryption <ReplicationConfigurationEbsEncryption>
The type of EBS encryption to be used during replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EbsEncryptionKeyArn <String>
The ARN of the EBS encryption key to be used during replication.
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)
-Name <String>
The name of the Replication Configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the SourceServerID parameter. The -PassThru parameter is deprecated, use -Select '^SourceServerID' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PitPolicy <PITPolicyRule[]>
The Point in time (PIT) policy to manage snapshots taken during replication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicatedDisk <ReplicationConfigurationReplicatedDisk[]>
The configuration of the disks of the Source Server to be replicated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReplicatedDisks
-ReplicationServerInstanceType <String>
The instance type to be used for the replication server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationServersSecurityGroupsIDs <String[]>
The security group IDs that will be used by the replication server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Drs.Model.UpdateReplicationConfigurationResponse). Specifying the name of a property of type Amazon.Drs.Model.UpdateReplicationConfigurationResponse 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)
-SourceServerID <String>
The ID of the Source Server for this Replication Configuration.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-StagingAreaSubnetId <String>
The subnet to be used by the replication staging area.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StagingAreaTag <Hashtable>
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStagingAreaTags
-UseDedicatedReplicationServer <Boolean>
Whether to use a dedicated Replication Server in the replication staging area.
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.Drs.Model.UpdateReplicationConfigurationResponse
This cmdlet returns an Amazon.Drs.Model.UpdateReplicationConfigurationResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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