/* * 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 { /// /// Detailed information about an instance. /// public partial class DBInstance { private bool? _autoMinorVersionUpgrade; private string _availabilityZone; private int? _backupRetentionPeriod; private string _caCertificateIdentifier; private bool? _copyTagsToSnapshot; private string _dbClusterIdentifier; private string _dbInstanceArn; private string _dbInstanceClass; private string _dbInstanceIdentifier; private string _dbInstanceStatus; private string _dbiResourceId; private DBSubnetGroup _dbSubnetGroup; private List _enabledCloudwatchLogsExports = new List(); private Endpoint _endpoint; private string _engine; private string _engineVersion; private DateTime? _instanceCreateTime; private string _kmsKeyId; private DateTime? _latestRestorableTime; private PendingModifiedValues _pendingModifiedValues; private string _preferredBackupWindow; private string _preferredMaintenanceWindow; private int? _promotionTier; private bool? _publiclyAccessible; private List _statusInfos = new List(); private bool? _storageEncrypted; private List _vpcSecurityGroups = new List(); /// /// Gets and sets the property AutoMinorVersionUpgrade. /// /// Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB /// does not perform minor version upgrades regardless of the value set. /// /// 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 AvailabilityZone. /// /// Specifies the name of the Availability Zone that the instance is located in. /// /// public string AvailabilityZone { get { return this._availabilityZone; } set { this._availabilityZone = value; } } // Check to see if AvailabilityZone property is set internal bool IsSetAvailabilityZone() { return this._availabilityZone != null; } /// /// Gets and sets the property BackupRetentionPeriod. /// /// Specifies the number of days for which automatic snapshots are retained. /// /// 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 CACertificateIdentifier. /// /// The identifier of the CA certificate for this DB instance. /// /// public string CACertificateIdentifier { get { return this._caCertificateIdentifier; } set { this._caCertificateIdentifier = value; } } // Check to see if CACertificateIdentifier property is set internal bool IsSetCACertificateIdentifier() { return this._caCertificateIdentifier != null; } /// /// Gets and sets the property CopyTagsToSnapshot. /// /// A value that indicates whether to copy tags from the DB instance to snapshots of the /// DB instance. By default, tags are not copied. /// /// 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. /// /// Contains the name of the cluster that the instance is a member of if the instance /// is a member of a cluster. /// /// 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 DBInstanceArn. /// /// The Amazon Resource Name (ARN) for the instance. /// /// public string DBInstanceArn { get { return this._dbInstanceArn; } set { this._dbInstanceArn = value; } } // Check to see if DBInstanceArn property is set internal bool IsSetDBInstanceArn() { return this._dbInstanceArn != null; } /// /// Gets and sets the property DBInstanceClass. /// /// Contains the name of the compute and memory capacity class of the instance. /// /// public string DBInstanceClass { get { return this._dbInstanceClass; } set { this._dbInstanceClass = value; } } // Check to see if DBInstanceClass property is set internal bool IsSetDBInstanceClass() { return this._dbInstanceClass != null; } /// /// Gets and sets the property DBInstanceIdentifier. /// /// Contains a user-provided database identifier. This identifier is the unique key that /// identifies an instance. /// /// public string DBInstanceIdentifier { get { return this._dbInstanceIdentifier; } set { this._dbInstanceIdentifier = value; } } // Check to see if DBInstanceIdentifier property is set internal bool IsSetDBInstanceIdentifier() { return this._dbInstanceIdentifier != null; } /// /// Gets and sets the property DBInstanceStatus. /// /// Specifies the current state of this database. /// /// public string DBInstanceStatus { get { return this._dbInstanceStatus; } set { this._dbInstanceStatus = value; } } // Check to see if DBInstanceStatus property is set internal bool IsSetDBInstanceStatus() { return this._dbInstanceStatus != null; } /// /// Gets and sets the property DbiResourceId. /// /// The Amazon Web Services Region-unique, immutable identifier for the instance. This /// identifier is found in CloudTrail log entries whenever the KMS key for the instance /// is accessed. /// /// public string DbiResourceId { get { return this._dbiResourceId; } set { this._dbiResourceId = value; } } // Check to see if DbiResourceId property is set internal bool IsSetDbiResourceId() { return this._dbiResourceId != null; } /// /// Gets and sets the property DBSubnetGroup. /// /// Specifies information on the subnet group that is associated with the instance, including /// the name, description, and subnets in the subnet group. /// /// public DBSubnetGroup DBSubnetGroup { get { return this._dbSubnetGroup; } set { this._dbSubnetGroup = value; } } // Check to see if DBSubnetGroup property is set internal bool IsSetDBSubnetGroup() { return this._dbSubnetGroup != null; } /// /// Gets and sets the property EnabledCloudwatchLogsExports. /// /// A list of log types that this instance is configured to export to CloudWatch Logs. /// /// public List EnabledCloudwatchLogsExports { get { return this._enabledCloudwatchLogsExports; } set { this._enabledCloudwatchLogsExports = value; } } // Check to see if EnabledCloudwatchLogsExports property is set internal bool IsSetEnabledCloudwatchLogsExports() { return this._enabledCloudwatchLogsExports != null && this._enabledCloudwatchLogsExports.Count > 0; } /// /// Gets and sets the property Endpoint. /// /// Specifies the connection endpoint. /// /// public Endpoint Endpoint { get { return this._endpoint; } set { this._endpoint = value; } } // Check to see if Endpoint property is set internal bool IsSetEndpoint() { return this._endpoint != null; } /// /// Gets and sets the property Engine. /// /// Provides the name of the database engine to be used for this instance. /// /// public string Engine { get { return this._engine; } set { this._engine = value; } } // Check to see if Engine property is set internal bool IsSetEngine() { return this._engine != null; } /// /// Gets and sets the property EngineVersion. /// /// Indicates the database engine version. /// /// 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 InstanceCreateTime. /// /// Provides the date and time that the instance was created. /// /// public DateTime InstanceCreateTime { get { return this._instanceCreateTime.GetValueOrDefault(); } set { this._instanceCreateTime = value; } } // Check to see if InstanceCreateTime property is set internal bool IsSetInstanceCreateTime() { return this._instanceCreateTime.HasValue; } /// /// Gets and sets the property KmsKeyId. /// /// If StorageEncrypted is true, the KMS key identifier for /// the encrypted instance. /// /// public string KmsKeyId { get { return this._kmsKeyId; } set { this._kmsKeyId = value; } } // Check to see if KmsKeyId property is set internal bool IsSetKmsKeyId() { return this._kmsKeyId != null; } /// /// Gets and sets the property LatestRestorableTime. /// /// Specifies the latest time to which a database can be restored with point-in-time restore. /// /// public DateTime LatestRestorableTime { get { return this._latestRestorableTime.GetValueOrDefault(); } set { this._latestRestorableTime = value; } } // Check to see if LatestRestorableTime property is set internal bool IsSetLatestRestorableTime() { return this._latestRestorableTime.HasValue; } /// /// Gets and sets the property PendingModifiedValues. /// /// Specifies that changes to the instance are pending. This element is included only /// when changes are pending. Specific changes are identified by subelements. /// /// public PendingModifiedValues PendingModifiedValues { get { return this._pendingModifiedValues; } set { this._pendingModifiedValues = value; } } // Check to see if PendingModifiedValues property is set internal bool IsSetPendingModifiedValues() { return this._pendingModifiedValues != null; } /// /// Gets and sets the property PreferredBackupWindow. /// /// Specifies the daily time range during which automated backups are created if automated /// backups are enabled, as determined by the BackupRetentionPeriod. /// /// 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. /// /// Specifies the weekly time range during which system maintenance can occur, in Universal /// Coordinated Time (UTC). /// /// 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 PromotionTier. /// /// A value that specifies the order in which an Amazon DocumentDB replica is promoted /// to the primary instance after a failure of the existing primary instance. /// /// public int PromotionTier { get { return this._promotionTier.GetValueOrDefault(); } set { this._promotionTier = value; } } // Check to see if PromotionTier property is set internal bool IsSetPromotionTier() { return this._promotionTier.HasValue; } /// /// Gets and sets the property PubliclyAccessible. /// /// Not supported. Amazon DocumentDB does not currently support public endpoints. The /// value of PubliclyAccessible is always false. /// /// public bool PubliclyAccessible { get { return this._publiclyAccessible.GetValueOrDefault(); } set { this._publiclyAccessible = value; } } // Check to see if PubliclyAccessible property is set internal bool IsSetPubliclyAccessible() { return this._publiclyAccessible.HasValue; } /// /// Gets and sets the property StatusInfos. /// /// The status of a read replica. If the instance is not a read replica, this is blank. /// /// public List StatusInfos { get { return this._statusInfos; } set { this._statusInfos = value; } } // Check to see if StatusInfos property is set internal bool IsSetStatusInfos() { return this._statusInfos != null && this._statusInfos.Count > 0; } /// /// Gets and sets the property StorageEncrypted. /// /// Specifies whether or not the instance is encrypted. /// /// public bool StorageEncrypted { get { return this._storageEncrypted.GetValueOrDefault(); } set { this._storageEncrypted = value; } } // Check to see if StorageEncrypted property is set internal bool IsSetStorageEncrypted() { return this._storageEncrypted.HasValue; } /// /// Gets and sets the property VpcSecurityGroups. /// /// Provides a list of VPC security group elements that the instance belongs to. /// /// public List VpcSecurityGroups { get { return this._vpcSecurityGroups; } set { this._vpcSecurityGroups = value; } } // Check to see if VpcSecurityGroups property is set internal bool IsSetVpcSecurityGroups() { return this._vpcSecurityGroups != null && this._vpcSecurityGroups.Count > 0; } } }