/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the docdb-2014-10-31.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.DocDB.Model { /// /// Container for the parameters to the ModifyDBCluster operation. /// 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. /// public partial class ModifyDBClusterRequest : AmazonDocDBRequest { private bool? _allowMajorVersionUpgrade; private bool? _applyImmediately; private int? _backupRetentionPeriod; private CloudwatchLogsExportConfiguration _cloudwatchLogsExportConfiguration; private string _dbClusterIdentifier; private string _dbClusterParameterGroupName; private bool? _deletionProtection; private string _engineVersion; private string _masterUserPassword; private string _newDBClusterIdentifier; private int? _port; private string _preferredBackupWindow; private string _preferredMaintenanceWindow; private List _vpcSecurityGroupIds = new List(); /// /// Gets and sets the property 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. /// /// public bool AllowMajorVersionUpgrade { get { return this._allowMajorVersionUpgrade.GetValueOrDefault(); } set { this._allowMajorVersionUpgrade = value; } } // Check to see if AllowMajorVersionUpgrade property is set internal bool IsSetAllowMajorVersionUpgrade() { return this._allowMajorVersionUpgrade.HasValue; } /// /// Gets and sets the property 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 /// /// public bool ApplyImmediately { get { return this._applyImmediately.GetValueOrDefault(); } set { this._applyImmediately = value; } } // Check to see if ApplyImmediately property is set internal bool IsSetApplyImmediately() { return this._applyImmediately.HasValue; } /// /// Gets and sets the property BackupRetentionPeriod. /// /// The number of days for which automated backups are retained. You must specify a minimum /// value of 1. /// /// /// /// Default: 1 /// /// /// /// Constraints: /// ///
  • /// /// Must be a value from 1 to 35. /// ///
///
public int BackupRetentionPeriod { get { return this._backupRetentionPeriod.GetValueOrDefault(); } set { this._backupRetentionPeriod = value; } } // Check to see if BackupRetentionPeriod property is set internal bool IsSetBackupRetentionPeriod() { return this._backupRetentionPeriod.HasValue; } /// /// Gets and sets the property CloudwatchLogsExportConfiguration. /// /// The configuration setting for the log types to be enabled for export to Amazon CloudWatch /// Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes /// arrays determine which logs are exported (or not exported) to CloudWatch Logs. /// /// public CloudwatchLogsExportConfiguration CloudwatchLogsExportConfiguration { get { return this._cloudwatchLogsExportConfiguration; } set { this._cloudwatchLogsExportConfiguration = value; } } // Check to see if CloudwatchLogsExportConfiguration property is set internal bool IsSetCloudwatchLogsExportConfiguration() { return this._cloudwatchLogsExportConfiguration != null; } /// /// Gets and sets the property DBClusterIdentifier. /// /// The cluster identifier for the cluster that is being modified. This parameter is not /// case sensitive. /// /// /// /// Constraints: /// ///
  • /// /// Must match the identifier of an existing DBCluster. /// ///
///
[AWSProperty(Required=true)] public string DBClusterIdentifier { get { return this._dbClusterIdentifier; } set { this._dbClusterIdentifier = value; } } // Check to see if DBClusterIdentifier property is set internal bool IsSetDBClusterIdentifier() { return this._dbClusterIdentifier != null; } /// /// Gets and sets the property DBClusterParameterGroupName. /// /// The name of the cluster parameter group to use for the cluster. /// /// public string DBClusterParameterGroupName { get { return this._dbClusterParameterGroupName; } set { this._dbClusterParameterGroupName = value; } } // Check to see if DBClusterParameterGroupName property is set internal bool IsSetDBClusterParameterGroupName() { return this._dbClusterParameterGroupName != null; } /// /// Gets and sets the property 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. /// /// public bool DeletionProtection { get { return this._deletionProtection.GetValueOrDefault(); } set { this._deletionProtection = value; } } // Check to see if DeletionProtection property is set internal bool IsSetDeletionProtection() { return this._deletionProtection.HasValue; } /// /// Gets and sets the property 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" /// /// /// public string EngineVersion { get { return this._engineVersion; } set { this._engineVersion = value; } } // Check to see if EngineVersion property is set internal bool IsSetEngineVersion() { return this._engineVersion != null; } /// /// Gets and sets the property 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. /// /// public string MasterUserPassword { get { return this._masterUserPassword; } set { this._masterUserPassword = value; } } // Check to see if MasterUserPassword property is set internal bool IsSetMasterUserPassword() { return this._masterUserPassword != null; } /// /// Gets and sets the property NewDBClusterIdentifier. /// /// The new cluster identifier for the cluster when renaming a cluster. This value is /// stored as a lowercase string. /// /// /// /// Constraints: /// ///
  • /// /// Must contain from 1 to 63 letters, numbers, or hyphens. /// ///
  • /// /// The first character must be a letter. /// ///
  • /// /// Cannot end with a hyphen or contain two consecutive hyphens. /// ///
/// /// Example: my-cluster2 /// ///
public string NewDBClusterIdentifier { get { return this._newDBClusterIdentifier; } set { this._newDBClusterIdentifier = value; } } // Check to see if NewDBClusterIdentifier property is set internal bool IsSetNewDBClusterIdentifier() { return this._newDBClusterIdentifier != null; } /// /// Gets and sets the property 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. /// /// public int Port { get { return this._port.GetValueOrDefault(); } set { this._port = value; } } // Check to see if Port property is set internal bool IsSetPort() { return this._port.HasValue; } /// /// Gets and sets the property 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: /// ///
  • /// /// Must be in the format hh24:mi-hh24:mi. /// ///
  • /// /// Must be in Universal Coordinated Time (UTC). /// ///
  • /// /// Must not conflict with the preferred maintenance window. /// ///
  • /// /// Must be at least 30 minutes. /// ///
///
public string PreferredBackupWindow { get { return this._preferredBackupWindow; } set { this._preferredBackupWindow = value; } } // Check to see if PreferredBackupWindow property is set internal bool IsSetPreferredBackupWindow() { return this._preferredBackupWindow != null; } /// /// Gets and sets the property PreferredMaintenanceWindow. /// /// The weekly time range during which system maintenance can occur, in Universal Coordinated /// Time (UTC). /// /// /// /// Format: ddd:hh24:mi-ddd:hh24:mi /// /// /// /// The 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, Sun /// /// /// /// Constraints: Minimum 30-minute window. /// /// public string PreferredMaintenanceWindow { get { return this._preferredMaintenanceWindow; } set { this._preferredMaintenanceWindow = value; } } // Check to see if PreferredMaintenanceWindow property is set internal bool IsSetPreferredMaintenanceWindow() { return this._preferredMaintenanceWindow != null; } /// /// Gets and sets the property VpcSecurityGroupIds. /// /// A list of virtual private cloud (VPC) security groups that the cluster will belong /// to. /// /// public List VpcSecurityGroupIds { get { return this._vpcSecurityGroupIds; } set { this._vpcSecurityGroupIds = value; } } // Check to see if VpcSecurityGroupIds property is set internal bool IsSetVpcSecurityGroupIds() { return this._vpcSecurityGroupIds != null && this._vpcSecurityGroupIds.Count > 0; } } }