/*
* 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 rds-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.RDS.Model
{
///
/// Container for the parameters to the ModifyDBCluster operation.
/// Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You
/// can change one or more settings by specifying these parameters and the new values
/// in the request.
///
///
///
/// For more information on Amazon Aurora DB clusters, see
/// What is Amazon Aurora? in the Amazon Aurora User Guide.
///
///
///
/// For more information on Multi-AZ DB clusters, see
/// Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
///
///
public partial class ModifyDBClusterRequest : AmazonRDSRequest
{
private int? _allocatedStorage;
private bool? _allowEngineModeChange;
private bool? _allowMajorVersionUpgrade;
private bool? _applyImmediately;
private bool? _autoMinorVersionUpgrade;
private long? _backtrackWindow;
private int? _backupRetentionPeriod;
private CloudwatchLogsExportConfiguration _cloudwatchLogsExportConfiguration;
private bool? _copyTagsToSnapshot;
private string _dbClusterIdentifier;
private string _dbClusterInstanceClass;
private string _dbClusterParameterGroupName;
private string _dbInstanceParameterGroupName;
private bool? _deletionProtection;
private string _domain;
private string _domainIAMRoleName;
private bool? _enableGlobalWriteForwarding;
private bool? _enableHttpEndpoint;
private bool? _enableIAMDatabaseAuthentication;
private bool? _enablePerformanceInsights;
private string _engineMode;
private string _engineVersion;
private int? _iops;
private bool? _manageMasterUserPassword;
private string _masterUserPassword;
private string _masterUserSecretKmsKeyId;
private int? _monitoringInterval;
private string _monitoringRoleArn;
private string _networkType;
private string _newDBClusterIdentifier;
private string _optionGroupName;
private string _performanceInsightsKMSKeyId;
private int? _performanceInsightsRetentionPeriod;
private int? _port;
private string _preferredBackupWindow;
private string _preferredMaintenanceWindow;
private bool? _rotateMasterUserPassword;
private ScalingConfiguration _scalingConfiguration;
private ServerlessV2ScalingConfiguration _serverlessV2ScalingConfiguration;
private string _storageType;
private List _vpcSecurityGroupIds = new List();
///
/// Gets and sets the property AllocatedStorage.
///
/// The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ
/// DB cluster.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public int AllocatedStorage
{
get { return this._allocatedStorage.GetValueOrDefault(); }
set { this._allocatedStorage = value; }
}
// Check to see if AllocatedStorage property is set
internal bool IsSetAllocatedStorage()
{
return this._allocatedStorage.HasValue;
}
///
/// Gets and sets the property AllowEngineModeChange.
///
/// Specifies whether engine mode changes from serverless
to provisioned
/// are allowed.
///
///
///
/// Valid for Cluster Type: Aurora Serverless v1 DB clusters only
///
///
///
/// Constraints:
///
/// -
///
/// You must allow engine mode changes when specifying a different value for the
EngineMode
/// parameter from the DB cluster's current engine mode.
///
///
///
public bool AllowEngineModeChange
{
get { return this._allowEngineModeChange.GetValueOrDefault(); }
set { this._allowEngineModeChange = value; }
}
// Check to see if AllowEngineModeChange property is set
internal bool IsSetAllowEngineModeChange()
{
return this._allowEngineModeChange.HasValue;
}
///
/// Gets and sets the property AllowMajorVersionUpgrade.
///
/// Specifies whether major version upgrades are allowed.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
///
/// 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.
///
/// Specifies whether the modifications in this request and any pending modifications
/// are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow
/// setting for the DB cluster. If this parameter is disabled, changes to the DB cluster
/// are applied during the next maintenance window.
///
///
///
/// Most modifications can be applied immediately or during the next scheduled maintenance
/// window. Some modifications, such as turning on deletion protection and changing the
/// master password, are applied immediately—regardless of when you choose to apply them.
///
///
///
/// By default, this parameter is disabled.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
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 AutoMinorVersionUpgrade.
///
/// Specifies whether minor engine upgrades are applied automatically to the DB cluster
/// during the maintenance window. By default, minor engine upgrades are applied automatically.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public bool AutoMinorVersionUpgrade
{
get { return this._autoMinorVersionUpgrade.GetValueOrDefault(); }
set { this._autoMinorVersionUpgrade = value; }
}
// Check to see if AutoMinorVersionUpgrade property is set
internal bool IsSetAutoMinorVersionUpgrade()
{
return this._autoMinorVersionUpgrade.HasValue;
}
///
/// Gets and sets the property BacktrackWindow.
///
/// The target backtrack window, in seconds. To disable backtracking, set this value to
/// 0
.
///
///
///
/// Valid for Cluster Type: Aurora MySQL DB clusters only
///
///
///
/// Default: 0
///
///
///
/// Constraints:
///
/// -
///
/// If specified, this value must be set to a number from 0 to 259,200 (72 hours).
///
///
///
public long BacktrackWindow
{
get { return this._backtrackWindow.GetValueOrDefault(); }
set { this._backtrackWindow = value; }
}
// Check to see if BacktrackWindow property is set
internal bool IsSetBacktrackWindow()
{
return this._backtrackWindow.HasValue;
}
///
/// Gets and sets the property BackupRetentionPeriod.
///
/// The number of days for which automated backups are retained. Specify a minimum value
/// of 1
.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// 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 CloudWatch
/// Logs for a specific DB cluster.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// The following values are valid for each DB engine:
///
/// -
///
/// Aurora MySQL -
audit | error | general | slowquery
///
/// -
///
/// Aurora PostgreSQL -
postgresql
///
/// -
///
/// RDS for MySQL -
error | general | slowquery
///
/// -
///
/// RDS for PostgreSQL -
postgresql | upgrade
///
///
///
/// For more information about exporting CloudWatch Logs for Amazon RDS, see
/// Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
///
///
///
/// For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing
/// Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
///
///
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 CopyTagsToSnapshot.
///
/// Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
/// The default is not to copy them.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
public bool CopyTagsToSnapshot
{
get { return this._copyTagsToSnapshot.GetValueOrDefault(); }
set { this._copyTagsToSnapshot = value; }
}
// Check to see if CopyTagsToSnapshot property is set
internal bool IsSetCopyTagsToSnapshot()
{
return this._copyTagsToSnapshot.HasValue;
}
///
/// Gets and sets the property DBClusterIdentifier.
///
/// The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// Constraints:
///
/// -
///
/// Must match the identifier of an existing DB cluster.
///
///
///
[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 DBClusterInstanceClass.
///
/// The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for
/// example db.m6gd.xlarge
. Not all DB instance classes are available in
/// all Amazon Web Services Regions, or for all database engines.
///
///
///
/// For the full list of DB instance classes and availability for your engine, see
/// DB Instance Class in the Amazon RDS User Guide.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public string DBClusterInstanceClass
{
get { return this._dbClusterInstanceClass; }
set { this._dbClusterInstanceClass = value; }
}
// Check to see if DBClusterInstanceClass property is set
internal bool IsSetDBClusterInstanceClass()
{
return this._dbClusterInstanceClass != null;
}
///
/// Gets and sets the property DBClusterParameterGroupName.
///
/// The name of the DB cluster parameter group to use for the DB cluster.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
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 DBInstanceParameterGroupName.
///
/// The name of the DB parameter group to apply to all instances of the DB cluster.
///
///
///
/// When you apply a parameter group using the DBInstanceParameterGroupName
/// parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are
/// applied immediately rather than during the next maintenance window.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
///
/// Default: The existing name setting
///
///
///
/// Constraints:
///
/// -
///
/// The DB parameter group must be in the same DB parameter group family as this DB cluster.
///
///
-
///
/// The
DBInstanceParameterGroupName
parameter is valid in combination with
/// the AllowMajorVersionUpgrade
parameter for a major version upgrade only.
///
///
///
public string DBInstanceParameterGroupName
{
get { return this._dbInstanceParameterGroupName; }
set { this._dbInstanceParameterGroupName = value; }
}
// Check to see if DBInstanceParameterGroupName property is set
internal bool IsSetDBInstanceParameterGroupName()
{
return this._dbInstanceParameterGroupName != null;
}
///
/// Gets and sets the property DeletionProtection.
///
/// Specifies whether the DB cluster has deletion protection enabled. The database can't
/// be deleted when deletion protection is enabled. By default, deletion protection isn't
/// enabled.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
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 Domain.
///
/// The Active Directory directory ID to move the DB cluster to. Specify none
/// to remove the cluster from its current domain. The domain must be created prior to
/// this operation.
///
///
///
/// For more information, see Kerberos
/// Authentication in the Amazon Aurora User Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public string Domain
{
get { return this._domain; }
set { this._domain = value; }
}
// Check to see if Domain property is set
internal bool IsSetDomain()
{
return this._domain != null;
}
///
/// Gets and sets the property DomainIAMRoleName.
///
/// The name of the IAM role to use when making API calls to the Directory Service.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public string DomainIAMRoleName
{
get { return this._domainIAMRoleName; }
set { this._domainIAMRoleName = value; }
}
// Check to see if DomainIAMRoleName property is set
internal bool IsSetDomainIAMRoleName()
{
return this._domainIAMRoleName != null;
}
///
/// Gets and sets the property EnableGlobalWriteForwarding.
///
/// Specifies whether to enable this DB cluster to forward write operations to the primary
/// cluster of a global cluster (Aurora global database). By default, write operations
/// are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global
/// database.
///
///
///
/// You can set this value only on Aurora DB clusters that are members of an Aurora global
/// database. With this parameter enabled, a secondary cluster can forward writes to the
/// current primary cluster, and the resulting changes are replicated back to this cluster.
/// For the primary DB cluster of an Aurora global database, this value is used immediately
/// if the primary is demoted by a global cluster API operation, but it does nothing until
/// then.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public bool EnableGlobalWriteForwarding
{
get { return this._enableGlobalWriteForwarding.GetValueOrDefault(); }
set { this._enableGlobalWriteForwarding = value; }
}
// Check to see if EnableGlobalWriteForwarding property is set
internal bool IsSetEnableGlobalWriteForwarding()
{
return this._enableGlobalWriteForwarding.HasValue;
}
///
/// Gets and sets the property EnableHttpEndpoint.
///
/// Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
/// By default, the HTTP endpoint is disabled.
///
///
///
/// When enabled, the HTTP endpoint provides a connectionless web service API for running
/// SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database
/// from inside the RDS console with the query editor.
///
///
///
/// For more information, see Using
/// the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public bool EnableHttpEndpoint
{
get { return this._enableHttpEndpoint.GetValueOrDefault(); }
set { this._enableHttpEndpoint = value; }
}
// Check to see if EnableHttpEndpoint property is set
internal bool IsSetEnableHttpEndpoint()
{
return this._enableHttpEndpoint.HasValue;
}
///
/// Gets and sets the property EnableIAMDatabaseAuthentication.
///
/// Specifies whether to enable mapping of Amazon Web Services Identity and Access Management
/// (IAM) accounts to database accounts. By default, mapping isn't enabled.
///
///
///
/// For more information, see
/// IAM Database Authentication in the Amazon Aurora User Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public bool EnableIAMDatabaseAuthentication
{
get { return this._enableIAMDatabaseAuthentication.GetValueOrDefault(); }
set { this._enableIAMDatabaseAuthentication = value; }
}
// Check to see if EnableIAMDatabaseAuthentication property is set
internal bool IsSetEnableIAMDatabaseAuthentication()
{
return this._enableIAMDatabaseAuthentication.HasValue;
}
///
/// Gets and sets the property EnablePerformanceInsights.
///
/// Specifies whether to turn on Performance Insights for the DB cluster.
///
///
///
/// For more information, see
/// Using Amazon Performance Insights in the Amazon RDS User Guide.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public bool EnablePerformanceInsights
{
get { return this._enablePerformanceInsights.GetValueOrDefault(); }
set { this._enablePerformanceInsights = value; }
}
// Check to see if EnablePerformanceInsights property is set
internal bool IsSetEnablePerformanceInsights()
{
return this._enablePerformanceInsights.HasValue;
}
///
/// Gets and sets the property EngineMode.
///
/// The DB engine mode of the DB cluster, either provisioned
or serverless
.
///
///
///
/// The DB engine mode can be modified only from serverless
to provisioned
.
///
///
///
/// For more information, see
/// CreateDBCluster.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public string EngineMode
{
get { return this._engineMode; }
set { this._engineMode = value; }
}
// Check to see if EngineMode property is set
internal bool IsSetEngineMode()
{
return this._engineMode != null;
}
///
/// 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.
///
///
///
/// If the cluster that you're modifying has one or more read replicas, all replicas must
/// be running an engine version that's the same or later than the version you specify.
///
///
///
/// To list all of the available engine versions for Aurora MySQL, use the following command:
///
///
///
/// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
///
///
///
///
/// To list all of the available engine versions for Aurora PostgreSQL, use the following
/// command:
///
///
///
/// aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
///
///
///
///
/// To list all of the available engine versions for RDS for MySQL, use the following
/// command:
///
///
///
/// aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
///
///
///
///
/// To list all of the available engine versions for RDS for PostgreSQL, use the following
/// command:
///
///
///
/// aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
///
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
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 Iops.
///
/// The amount of Provisioned IOPS (input/output operations per second) to be initially
/// allocated for each DB instance in the Multi-AZ DB cluster.
///
///
///
/// For information about valid IOPS values, see Amazon
/// RDS Provisioned IOPS storage in the Amazon RDS User Guide.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
///
/// Constraints:
///
/// -
///
/// Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
///
///
///
public int Iops
{
get { return this._iops.GetValueOrDefault(); }
set { this._iops = value; }
}
// Check to see if Iops property is set
internal bool IsSetIops()
{
return this._iops.HasValue;
}
///
/// Gets and sets the property ManageMasterUserPassword.
///
/// Specifies whether to manage the master user password with Amazon Web Services Secrets
/// Manager.
///
///
///
/// If the DB cluster doesn't manage the master user password with Amazon Web Services
/// Secrets Manager, you can turn on this management. In this case, you can't specify
/// MasterUserPassword
.
///
///
///
/// If the DB cluster already manages the master user password with Amazon Web Services
/// Secrets Manager, and you specify that the master user password is not managed with
/// Amazon Web Services Secrets Manager, then you must specify MasterUserPassword
.
/// In this case, RDS deletes the secret and uses the new password for the master user
/// specified by MasterUserPassword
.
///
///
///
/// For more information, see Password
/// management with Amazon Web Services Secrets Manager in the Amazon RDS User
/// Guide and Password
/// management with Amazon Web Services Secrets Manager in the Amazon Aurora User
/// Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
public bool ManageMasterUserPassword
{
get { return this._manageMasterUserPassword.GetValueOrDefault(); }
set { this._manageMasterUserPassword = value; }
}
// Check to see if ManageMasterUserPassword property is set
internal bool IsSetManageMasterUserPassword()
{
return this._manageMasterUserPassword.HasValue;
}
///
/// Gets and sets the property MasterUserPassword.
///
/// The new password for the master database user.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// Constraints:
///
/// -
///
/// Must contain from 8 to 41 characters.
///
///
-
///
/// Can contain any printable ASCII character except "/", """, or "@".
///
///
-
///
/// Can't be specified if
ManageMasterUserPassword
is turned on.
///
///
///
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 MasterUserSecretKmsKeyId.
///
/// The Amazon Web Services KMS key identifier to encrypt a secret that is automatically
/// generated and managed in Amazon Web Services Secrets Manager.
///
///
///
/// This setting is valid only if both of the following conditions are met:
///
/// -
///
/// The DB cluster doesn't manage the master user password in Amazon Web Services Secrets
/// Manager.
///
///
///
/// If the DB cluster already manages the master user password in Amazon Web Services
/// Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
///
///
-
///
/// You are turning on
ManageMasterUserPassword
to manage the master user
/// password in Amazon Web Services Secrets Manager.
///
///
///
/// If you are turning on ManageMasterUserPassword
and don't specify MasterUserSecretKmsKeyId
,
/// then the aws/secretsmanager
KMS key is used to encrypt the secret. If
/// the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager
/// KMS key to encrypt the secret, and you must use a customer managed KMS key.
///
///
///
/// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias
/// name for the KMS key. To use a KMS key in a different Amazon Web Services account,
/// specify the key ARN or alias ARN.
///
///
///
/// There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
/// account has a different default KMS key for each Amazon Web Services Region.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
public string MasterUserSecretKmsKeyId
{
get { return this._masterUserSecretKmsKeyId; }
set { this._masterUserSecretKmsKeyId = value; }
}
// Check to see if MasterUserSecretKmsKeyId property is set
internal bool IsSetMasterUserSecretKmsKeyId()
{
return this._masterUserSecretKmsKeyId != null;
}
///
/// Gets and sets the property MonitoringInterval.
///
/// The interval, in seconds, between points when Enhanced Monitoring metrics are collected
/// for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0
.
///
///
///
/// If MonitoringRoleArn
is specified, also set MonitoringInterval
/// to a value other than 0
.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
///
/// Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
///
///
///
/// Default: 0
///
///
public int MonitoringInterval
{
get { return this._monitoringInterval.GetValueOrDefault(); }
set { this._monitoringInterval = value; }
}
// Check to see if MonitoringInterval property is set
internal bool IsSetMonitoringInterval()
{
return this._monitoringInterval.HasValue;
}
///
/// Gets and sets the property MonitoringRoleArn.
///
/// The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced
/// Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
.
/// For information on creating a monitoring role, see To
/// create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User
/// Guide.
///
///
///
/// If MonitoringInterval
is set to a value other than 0
, supply
/// a MonitoringRoleArn
value.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public string MonitoringRoleArn
{
get { return this._monitoringRoleArn; }
set { this._monitoringRoleArn = value; }
}
// Check to see if MonitoringRoleArn property is set
internal bool IsSetMonitoringRoleArn()
{
return this._monitoringRoleArn != null;
}
///
/// Gets and sets the property NetworkType.
///
/// The network type of the DB cluster.
///
///
///
/// The network type is determined by the DBSubnetGroup
specified for the
/// DB cluster. A DBSubnetGroup
can support only the IPv4 protocol or the
/// IPv4 and the IPv6 protocols (DUAL
).
///
///
///
/// For more information, see
/// Working with a DB instance in a VPC in the Amazon Aurora User Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
///
/// Valid Values: IPV4 | DUAL
///
///
public string NetworkType
{
get { return this._networkType; }
set { this._networkType = value; }
}
// Check to see if NetworkType property is set
internal bool IsSetNetworkType()
{
return this._networkType != null;
}
///
/// Gets and sets the property NewDBClusterIdentifier.
///
/// The new DB cluster identifier for the DB cluster when renaming a DB cluster. This
/// value is stored as a lowercase string.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// Constraints:
///
/// -
///
/// Must contain from 1 to 63 letters, numbers, or hyphens.
///
///
-
///
/// The first character must be a letter.
///
///
-
///
/// Can't 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 OptionGroupName.
///
/// The option group to associate the DB cluster with.
///
///
///
/// DB clusters are associated with a default option group that can't be modified.
///
///
public string OptionGroupName
{
get { return this._optionGroupName; }
set { this._optionGroupName = value; }
}
// Check to see if OptionGroupName property is set
internal bool IsSetOptionGroupName()
{
return this._optionGroupName != null;
}
///
/// Gets and sets the property PerformanceInsightsKMSKeyId.
///
/// The Amazon Web Services KMS key identifier for encryption of Performance Insights
/// data.
///
///
///
/// The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias
/// name for the KMS key.
///
///
///
/// If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon
/// RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services
/// account. Your Amazon Web Services account has a different default KMS key for each
/// Amazon Web Services Region.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
public string PerformanceInsightsKMSKeyId
{
get { return this._performanceInsightsKMSKeyId; }
set { this._performanceInsightsKMSKeyId = value; }
}
// Check to see if PerformanceInsightsKMSKeyId property is set
internal bool IsSetPerformanceInsightsKMSKeyId()
{
return this._performanceInsightsKMSKeyId != null;
}
///
/// Gets and sets the property PerformanceInsightsRetentionPeriod.
///
/// The number of days to retain Performance Insights data.
///
///
///
/// Valid for Cluster Type: Multi-AZ DB clusters only
///
///
///
/// Valid Values:
///
/// -
///
///
7
///
/// -
///
/// month * 31, where month is a number of months from 1-23. Examples:
///
93
(3 months * 31), 341
(11 months * 31), 589
/// (19 months * 31)
///
/// -
///
///
731
///
///
///
/// Default: 7
days
///
///
///
/// If you specify a retention period that isn't valid, such as 94
, Amazon
/// RDS issues an error.
///
///
public int PerformanceInsightsRetentionPeriod
{
get { return this._performanceInsightsRetentionPeriod.GetValueOrDefault(); }
set { this._performanceInsightsRetentionPeriod = value; }
}
// Check to see if PerformanceInsightsRetentionPeriod property is set
internal bool IsSetPerformanceInsightsRetentionPeriod()
{
return this._performanceInsightsRetentionPeriod.HasValue;
}
///
/// Gets and sets the property Port.
///
/// The port number on which the DB cluster accepts connections.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
///
/// Valid Values: 1150-65535
///
///
///
/// Default: The same port as the original DB 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. To view the time blocks available, see
/// Backup window in the Amazon Aurora User Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// 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).
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// 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. To see
/// the time blocks available, see
/// Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora
/// User Guide.
///
///
///
/// Constraints:
///
/// -
///
/// Must be in the format
ddd:hh24:mi-ddd:hh24:mi
.
///
/// -
///
/// Days must be one of
Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
///
/// -
///
/// Must be in Universal Coordinated Time (UTC).
///
///
-
///
/// Must be at least 30 minutes.
///
///
///
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 RotateMasterUserPassword.
///
/// Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager
/// for the master user password.
///
///
///
/// This setting is valid only if the master user password is managed by RDS in Amazon
/// Web Services Secrets Manager for the DB cluster. The secret value contains the updated
/// password.
///
///
///
/// For more information, see Password
/// management with Amazon Web Services Secrets Manager in the Amazon RDS User
/// Guide and Password
/// management with Amazon Web Services Secrets Manager in the Amazon Aurora User
/// Guide.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// Constraints:
///
/// -
///
/// You must apply the change immediately when rotating the master user password.
///
///
///
public bool RotateMasterUserPassword
{
get { return this._rotateMasterUserPassword.GetValueOrDefault(); }
set { this._rotateMasterUserPassword = value; }
}
// Check to see if RotateMasterUserPassword property is set
internal bool IsSetRotateMasterUserPassword()
{
return this._rotateMasterUserPassword.HasValue;
}
///
/// Gets and sets the property ScalingConfiguration.
///
/// The scaling properties of the DB cluster. You can only modify scaling properties for
/// DB clusters in serverless
DB engine mode.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters only
///
///
public ScalingConfiguration ScalingConfiguration
{
get { return this._scalingConfiguration; }
set { this._scalingConfiguration = value; }
}
// Check to see if ScalingConfiguration property is set
internal bool IsSetScalingConfiguration()
{
return this._scalingConfiguration != null;
}
///
/// Gets and sets the property ServerlessV2ScalingConfiguration.
///
public ServerlessV2ScalingConfiguration ServerlessV2ScalingConfiguration
{
get { return this._serverlessV2ScalingConfiguration; }
set { this._serverlessV2ScalingConfiguration = value; }
}
// Check to see if ServerlessV2ScalingConfiguration property is set
internal bool IsSetServerlessV2ScalingConfiguration()
{
return this._serverlessV2ScalingConfiguration != null;
}
///
/// Gets and sets the property StorageType.
///
/// The storage type to associate with the DB cluster.
///
///
///
/// For information on storage types for Aurora DB clusters, see Storage
/// configurations for Amazon Aurora DB clusters. For information on storage types
/// for Multi-AZ DB clusters, see Settings
/// for creating Multi-AZ DB clusters.
///
///
///
/// When specified for a Multi-AZ DB cluster, a value for the Iops
parameter
/// is required.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
///
/// Valid Values:
///
/// -
///
/// Aurora DB clusters -
aurora | aurora-iopt1
///
/// -
///
/// Multi-AZ DB clusters -
io1
///
///
///
/// Default:
///
/// -
///
/// Aurora DB clusters -
aurora
///
/// -
///
/// Multi-AZ DB clusters -
io1
///
///
///
public string StorageType
{
get { return this._storageType; }
set { this._storageType = value; }
}
// Check to see if StorageType property is set
internal bool IsSetStorageType()
{
return this._storageType != null;
}
///
/// Gets and sets the property VpcSecurityGroupIds.
///
/// A list of EC2 VPC security groups to associate with this DB cluster.
///
///
///
/// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
///
///
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;
}
}
}