/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.DatabaseMigrationService;
using Amazon.DatabaseMigrationService.Model;
namespace Amazon.PowerShell.Cmdlets.DMS
{
///
/// 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.
///
///
[Cmdlet("Edit", "DMSReplicationConfig", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.DatabaseMigrationService.Model.ReplicationConfig")]
[AWSCmdlet("Calls the AWS Database Migration Service ModifyReplicationConfig API operation.", Operation = new[] {"ModifyReplicationConfig"}, SelectReturnType = typeof(Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigResponse))]
[AWSCmdletOutput("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."
)]
public partial class EditDMSReplicationConfigCmdlet : AmazonDatabaseMigrationServiceClientCmdlet, IExecutor
{
#region Parameter ComputeConfig_AvailabilityZone
///
///
/// 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
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ComputeConfig_AvailabilityZone { get; set; }
#endregion
#region Parameter ComputeConfig_DnsNameServer
///
///
/// 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"
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ComputeConfig_DnsNameServers")]
public System.String ComputeConfig_DnsNameServer { get; set; }
#endregion
#region Parameter ComputeConfig_KmsKeyId
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ComputeConfig_KmsKeyId { get; set; }
#endregion
#region Parameter ComputeConfig_MaxCapacityUnit
///
///
/// 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 2 DCUs
/// as the minimum value allowed. The list of valid DCU values includes 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ComputeConfig_MaxCapacityUnits")]
public System.Int32? ComputeConfig_MaxCapacityUnit { get; set; }
#endregion
#region Parameter ComputeConfig_MinCapacityUnit
///
///
/// 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 2 DCUs
/// as the minimum value allowed. The list of valid DCU values includes 2, 4, 8, 16, 32,
/// 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS
/// Serverless is 2. 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, 2.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ComputeConfig_MinCapacityUnits")]
public System.Int32? ComputeConfig_MinCapacityUnit { get; set; }
#endregion
#region Parameter ComputeConfig_MultiAZ
///
///
/// 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
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? ComputeConfig_MultiAZ { get; set; }
#endregion
#region Parameter ComputeConfig_PreferredMaintenanceWindow
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ComputeConfig_PreferredMaintenanceWindow { get; set; }
#endregion
#region Parameter ReplicationConfigArn
///
///
/// The Amazon Resource Name of the replication to modify.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ReplicationConfigArn { get; set; }
#endregion
#region Parameter ReplicationConfigIdentifier
///
///
/// The new replication config to apply to the replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ReplicationConfigIdentifier { get; set; }
#endregion
#region Parameter ReplicationSetting
///
///
/// The settings for the replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ReplicationSettings")]
public System.String ReplicationSetting { get; set; }
#endregion
#region Parameter ComputeConfig_ReplicationSubnetGroupId
///
///
/// Specifies a subnet group identifier to associate with the DMS Serverless replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ComputeConfig_ReplicationSubnetGroupId { get; set; }
#endregion
#region Parameter ReplicationType
///
///
/// The type of replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.DatabaseMigrationService.MigrationTypeValue")]
public Amazon.DatabaseMigrationService.MigrationTypeValue ReplicationType { get; set; }
#endregion
#region Parameter SourceEndpointArn
///
///
/// The Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication
/// configuration.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceEndpointArn { get; set; }
#endregion
#region Parameter SupplementalSetting
///
///
/// Additional settings for the replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("SupplementalSettings")]
public System.String SupplementalSetting { get; set; }
#endregion
#region Parameter TableMapping
///
///
/// Table mappings specified in the replication.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("TableMappings")]
public System.String TableMapping { get; set; }
#endregion
#region Parameter TargetEndpointArn
///
///
/// The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication
/// configuration.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetEndpointArn { get; set; }
#endregion
#region Parameter ComputeConfig_VpcSecurityGroupId
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ComputeConfig_VpcSecurityGroupIds")]
public System.String[] ComputeConfig_VpcSecurityGroupId { get; set; }
#endregion
#region Parameter Select
///
/// 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.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "ReplicationConfig";
#endregion
#region Parameter PassThru
///
/// 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.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ReplicationConfigArn' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.ReplicationConfigArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-DMSReplicationConfig (ModifyReplicationConfig)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ReplicationConfigArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ComputeConfig_AvailabilityZone = this.ComputeConfig_AvailabilityZone;
context.ComputeConfig_DnsNameServer = this.ComputeConfig_DnsNameServer;
context.ComputeConfig_KmsKeyId = this.ComputeConfig_KmsKeyId;
context.ComputeConfig_MaxCapacityUnit = this.ComputeConfig_MaxCapacityUnit;
context.ComputeConfig_MinCapacityUnit = this.ComputeConfig_MinCapacityUnit;
context.ComputeConfig_MultiAZ = this.ComputeConfig_MultiAZ;
context.ComputeConfig_PreferredMaintenanceWindow = this.ComputeConfig_PreferredMaintenanceWindow;
context.ComputeConfig_ReplicationSubnetGroupId = this.ComputeConfig_ReplicationSubnetGroupId;
if (this.ComputeConfig_VpcSecurityGroupId != null)
{
context.ComputeConfig_VpcSecurityGroupId = new List(this.ComputeConfig_VpcSecurityGroupId);
}
context.ReplicationConfigArn = this.ReplicationConfigArn;
#if MODULAR
if (this.ReplicationConfigArn == null && ParameterWasBound(nameof(this.ReplicationConfigArn)))
{
WriteWarning("You are passing $null as a value for parameter ReplicationConfigArn which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ReplicationConfigIdentifier = this.ReplicationConfigIdentifier;
context.ReplicationSetting = this.ReplicationSetting;
context.ReplicationType = this.ReplicationType;
context.SourceEndpointArn = this.SourceEndpointArn;
context.SupplementalSetting = this.SupplementalSetting;
context.TableMapping = this.TableMapping;
context.TargetEndpointArn = this.TargetEndpointArn;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigRequest();
// populate ComputeConfig
var requestComputeConfigIsNull = true;
request.ComputeConfig = new Amazon.DatabaseMigrationService.Model.ComputeConfig();
System.String requestComputeConfig_computeConfig_AvailabilityZone = null;
if (cmdletContext.ComputeConfig_AvailabilityZone != null)
{
requestComputeConfig_computeConfig_AvailabilityZone = cmdletContext.ComputeConfig_AvailabilityZone;
}
if (requestComputeConfig_computeConfig_AvailabilityZone != null)
{
request.ComputeConfig.AvailabilityZone = requestComputeConfig_computeConfig_AvailabilityZone;
requestComputeConfigIsNull = false;
}
System.String requestComputeConfig_computeConfig_DnsNameServer = null;
if (cmdletContext.ComputeConfig_DnsNameServer != null)
{
requestComputeConfig_computeConfig_DnsNameServer = cmdletContext.ComputeConfig_DnsNameServer;
}
if (requestComputeConfig_computeConfig_DnsNameServer != null)
{
request.ComputeConfig.DnsNameServers = requestComputeConfig_computeConfig_DnsNameServer;
requestComputeConfigIsNull = false;
}
System.String requestComputeConfig_computeConfig_KmsKeyId = null;
if (cmdletContext.ComputeConfig_KmsKeyId != null)
{
requestComputeConfig_computeConfig_KmsKeyId = cmdletContext.ComputeConfig_KmsKeyId;
}
if (requestComputeConfig_computeConfig_KmsKeyId != null)
{
request.ComputeConfig.KmsKeyId = requestComputeConfig_computeConfig_KmsKeyId;
requestComputeConfigIsNull = false;
}
System.Int32? requestComputeConfig_computeConfig_MaxCapacityUnit = null;
if (cmdletContext.ComputeConfig_MaxCapacityUnit != null)
{
requestComputeConfig_computeConfig_MaxCapacityUnit = cmdletContext.ComputeConfig_MaxCapacityUnit.Value;
}
if (requestComputeConfig_computeConfig_MaxCapacityUnit != null)
{
request.ComputeConfig.MaxCapacityUnits = requestComputeConfig_computeConfig_MaxCapacityUnit.Value;
requestComputeConfigIsNull = false;
}
System.Int32? requestComputeConfig_computeConfig_MinCapacityUnit = null;
if (cmdletContext.ComputeConfig_MinCapacityUnit != null)
{
requestComputeConfig_computeConfig_MinCapacityUnit = cmdletContext.ComputeConfig_MinCapacityUnit.Value;
}
if (requestComputeConfig_computeConfig_MinCapacityUnit != null)
{
request.ComputeConfig.MinCapacityUnits = requestComputeConfig_computeConfig_MinCapacityUnit.Value;
requestComputeConfigIsNull = false;
}
System.Boolean? requestComputeConfig_computeConfig_MultiAZ = null;
if (cmdletContext.ComputeConfig_MultiAZ != null)
{
requestComputeConfig_computeConfig_MultiAZ = cmdletContext.ComputeConfig_MultiAZ.Value;
}
if (requestComputeConfig_computeConfig_MultiAZ != null)
{
request.ComputeConfig.MultiAZ = requestComputeConfig_computeConfig_MultiAZ.Value;
requestComputeConfigIsNull = false;
}
System.String requestComputeConfig_computeConfig_PreferredMaintenanceWindow = null;
if (cmdletContext.ComputeConfig_PreferredMaintenanceWindow != null)
{
requestComputeConfig_computeConfig_PreferredMaintenanceWindow = cmdletContext.ComputeConfig_PreferredMaintenanceWindow;
}
if (requestComputeConfig_computeConfig_PreferredMaintenanceWindow != null)
{
request.ComputeConfig.PreferredMaintenanceWindow = requestComputeConfig_computeConfig_PreferredMaintenanceWindow;
requestComputeConfigIsNull = false;
}
System.String requestComputeConfig_computeConfig_ReplicationSubnetGroupId = null;
if (cmdletContext.ComputeConfig_ReplicationSubnetGroupId != null)
{
requestComputeConfig_computeConfig_ReplicationSubnetGroupId = cmdletContext.ComputeConfig_ReplicationSubnetGroupId;
}
if (requestComputeConfig_computeConfig_ReplicationSubnetGroupId != null)
{
request.ComputeConfig.ReplicationSubnetGroupId = requestComputeConfig_computeConfig_ReplicationSubnetGroupId;
requestComputeConfigIsNull = false;
}
List requestComputeConfig_computeConfig_VpcSecurityGroupId = null;
if (cmdletContext.ComputeConfig_VpcSecurityGroupId != null)
{
requestComputeConfig_computeConfig_VpcSecurityGroupId = cmdletContext.ComputeConfig_VpcSecurityGroupId;
}
if (requestComputeConfig_computeConfig_VpcSecurityGroupId != null)
{
request.ComputeConfig.VpcSecurityGroupIds = requestComputeConfig_computeConfig_VpcSecurityGroupId;
requestComputeConfigIsNull = false;
}
// determine if request.ComputeConfig should be set to null
if (requestComputeConfigIsNull)
{
request.ComputeConfig = null;
}
if (cmdletContext.ReplicationConfigArn != null)
{
request.ReplicationConfigArn = cmdletContext.ReplicationConfigArn;
}
if (cmdletContext.ReplicationConfigIdentifier != null)
{
request.ReplicationConfigIdentifier = cmdletContext.ReplicationConfigIdentifier;
}
if (cmdletContext.ReplicationSetting != null)
{
request.ReplicationSettings = cmdletContext.ReplicationSetting;
}
if (cmdletContext.ReplicationType != null)
{
request.ReplicationType = cmdletContext.ReplicationType;
}
if (cmdletContext.SourceEndpointArn != null)
{
request.SourceEndpointArn = cmdletContext.SourceEndpointArn;
}
if (cmdletContext.SupplementalSetting != null)
{
request.SupplementalSettings = cmdletContext.SupplementalSetting;
}
if (cmdletContext.TableMapping != null)
{
request.TableMappings = cmdletContext.TableMapping;
}
if (cmdletContext.TargetEndpointArn != null)
{
request.TargetEndpointArn = cmdletContext.TargetEndpointArn;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigResponse CallAWSServiceOperation(IAmazonDatabaseMigrationService client, Amazon.DatabaseMigrationService.Model.ModifyReplicationConfigRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Database Migration Service", "ModifyReplicationConfig");
try
{
#if DESKTOP
return client.ModifyReplicationConfig(request);
#elif CORECLR
return client.ModifyReplicationConfigAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String ComputeConfig_AvailabilityZone { get; set; }
public System.String ComputeConfig_DnsNameServer { get; set; }
public System.String ComputeConfig_KmsKeyId { get; set; }
public System.Int32? ComputeConfig_MaxCapacityUnit { get; set; }
public System.Int32? ComputeConfig_MinCapacityUnit { get; set; }
public System.Boolean? ComputeConfig_MultiAZ { get; set; }
public System.String ComputeConfig_PreferredMaintenanceWindow { get; set; }
public System.String ComputeConfig_ReplicationSubnetGroupId { get; set; }
public List ComputeConfig_VpcSecurityGroupId { get; set; }
public System.String ReplicationConfigArn { get; set; }
public System.String ReplicationConfigIdentifier { get; set; }
public System.String ReplicationSetting { get; set; }
public Amazon.DatabaseMigrationService.MigrationTypeValue ReplicationType { get; set; }
public System.String SourceEndpointArn { get; set; }
public System.String SupplementalSetting { get; set; }
public System.String TableMapping { get; set; }
public System.String TargetEndpointArn { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ReplicationConfig;
}
}
}