/******************************************************************************* * 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.DocDB; using Amazon.DocDB.Model; namespace Amazon.PowerShell.Cmdlets.DOC { /// /// Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database /// configuration parameters by specifying these parameters and the new values in the /// request. /// [Cmdlet("Edit", "DOCDBCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DocDB.Model.DBCluster")] [AWSCmdlet("Calls the Amazon DocumentDB (with MongoDB compatibility) ModifyDBCluster API operation.", Operation = new[] {"ModifyDBCluster"}, SelectReturnType = typeof(Amazon.DocDB.Model.ModifyDBClusterResponse))] [AWSCmdletOutput("Amazon.DocDB.Model.DBCluster or Amazon.DocDB.Model.ModifyDBClusterResponse", "This cmdlet returns an Amazon.DocDB.Model.DBCluster object.", "The service call response (type Amazon.DocDB.Model.ModifyDBClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EditDOCDBClusterCmdlet : AmazonDocDBClientCmdlet, IExecutor { #region Parameter AllowMajorVersionUpgrade /// /// /// A value that indicates whether major version upgrades are allowed.Constraints: You must allow major version upgrades when specifying a value for the /// EngineVersion parameter that is a different major version than the DB /// cluster's current version. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? AllowMajorVersionUpgrade { get; set; } #endregion #region Parameter ApplyImmediately /// /// /// A value that specifies whether the changes in this request and any pending changes /// are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow /// setting for the cluster. If this parameter is set to false, changes to /// the cluster are applied during the next maintenance window.The ApplyImmediately parameter affects only the NewDBClusterIdentifier /// and MasterUserPassword values. If you set this parameter value to false, /// the changes to the NewDBClusterIdentifier and MasterUserPassword /// values are applied during the next maintenance window. All other changes are applied /// immediately, regardless of the value of the ApplyImmediately parameter.Default: false /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ApplyImmediately { get; set; } #endregion #region Parameter BackupRetentionPeriod /// /// /// The number of days for which automated backups are retained. You must specify a minimum /// value of 1.Default: 1Constraints: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? BackupRetentionPeriod { get; set; } #endregion #region Parameter DBClusterIdentifier /// /// /// The cluster identifier for the cluster that is being modified. This parameter is not /// case sensitive.Constraints: /// /// #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 DBClusterIdentifier { get; set; } #endregion #region Parameter DBClusterParameterGroupName /// /// /// The name of the cluster parameter group to use for the cluster. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DBClusterParameterGroupName { get; set; } #endregion #region Parameter DeletionProtection /// /// /// Specifies whether this cluster can be deleted. If DeletionProtection /// is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection /// is disabled. DeletionProtection protects clusters from being accidentally /// deleted. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? DeletionProtection { get; set; } #endregion #region Parameter CloudwatchLogsExportConfiguration_DisableLogType /// /// /// The list of log types to disable. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CloudwatchLogsExportConfiguration_DisableLogTypes")] public System.String[] CloudwatchLogsExportConfiguration_DisableLogType { get; set; } #endregion #region Parameter CloudwatchLogsExportConfiguration_EnableLogType /// /// /// The list of log types to enable. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CloudwatchLogsExportConfiguration_EnableLogTypes")] public System.String[] CloudwatchLogsExportConfiguration_EnableLogType { get; set; } #endregion #region Parameter EngineVersion /// /// /// The version number of the database engine to which you want to upgrade. Changing this /// parameter results in an outage. The change is applied during the next maintenance /// window unless ApplyImmediately is enabled.To list all of the available engine versions for Amazon DocumentDB use the following /// command:aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion" /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EngineVersion { get; set; } #endregion #region Parameter MasterUserPassword /// /// /// The password for the master database user. This password can contain any printable /// ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).Constraints: Must contain from 8 to 100 characters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String MasterUserPassword { get; set; } #endregion #region Parameter NewDBClusterIdentifier /// /// /// The new cluster identifier for the cluster when renaming a cluster. This value is /// stored as a lowercase string.Constraints:Example: my-cluster2 /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NewDBClusterIdentifier { get; set; } #endregion #region Parameter Port /// /// /// The port number on which the cluster accepts connections.Constraints: Must be a value from 1150 to 65535. Default: The same port as the original cluster. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Port { get; set; } #endregion #region Parameter PreferredBackupWindow /// /// /// The daily time range during which automated backups are created if automated backups /// are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time /// for each Amazon Web Services Region. Constraints: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredBackupWindow { get; set; } #endregion #region Parameter PreferredMaintenanceWindow /// /// /// The weekly time range during which system maintenance can occur, in Universal Coordinated /// Time (UTC).Format: ddd:hh24:mi-ddd:hh24:miThe default is a 30-minute window selected at random from an 8-hour block of time /// for each Amazon Web Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, SunConstraints: Minimum 30-minute window. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredMaintenanceWindow { get; set; } #endregion #region Parameter VpcSecurityGroupId /// /// /// A list of virtual private cloud (VPC) security groups that the cluster will belong /// to. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("VpcSecurityGroupIds")] public System.String[] VpcSecurityGroupId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'DBCluster'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDB.Model.ModifyDBClusterResponse). /// Specifying the name of a property of type Amazon.DocDB.Model.ModifyDBClusterResponse 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; } = "DBCluster"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DBClusterIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DBClusterIdentifier' 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.DBClusterIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-DOCDBCluster (ModifyDBCluster)")) { 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.DBClusterIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AllowMajorVersionUpgrade = this.AllowMajorVersionUpgrade; context.ApplyImmediately = this.ApplyImmediately; context.BackupRetentionPeriod = this.BackupRetentionPeriod; if (this.CloudwatchLogsExportConfiguration_DisableLogType != null) { context.CloudwatchLogsExportConfiguration_DisableLogType = new List(this.CloudwatchLogsExportConfiguration_DisableLogType); } if (this.CloudwatchLogsExportConfiguration_EnableLogType != null) { context.CloudwatchLogsExportConfiguration_EnableLogType = new List(this.CloudwatchLogsExportConfiguration_EnableLogType); } context.DBClusterIdentifier = this.DBClusterIdentifier; #if MODULAR if (this.DBClusterIdentifier == null && ParameterWasBound(nameof(this.DBClusterIdentifier))) { WriteWarning("You are passing $null as a value for parameter DBClusterIdentifier 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.DBClusterParameterGroupName = this.DBClusterParameterGroupName; context.DeletionProtection = this.DeletionProtection; context.EngineVersion = this.EngineVersion; context.MasterUserPassword = this.MasterUserPassword; context.NewDBClusterIdentifier = this.NewDBClusterIdentifier; context.Port = this.Port; context.PreferredBackupWindow = this.PreferredBackupWindow; context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow; if (this.VpcSecurityGroupId != null) { context.VpcSecurityGroupId = new List(this.VpcSecurityGroupId); } // 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.DocDB.Model.ModifyDBClusterRequest(); if (cmdletContext.AllowMajorVersionUpgrade != null) { request.AllowMajorVersionUpgrade = cmdletContext.AllowMajorVersionUpgrade.Value; } if (cmdletContext.ApplyImmediately != null) { request.ApplyImmediately = cmdletContext.ApplyImmediately.Value; } if (cmdletContext.BackupRetentionPeriod != null) { request.BackupRetentionPeriod = cmdletContext.BackupRetentionPeriod.Value; } // populate CloudwatchLogsExportConfiguration var requestCloudwatchLogsExportConfigurationIsNull = true; request.CloudwatchLogsExportConfiguration = new Amazon.DocDB.Model.CloudwatchLogsExportConfiguration(); List requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_DisableLogType = null; if (cmdletContext.CloudwatchLogsExportConfiguration_DisableLogType != null) { requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_DisableLogType = cmdletContext.CloudwatchLogsExportConfiguration_DisableLogType; } if (requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_DisableLogType != null) { request.CloudwatchLogsExportConfiguration.DisableLogTypes = requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_DisableLogType; requestCloudwatchLogsExportConfigurationIsNull = false; } List requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_EnableLogType = null; if (cmdletContext.CloudwatchLogsExportConfiguration_EnableLogType != null) { requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_EnableLogType = cmdletContext.CloudwatchLogsExportConfiguration_EnableLogType; } if (requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_EnableLogType != null) { request.CloudwatchLogsExportConfiguration.EnableLogTypes = requestCloudwatchLogsExportConfiguration_cloudwatchLogsExportConfiguration_EnableLogType; requestCloudwatchLogsExportConfigurationIsNull = false; } // determine if request.CloudwatchLogsExportConfiguration should be set to null if (requestCloudwatchLogsExportConfigurationIsNull) { request.CloudwatchLogsExportConfiguration = null; } if (cmdletContext.DBClusterIdentifier != null) { request.DBClusterIdentifier = cmdletContext.DBClusterIdentifier; } if (cmdletContext.DBClusterParameterGroupName != null) { request.DBClusterParameterGroupName = cmdletContext.DBClusterParameterGroupName; } if (cmdletContext.DeletionProtection != null) { request.DeletionProtection = cmdletContext.DeletionProtection.Value; } if (cmdletContext.EngineVersion != null) { request.EngineVersion = cmdletContext.EngineVersion; } if (cmdletContext.MasterUserPassword != null) { request.MasterUserPassword = cmdletContext.MasterUserPassword; } if (cmdletContext.NewDBClusterIdentifier != null) { request.NewDBClusterIdentifier = cmdletContext.NewDBClusterIdentifier; } if (cmdletContext.Port != null) { request.Port = cmdletContext.Port.Value; } if (cmdletContext.PreferredBackupWindow != null) { request.PreferredBackupWindow = cmdletContext.PreferredBackupWindow; } if (cmdletContext.PreferredMaintenanceWindow != null) { request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow; } if (cmdletContext.VpcSecurityGroupId != null) { request.VpcSecurityGroupIds = cmdletContext.VpcSecurityGroupId; } 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.DocDB.Model.ModifyDBClusterResponse CallAWSServiceOperation(IAmazonDocDB client, Amazon.DocDB.Model.ModifyDBClusterRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon DocumentDB (with MongoDB compatibility)", "ModifyDBCluster"); try { #if DESKTOP return client.ModifyDBCluster(request); #elif CORECLR return client.ModifyDBClusterAsync(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.Boolean? AllowMajorVersionUpgrade { get; set; } public System.Boolean? ApplyImmediately { get; set; } public System.Int32? BackupRetentionPeriod { get; set; } public List CloudwatchLogsExportConfiguration_DisableLogType { get; set; } public List CloudwatchLogsExportConfiguration_EnableLogType { get; set; } public System.String DBClusterIdentifier { get; set; } public System.String DBClusterParameterGroupName { get; set; } public System.Boolean? DeletionProtection { get; set; } public System.String EngineVersion { get; set; } public System.String MasterUserPassword { get; set; } public System.String NewDBClusterIdentifier { get; set; } public System.Int32? Port { get; set; } public System.String PreferredBackupWindow { get; set; } public System.String PreferredMaintenanceWindow { get; set; } public List VpcSecurityGroupId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.DBCluster; } } }