/*
* 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 CreateDBInstance operation.
/// Creates a new DB instance.
///
///
///
/// The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora
/// DB cluster. For an Aurora DB cluster, you can call this operation multiple times to
/// add more than one DB instance to the cluster.
///
///
///
/// For more information about creating an RDS DB instance, see
/// Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
///
///
///
/// For more information about creating a DB instance in an Aurora DB cluster, see
/// Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
///
///
public partial class CreateDBInstanceRequest : AmazonRDSRequest
{
private int? _allocatedStorage;
private bool? _autoMinorVersionUpgrade;
private string _availabilityZone;
private int? _backupRetentionPeriod;
private string _backupTarget;
private string _caCertificateIdentifier;
private string _characterSetName;
private bool? _copyTagsToSnapshot;
private string _customIamInstanceProfile;
private string _dbClusterIdentifier;
private string _dbInstanceClass;
private string _dbInstanceIdentifier;
private string _dbName;
private string _dbParameterGroupName;
private List _dbSecurityGroups = new List();
private string _dbSubnetGroupName;
private string _dbSystemId;
private bool? _deletionProtection;
private string _domain;
private string _domainAuthSecretArn;
private List _domainDnsIps = new List();
private string _domainFqdn;
private string _domainIAMRoleName;
private string _domainOu;
private List _enableCloudwatchLogsExports = new List();
private bool? _enableCustomerOwnedIp;
private bool? _enableIAMDatabaseAuthentication;
private bool? _enablePerformanceInsights;
private string _engine;
private string _engineVersion;
private int? _iops;
private string _kmsKeyId;
private string _licenseModel;
private bool? _manageMasterUserPassword;
private string _masterUsername;
private string _masterUserPassword;
private string _masterUserSecretKmsKeyId;
private int? _maxAllocatedStorage;
private int? _monitoringInterval;
private string _monitoringRoleArn;
private bool? _multiAZ;
private string _ncharCharacterSetName;
private string _networkType;
private string _optionGroupName;
private string _performanceInsightsKMSKeyId;
private int? _performanceInsightsRetentionPeriod;
private int? _port;
private string _preferredBackupWindow;
private string _preferredMaintenanceWindow;
private List _processorFeatures = new List();
private int? _promotionTier;
private bool? _publiclyAccessible;
private bool? _storageEncrypted;
private int? _storageThroughput;
private string _storageType;
private List _tags = new List();
private string _tdeCredentialArn;
private string _tdeCredentialPassword;
private string _timezone;
private List _vpcSecurityGroupIds = new List();
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public CreateDBInstanceRequest() { }
///
/// Instantiates CreateDBInstanceRequest with the parameterized properties
///
/// The identifier for this DB instance. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
/// The amount of storage in gibibytes (GiB) to allocate for the DB instance. This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. - Amazon RDS Custom
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
- Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
- RDS for MariaDB
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
- RDS for MySQL
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
- RDS for Oracle
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 10 to 3072.
- RDS for PostgreSQL
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
- Magnetic storage (standard): Must be an integer from 5 to 3072.
- RDS for SQL Server
- Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3):
- Enterprise and Standard editions: Must be an integer from 20 to 16384.
- Web and Express editions: Must be an integer from 20 to 16384.
- Provisioned IOPS storage (io1):
- Enterprise and Standard editions: Must be an integer from 100 to 16384.
- Web and Express editions: Must be an integer from 100 to 16384.
- Magnetic storage (standard):
- Enterprise and Standard editions: Must be an integer from 20 to 1024.
- Web and Express editions: Must be an integer from 20 to 1024.
/// The compute and memory capacity of the DB instance, for example db.m5.large
. 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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
/// The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: -
aurora-mysql
(for Aurora MySQL DB instances) -
aurora-postgresql
(for Aurora PostgreSQL DB instances) -
custom-oracle-ee
(for RDS Custom for Oracle DB instances) -
custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) -
custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) -
custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) -
custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) -
mariadb
-
mysql
-
oracle-ee
-
oracle-ee-cdb
-
oracle-se2
-
oracle-se2-cdb
-
postgres
-
sqlserver-ee
-
sqlserver-se
-
sqlserver-ex
-
sqlserver-web
/// The name for the master user. This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster. This setting is required for RDS DB instances. Constraints: - Must be 1 to 16 letters, numbers, or underscores.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
/// The password for the master user. This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster. Constraints: - Can't be specified if
ManageMasterUserPassword
is turned on. - Can include any printable ASCII character except "/", """, or "@".
Length Constraints: - RDS for MariaDB - Must contain from 8 to 41 characters.
- RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
- RDS for MySQL - Must contain from 8 to 41 characters.
- RDS for Oracle - Must contain from 8 to 30 characters.
- RDS for PostgreSQL - Must contain from 8 to 128 characters.
public CreateDBInstanceRequest(string dbInstanceIdentifier, int allocatedStorage, string dbInstanceClass, string engine, string masterUsername, string masterUserPassword)
{
_dbInstanceIdentifier = dbInstanceIdentifier;
_allocatedStorage = allocatedStorage;
_dbInstanceClass = dbInstanceClass;
_engine = engine;
_masterUsername = masterUsername;
_masterUserPassword = masterUserPassword;
}
///
/// Gets and sets the property AllocatedStorage.
///
/// The amount of storage in gibibytes (GiB) to allocate for the DB instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically
/// grow as the amount of data in your database increases, though you are only charged
/// for the space that you use in an Aurora cluster volume.
///
/// - Amazon RDS Custom
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for
/// RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
///
///
-
///
/// Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom
/// for Oracle, 16384 for RDS Custom for SQL Server.
///
///
- RDS for MariaDB
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
///
///
-
///
/// Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
///
///
-
///
/// Magnetic storage (standard): Must be an integer from 5 to 3072.
///
///
- RDS for MySQL
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
///
///
-
///
/// Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
///
///
-
///
/// Magnetic storage (standard): Must be an integer from 5 to 3072.
///
///
- RDS for Oracle
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
///
///
-
///
/// Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
///
///
-
///
/// Magnetic storage (standard): Must be an integer from 10 to 3072.
///
///
- RDS for PostgreSQL
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
///
///
-
///
/// Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
///
///
-
///
/// Magnetic storage (standard): Must be an integer from 5 to 3072.
///
///
- RDS for SQL Server
-
///
/// Constraints to the amount of storage for each storage type are the following:
///
///
-
///
/// General Purpose (SSD) storage (gp2, gp3):
///
///
-
///
/// Enterprise and Standard editions: Must be an integer from 20 to 16384.
///
///
-
///
/// Web and Express editions: Must be an integer from 20 to 16384.
///
///
-
///
/// Provisioned IOPS storage (io1):
///
///
-
///
/// Enterprise and Standard editions: Must be an integer from 100 to 16384.
///
///
-
///
/// Web and Express editions: Must be an integer from 100 to 16384.
///
///
-
///
/// Magnetic storage (standard):
///
///
-
///
/// Enterprise and Standard editions: Must be an integer from 20 to 1024.
///
///
-
///
/// Web and Express editions: Must be an integer from 20 to 1024.
///
///
///
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 AutoMinorVersionUpgrade.
///
/// Specifies whether minor engine upgrades are applied automatically to the DB instance
/// during the maintenance window. By default, minor engine upgrades are applied automatically.
///
///
///
/// If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade
/// to false
.
///
///
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.
///
/// The Availability Zone (AZ) where the database will be created. For information on
/// Amazon Web Services Regions and Availability Zones, see Regions
/// and Availability Zones.
///
///
///
/// For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate
/// Availability Zones. Specify one of these Availability Zones. Aurora automatically
/// chooses an appropriate Availability Zone if you don't specify one.
///
///
///
/// Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services
/// Region.
///
///
///
/// Constraints:
///
/// -
///
/// The
AvailabilityZone
parameter can't be specified if the DB instance
/// is a Multi-AZ deployment.
///
/// -
///
/// The specified Availability Zone must be in the same Amazon Web Services Region as
/// the current endpoint.
///
///
///
/// Example: us-east-1d
///
///
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.
///
/// The number of days for which automated backups are retained. Setting this parameter
/// to a positive number enables backups. Setting this parameter to 0
disables
/// automated backups.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The retention period for
/// automated backups is managed by the DB cluster.
///
///
///
/// Default: 1
///
///
///
/// Constraints:
///
/// -
///
/// Must be a value from 0 to 35.
///
///
-
///
/// Can't be set to 0 if the DB instance is a source to read replicas.
///
///
-
///
/// Can't be set to 0 for an RDS Custom for Oracle DB instance.
///
///
///
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 BackupTarget.
///
/// The location for storing automated backups and manual snapshots.
///
///
///
/// Valie Values:
///
/// -
///
///
outposts
(Amazon Web Services Outposts)
///
/// -
///
///
region
(Amazon Web Services Region)
///
///
///
/// Default: region
///
///
///
/// For more information, see Working
/// with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
///
///
public string BackupTarget
{
get { return this._backupTarget; }
set { this._backupTarget = value; }
}
// Check to see if BackupTarget property is set
internal bool IsSetBackupTarget()
{
return this._backupTarget != null;
}
///
/// Gets and sets the property CACertificateIdentifier.
///
/// The CA certificate identifier to use for the DB instance's server certificate.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
///
/// For more information, see Using
/// SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide
/// and
/// Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora
/// User Guide.
///
///
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 CharacterSetName.
///
/// For supported engines, the character set (CharacterSet
) to associate
/// the DB instance with.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora - The character set is managed by the DB cluster. For more information,
/// see
CreateDBCluster
.
///
/// -
///
/// RDS Custom - However, if you need to change the character set, you can change it on
/// the database itself.
///
///
///
public string CharacterSetName
{
get { return this._characterSetName; }
set { this._characterSetName = value; }
}
// Check to see if CharacterSetName property is set
internal bool IsSetCharacterSetName()
{
return this._characterSetName != null;
}
///
/// Gets and sets the property CopyTagsToSnapshot.
///
/// Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
/// By default, tags are not copied.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots
/// is managed by the DB cluster. Setting this value for an Aurora DB instance has no
/// effect on the DB cluster setting.
///
///
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 CustomIamInstanceProfile.
///
/// The instance profile associated with the underlying Amazon EC2 instance of an RDS
/// Custom DB instance.
///
///
///
/// This setting is required for RDS Custom.
///
///
///
/// Constraints:
///
/// -
///
/// The profile must exist in your account.
///
///
-
///
/// The profile must have an IAM role that Amazon EC2 has permissions to assume.
///
///
-
///
/// The instance profile name and the associated IAM role name must start with the prefix
///
AWSRDSCustom
.
///
///
///
/// For the list of permissions required for the IAM role, see
/// Configure IAM and your VPC in the Amazon RDS User Guide.
///
///
public string CustomIamInstanceProfile
{
get { return this._customIamInstanceProfile; }
set { this._customIamInstanceProfile = value; }
}
// Check to see if CustomIamInstanceProfile property is set
internal bool IsSetCustomIamInstanceProfile()
{
return this._customIamInstanceProfile != null;
}
///
/// Gets and sets the property DBClusterIdentifier.
///
/// The identifier of the DB cluster that this DB instance will belong to.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
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 DBInstanceClass.
///
/// The compute and memory capacity of the DB instance, for example db.m5.large
.
/// 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 classes in the Amazon RDS User Guide or Aurora
/// DB instance classes in the Amazon Aurora User Guide.
///
///
[AWSProperty(Required=true)]
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.
///
/// The identifier for this DB instance. This parameter is stored as a lowercase string.
///
///
///
/// Constraints:
///
/// -
///
/// Must contain from 1 to 63 letters, numbers, or hyphens.
///
///
-
///
/// First character must be a letter.
///
///
-
///
/// Can't end with a hyphen or contain two consecutive hyphens.
///
///
///
/// Example: mydbinstance
///
///
[AWSProperty(Required=true)]
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 DBName.
///
/// The meaning of this parameter differs according to the database engine you use.
///
///
///
/// MySQL
///
///
///
/// The name of the database to create when the DB instance is created. If this parameter
/// isn't specified, no database is created in the DB instance.
///
///
///
/// Constraints:
///
/// -
///
/// Must contain 1 to 64 letters or numbers.
///
///
-
///
/// Must begin with a letter. Subsequent characters can be letters, underscores, or digits
/// (0-9).
///
///
-
///
/// Can't be a word reserved by the specified database engine
///
///
///
/// MariaDB
///
///
///
/// The name of the database to create when the DB instance is created. If this parameter
/// isn't specified, no database is created in the DB instance.
///
///
///
/// Constraints:
///
/// -
///
/// Must contain 1 to 64 letters or numbers.
///
///
-
///
/// Must begin with a letter. Subsequent characters can be letters, underscores, or digits
/// (0-9).
///
///
-
///
/// Can't be a word reserved by the specified database engine
///
///
///
/// PostgreSQL
///
///
///
/// The name of the database to create when the DB instance is created. If this parameter
/// isn't specified, a database named postgres
is created in the DB instance.
///
///
///
/// Constraints:
///
/// -
///
/// Must contain 1 to 63 letters, numbers, or underscores.
///
///
-
///
/// Must begin with a letter. Subsequent characters can be letters, underscores, or digits
/// (0-9).
///
///
-
///
/// Can't be a word reserved by the specified database engine
///
///
///
/// Oracle
///
///
///
/// The Oracle System ID (SID) of the created DB instance. If you don't specify a value,
/// the default value is ORCL
. You can't specify the string null
,
/// or any other reserved word, for DBName
.
///
///
///
/// Default: ORCL
///
///
///
/// Constraints:
///
/// -
///
/// Can't be longer than 8 characters
///
///
///
/// Amazon RDS Custom for Oracle
///
///
///
/// The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify
/// a value, the default value is ORCL
for non-CDBs and RDSCDB
/// for CDBs.
///
///
///
/// Default: ORCL
///
///
///
/// Constraints:
///
/// -
///
/// It must contain 1 to 8 alphanumeric characters.
///
///
-
///
/// It must contain a letter.
///
///
-
///
/// It can't be a word reserved by the database engine.
///
///
///
/// Amazon RDS Custom for SQL Server
///
///
///
/// Not applicable. Must be null.
///
///
///
/// SQL Server
///
///
///
/// Not applicable. Must be null.
///
///
///
/// Amazon Aurora MySQL
///
///
///
/// The name of the database to create when the primary DB instance of the Aurora MySQL
/// DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster,
/// no database is created in the DB cluster.
///
///
///
/// Constraints:
///
/// -
///
/// It must contain 1 to 64 alphanumeric characters.
///
///
-
///
/// It can't be a word reserved by the database engine.
///
///
///
/// Amazon Aurora PostgreSQL
///
///
///
/// The name of the database to create when the primary DB instance of the Aurora PostgreSQL
/// DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL
/// DB cluster, a database named postgres
is created in the DB cluster.
///
///
///
/// Constraints:
///
/// -
///
/// It must contain 1 to 63 alphanumeric characters.
///
///
-
///
/// It must begin with a letter. Subsequent characters can be letters, underscores, or
/// digits (0 to 9).
///
///
-
///
/// It can't be a word reserved by the database engine.
///
///
///
public string DBName
{
get { return this._dbName; }
set { this._dbName = value; }
}
// Check to see if DBName property is set
internal bool IsSetDBName()
{
return this._dbName != null;
}
///
/// Gets and sets the property DBParameterGroupName.
///
/// The name of the DB parameter group to associate with this DB instance. If you don't
/// specify a value, then Amazon RDS uses the default DB parameter group for the specified
/// DB engine and version.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
///
/// Constraints:
///
/// -
///
/// Must be 1 to 255 letters, numbers, or hyphens.
///
///
-
///
/// The first character must be a letter.
///
///
-
///
/// Can't end with a hyphen or contain two consecutive hyphens.
///
///
///
public string DBParameterGroupName
{
get { return this._dbParameterGroupName; }
set { this._dbParameterGroupName = value; }
}
// Check to see if DBParameterGroupName property is set
internal bool IsSetDBParameterGroupName()
{
return this._dbParameterGroupName != null;
}
///
/// Gets and sets the property DBSecurityGroups.
///
/// A list of DB security groups to associate with this DB instance.
///
///
///
/// This setting applies to the legacy EC2-Classic platform, which is no longer used to
/// create new DB instances. Use the VpcSecurityGroupIds
setting instead.
///
///
public List DBSecurityGroups
{
get { return this._dbSecurityGroups; }
set { this._dbSecurityGroups = value; }
}
// Check to see if DBSecurityGroups property is set
internal bool IsSetDBSecurityGroups()
{
return this._dbSecurityGroups != null && this._dbSecurityGroups.Count > 0;
}
///
/// Gets and sets the property DBSubnetGroupName.
///
/// A DB subnet group to associate with this DB instance.
///
///
///
/// Constraints:
///
/// -
///
/// Must match the name of an existing DB subnet group.
///
///
-
///
/// Must not be
default
.
///
///
///
/// Example: mydbsubnetgroup
///
///
public string DBSubnetGroupName
{
get { return this._dbSubnetGroupName; }
set { this._dbSubnetGroupName = value; }
}
// Check to see if DBSubnetGroupName property is set
internal bool IsSetDBSubnetGroupName()
{
return this._dbSubnetGroupName != null;
}
///
/// Gets and sets the property DBSystemId.
///
/// The Oracle system identifier (SID), which is the name of the Oracle database instance
/// that manages your database files. In this context, the term "Oracle database instance"
/// refers exclusively to the system global area (SGA) and Oracle background processes.
/// If you don't specify a SID, the value defaults to RDSCDB
. The Oracle
/// SID is also the name of your CDB.
///
///
public string DBSystemId
{
get { return this._dbSystemId; }
set { this._dbSystemId = value; }
}
// Check to see if DBSystemId property is set
internal bool IsSetDBSystemId()
{
return this._dbSystemId != null;
}
///
/// Gets and sets the property DeletionProtection.
///
/// Specifies whether the DB instance has deletion protection enabled. The database can't
/// be deleted when deletion protection is enabled. By default, deletion protection isn't
/// enabled. For more information, see
/// Deleting a DB Instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable
/// deletion protection for the DB cluster. For more information, see CreateDBCluster
.
/// DB instances in a DB cluster can be deleted even when deletion protection is enabled
/// for the DB cluster.
///
///
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 create the DB instance in. Currently, only Microsoft
/// SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active
/// Directory Domain.
///
///
///
/// For more information, see
/// Kerberos Authentication in the Amazon RDS User Guide.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (The domain is managed by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
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 DomainAuthSecretArn.
///
/// The ARN for the Secrets Manager secret with the credentials for the user joining the
/// domain.
///
///
///
/// Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
///
///
///
public string DomainAuthSecretArn
{
get { return this._domainAuthSecretArn; }
set { this._domainAuthSecretArn = value; }
}
// Check to see if DomainAuthSecretArn property is set
internal bool IsSetDomainAuthSecretArn()
{
return this._domainAuthSecretArn != null;
}
///
/// Gets and sets the property DomainDnsIps.
///
/// The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
///
///
///
/// Constraints:
///
/// -
///
/// Two IP addresses must be provided. If there isn't a secondary domain controller, use
/// the IP address of the primary domain controller for both entries in the list.
///
///
///
/// Example: 123.124.125.126,234.235.236.237
///
///
public List DomainDnsIps
{
get { return this._domainDnsIps; }
set { this._domainDnsIps = value; }
}
// Check to see if DomainDnsIps property is set
internal bool IsSetDomainDnsIps()
{
return this._domainDnsIps != null && this._domainDnsIps.Count > 0;
}
///
/// Gets and sets the property DomainFqdn.
///
/// The fully qualified domain name (FQDN) of an Active Directory domain.
///
///
///
/// Constraints:
///
/// -
///
/// Can't be longer than 64 characters.
///
///
///
/// Example: mymanagedADtest.mymanagedAD.mydomain
///
///
public string DomainFqdn
{
get { return this._domainFqdn; }
set { this._domainFqdn = value; }
}
// Check to see if DomainFqdn property is set
internal bool IsSetDomainFqdn()
{
return this._domainFqdn != null;
}
///
/// Gets and sets the property DomainIAMRoleName.
///
/// The name of the IAM role to use when making API calls to the Directory Service.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (The domain is managed by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
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 DomainOu.
///
/// The Active Directory organizational unit for your DB instance to join.
///
///
///
/// Constraints:
///
/// -
///
/// Must be in the distinguished name format.
///
///
-
///
/// Can't be longer than 64 characters.
///
///
///
/// Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
///
///
///
public string DomainOu
{
get { return this._domainOu; }
set { this._domainOu = value; }
}
// Check to see if DomainOu property is set
internal bool IsSetDomainOu()
{
return this._domainOu != null;
}
///
/// Gets and sets the property EnableCloudwatchLogsExports.
///
/// The list of log types that need to be enabled for exporting to CloudWatch Logs. For
/// more information, see
/// Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
/// The following values are valid for each DB engine:
///
/// -
///
/// RDS for MariaDB -
audit | error | general | slowquery
///
/// -
///
/// RDS for Microsoft SQL Server -
agent | error
///
/// -
///
/// RDS for MySQL -
audit | error | general | slowquery
///
/// -
///
/// RDS for Oracle -
alert | audit | listener | trace | oemagent
///
/// -
///
/// RDS for PostgreSQL -
postgresql | upgrade
///
///
///
public List EnableCloudwatchLogsExports
{
get { return this._enableCloudwatchLogsExports; }
set { this._enableCloudwatchLogsExports = value; }
}
// Check to see if EnableCloudwatchLogsExports property is set
internal bool IsSetEnableCloudwatchLogsExports()
{
return this._enableCloudwatchLogsExports != null && this._enableCloudwatchLogsExports.Count > 0;
}
///
/// Gets and sets the property EnableCustomerOwnedIp.
///
/// Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts
/// DB instance.
///
///
///
/// A CoIP provides local or external connectivity to resources in your Outpost
/// subnets through your on-premises network. For some use cases, a CoIP can provide lower
/// latency for connections to the DB instance from outside of its virtual private cloud
/// (VPC) on your local network.
///
///
///
/// For more information about RDS on Outposts, see Working
/// with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
///
///
///
/// For more information about CoIPs, see Customer-owned
/// IP addresses in the Amazon Web Services Outposts User Guide.
///
///
public bool EnableCustomerOwnedIp
{
get { return this._enableCustomerOwnedIp.GetValueOrDefault(); }
set { this._enableCustomerOwnedIp = value; }
}
// Check to see if EnableCustomerOwnedIp property is set
internal bool IsSetEnableCustomerOwnedIp()
{
return this._enableCustomerOwnedIp.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 for MySQL and PostgreSQL in the Amazon RDS User
/// Guide.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed
/// by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
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 enable Performance Insights for the DB instance. For more information,
/// see Using
/// Amazon Performance Insights in the Amazon RDS User Guide.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
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 Engine.
///
/// The database engine to use for this DB instance.
///
///
///
/// Not every database engine is available in every Amazon Web Services Region.
///
///
///
/// Valid Values:
///
/// -
///
///
aurora-mysql
(for Aurora MySQL DB instances)
///
/// -
///
///
aurora-postgresql
(for Aurora PostgreSQL DB instances)
///
/// -
///
///
custom-oracle-ee
(for RDS Custom for Oracle DB instances)
///
/// -
///
///
custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances)
///
/// -
///
///
custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances)
///
/// -
///
///
custom-sqlserver-se
(for RDS Custom for SQL Server DB instances)
///
/// -
///
///
custom-sqlserver-web
(for RDS Custom for SQL Server DB instances)
///
/// -
///
///
mariadb
///
/// -
///
///
mysql
///
/// -
///
///
oracle-ee
///
/// -
///
///
oracle-ee-cdb
///
/// -
///
///
oracle-se2
///
/// -
///
///
oracle-se2-cdb
///
/// -
///
///
postgres
///
/// -
///
///
sqlserver-ee
///
/// -
///
///
sqlserver-se
///
/// -
///
///
sqlserver-ex
///
/// -
///
///
sqlserver-web
///
///
///
[AWSProperty(Required=true)]
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.
///
/// The version number of the database engine to use.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The version number of the
/// database engine the DB instance uses is managed by the DB cluster.
///
///
///
/// For a list of valid engine versions, use the DescribeDBEngineVersions
/// operation.
///
///
///
/// The following are the database engines and links to information about the major and
/// minor versions that are available with Amazon RDS. Not every database engine is available
/// for every Amazon Web Services Region.
///
/// - Amazon RDS Custom for Oracle
-
///
/// A custom engine version (CEV) that you have previously created. This setting is required
/// for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string.
/// A valid CEV name is
19.my_cev1
. For more information, see
/// Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
///
/// - Amazon RDS Custom for SQL Server
-
///
/// See RDS
/// Custom for SQL Server general requirements in the Amazon RDS User Guide.
///
///
- RDS for MariaDB
-
///
/// For information, see MariaDB
/// on Amazon RDS versions in the Amazon RDS User Guide.
///
///
- RDS for Microsoft SQL Server
-
///
/// For information, see Microsoft
/// SQL Server versions on Amazon RDS in the Amazon RDS User Guide.
///
///
- RDS for MySQL
-
///
/// For information, see MySQL
/// on Amazon RDS versions in the Amazon RDS User Guide.
///
///
- RDS for Oracle
-
///
/// For information, see Oracle
/// Database Engine release notes in the Amazon RDS User Guide.
///
///
- RDS for PostgreSQL
-
///
/// For information, see Amazon
/// RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
///
///
///
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 initially allocate
/// for the DB instance. For information about valid IOPS values, see Amazon
/// RDS DB instance storage in the Amazon RDS User Guide.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the
/// DB cluster.
///
///
///
/// Constraints:
///
/// -
///
/// For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5
/// and 50 of the storage amount for the DB instance.
///
///
-
///
/// For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount
/// for the DB instance.
///
///
///
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 KmsKeyId.
///
/// The Amazon Web Services KMS key identifier for an encrypted DB instance.
///
///
///
/// 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.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services
/// KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster
.
///
///
///
/// If StorageEncrypted
is enabled, and you do not specify a value for the
/// KmsKeyId
parameter, 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.
///
///
///
/// For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines,
/// if you leave this parameter empty while enabling StorageEncrypted
, the
/// engine uses the default KMS key. However, RDS Custom doesn't use the default key when
/// this parameter is empty. You must explicitly specify a key.
///
///
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 LicenseModel.
///
/// The license model information for this DB instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
///
///
///
/// Valid Values:
///
/// -
///
/// RDS for MariaDB -
general-public-license
///
/// -
///
/// RDS for Microsoft SQL Server -
license-included
///
/// -
///
/// RDS for MySQL -
general-public-license
///
/// -
///
/// RDS for Oracle -
bring-your-own-license | license-included
///
/// -
///
/// RDS for PostgreSQL -
postgresql-license
///
///
///
public string LicenseModel
{
get { return this._licenseModel; }
set { this._licenseModel = value; }
}
// Check to see if LicenseModel property is set
internal bool IsSetLicenseModel()
{
return this._licenseModel != null;
}
///
/// Gets and sets the property ManageMasterUserPassword.
///
/// Specifies whether to manage the master user password with Amazon Web Services Secrets
/// Manager.
///
///
///
/// For more information, see Password
/// management with Amazon Web Services Secrets Manager in the Amazon RDS User
/// Guide.
///
///
///
/// Constraints:
///
/// -
///
/// Can't manage the master user password with Amazon Web Services Secrets Manager if
///
MasterUserPassword
is specified.
///
///
///
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 MasterUsername.
///
/// The name for the master user.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The name for the master
/// user is managed by the DB cluster.
///
///
///
/// This setting is required for RDS DB instances.
///
///
///
/// Constraints:
///
/// -
///
/// Must be 1 to 16 letters, numbers, or underscores.
///
///
-
///
/// First character must be a letter.
///
///
-
///
/// Can't be a reserved word for the chosen database engine.
///
///
///
public string MasterUsername
{
get { return this._masterUsername; }
set { this._masterUsername = value; }
}
// Check to see if MasterUsername property is set
internal bool IsSetMasterUsername()
{
return this._masterUsername != null;
}
///
/// Gets and sets the property MasterUserPassword.
///
/// The password for the master user.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The password for the master
/// user is managed by the DB cluster.
///
///
///
/// Constraints:
///
/// -
///
/// Can't be specified if
ManageMasterUserPassword
is turned on.
///
/// -
///
/// Can include any printable ASCII character except "/", """, or "@".
///
///
///
/// Length Constraints:
///
/// -
///
/// RDS for MariaDB - Must contain from 8 to 41 characters.
///
///
-
///
/// RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
///
///
-
///
/// RDS for MySQL - Must contain from 8 to 41 characters.
///
///
-
///
/// RDS for Oracle - Must contain from 8 to 30 characters.
///
///
-
///
/// RDS for PostgreSQL - Must contain from 8 to 128 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 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 the master user password is managed by RDS in Amazon
/// Web Services Secrets Manager for the DB instance.
///
///
///
/// 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.
///
///
///
/// If you 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.
///
///
///
/// 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.
///
///
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 MaxAllocatedStorage.
///
/// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the
/// storage of the DB instance.
///
///
///
/// For more information about this setting, including limitations that apply to it, see
///
/// Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon
/// RDS User Guide.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (Storage is managed by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
public int MaxAllocatedStorage
{
get { return this._maxAllocatedStorage.GetValueOrDefault(); }
set { this._maxAllocatedStorage = value; }
}
// Check to see if MaxAllocatedStorage property is set
internal bool IsSetMaxAllocatedStorage()
{
return this._maxAllocatedStorage.HasValue;
}
///
/// Gets and sets the property MonitoringInterval.
///
/// The interval, in seconds, between points when Enhanced Monitoring metrics are collected
/// for the DB instance. To disable collection of Enhanced Monitoring metrics, specify
/// 0
.
///
///
///
/// If MonitoringRoleArn
is specified, then you must set MonitoringInterval
/// to a value other than 0
.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
///
/// 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 ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon
/// CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess
.
/// For information on creating a monitoring role, see Setting
/// Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
///
///
///
/// If MonitoringInterval
is set to a value other than 0
, then
/// you must supply a MonitoringRoleArn
value.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
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 MultiAZ.
///
/// Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone
/// parameter if the DB instance is a Multi-AZ deployment.
///
///
///
/// This setting doesn't apply to the following DB instances:
///
/// -
///
/// Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
///
///
-
///
/// RDS Custom
///
///
///
public bool MultiAZ
{
get { return this._multiAZ.GetValueOrDefault(); }
set { this._multiAZ = value; }
}
// Check to see if MultiAZ property is set
internal bool IsSetMultiAZ()
{
return this._multiAZ.HasValue;
}
///
/// Gets and sets the property NcharCharacterSetName.
///
/// The name of the NCHAR character set for the Oracle DB instance.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
public string NcharCharacterSetName
{
get { return this._ncharCharacterSetName; }
set { this._ncharCharacterSetName = value; }
}
// Check to see if NcharCharacterSetName property is set
internal bool IsSetNcharCharacterSetName()
{
return this._ncharCharacterSetName != null;
}
///
/// Gets and sets the property NetworkType.
///
/// The network type of the DB instance.
///
///
///
/// The network type is determined by the DBSubnetGroup
specified for the
/// DB instance. 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 RDS User Guide.
///
///
///
/// 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 OptionGroupName.
///
/// The option group to associate the DB instance with.
///
///
///
/// Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't
/// be removed from an option group. Also, that option group can't be removed from a DB
/// instance after it is associated with a DB instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
///
///
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.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
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.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
///
/// 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 returns 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 database accepts connections.
///
///
///
/// This setting doesn't apply to Aurora DB instances. The port number is managed by the
/// cluster.
///
///
///
/// Valid Values: 1150-65535
///
///
///
/// Default:
///
/// -
///
/// RDS for MariaDB -
3306
///
/// -
///
/// RDS for Microsoft SQL Server -
1433
///
/// -
///
/// RDS for MySQL -
3306
///
/// -
///
/// RDS for Oracle -
1521
///
/// -
///
/// RDS for PostgreSQL -
5432
///
///
///
/// Constraints:
///
/// -
///
/// For RDS for Microsoft SQL Server, the value can't be
1234
, 1434
,
/// 3260
, 3343
, 3389
, 47001
, or 49152-49156
.
///
///
///
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. For more information, see Backup
/// window in the Amazon RDS User Guide.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The daily time range for
/// creating automated backups is managed by the DB cluster.
///
///
///
/// 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 time range each week during which system maintenance can occur. For more information,
/// see Amazon
/// RDS Maintenance Window in the Amazon RDS User Guide.
///
///
///
/// 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.
///
///
///
/// Constraints:
///
/// -
///
/// Must be in the format
ddd:hh24:mi-ddd:hh24:mi
.
///
/// -
///
/// The day values must be
mon | tue | wed | thu | fri | sat | sun
.
///
/// -
///
/// Must be in Universal Coordinated Time (UTC).
///
///
-
///
/// Must not conflict with the preferred backup window.
///
///
-
///
/// 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 ProcessorFeatures.
///
/// The number of CPU cores and the number of threads per core for the DB instance class
/// of the DB instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
///
///
public List ProcessorFeatures
{
get { return this._processorFeatures; }
set { this._processorFeatures = value; }
}
// Check to see if ProcessorFeatures property is set
internal bool IsSetProcessorFeatures()
{
return this._processorFeatures != null && this._processorFeatures.Count > 0;
}
///
/// Gets and sets the property PromotionTier.
///
/// The order of priority in which an Aurora Replica is promoted to the primary instance
/// after a failure of the existing primary instance. For more information, see
/// Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
///
/// Default: 1
///
///
///
/// Valid Values: 0 - 15
///
///
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.
///
/// Specifies whether the DB instance is publicly accessible.
///
///
///
/// When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint
/// resolves to the private IP address from within the DB instance's virtual private cloud
/// (VPC). It resolves to the public IP address from outside of the DB instance's VPC.
/// Access to the DB instance is ultimately controlled by the security group it uses.
/// That public access is not permitted if the security group assigned to the DB instance
/// doesn't permit it.
///
///
///
/// When the DB instance isn't publicly accessible, it is an internal DB instance with
/// a DNS name that resolves to a private IP address.
///
///
///
/// Default: The default behavior varies depending on whether DBSubnetGroupName
/// is specified.
///
///
///
/// If DBSubnetGroupName
isn't specified, and PubliclyAccessible
/// isn't specified, the following applies:
///
/// -
///
/// If the default VPC in the target Region doesn’t have an internet gateway attached
/// to it, the DB instance is private.
///
///
-
///
/// If the default VPC in the target Region has an internet gateway attached to it, the
/// DB instance is public.
///
///
///
/// If DBSubnetGroupName
is specified, and PubliclyAccessible
/// isn't specified, the following applies:
///
/// -
///
/// If the subnets are part of a VPC that doesn’t have an internet gateway attached to
/// it, the DB instance is private.
///
///
-
///
/// If the subnets are part of a VPC that has an internet gateway attached to it, the
/// DB instance is public.
///
///
///
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 StorageEncrypted.
///
/// Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
///
///
///
/// For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise,
/// Amazon RDS reports an error.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances
/// is managed by the DB cluster.
///
///
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 StorageThroughput.
///
/// The storage throughput value for the DB instance.
///
///
///
/// This setting applies only to the gp3
storage type.
///
///
///
/// This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
///
///
public int StorageThroughput
{
get { return this._storageThroughput.GetValueOrDefault(); }
set { this._storageThroughput = value; }
}
// Check to see if StorageThroughput property is set
internal bool IsSetStorageThroughput()
{
return this._storageThroughput.HasValue;
}
///
/// Gets and sets the property StorageType.
///
/// The storage type to associate with the DB instance.
///
///
///
/// If you specify io1
or gp3
, you must also include a value
/// for the Iops
parameter.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the
/// DB cluster.
///
///
///
/// Valid Values: gp2 | gp3 | io1 | standard
///
///
///
/// Default: io1
, if the Iops
parameter is specified. Otherwise,
/// gp2
.
///
///
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 Tags.
///
/// Tags to assign to the DB instance.
///
///
public List Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
///
/// Gets and sets the property TdeCredentialArn.
///
/// The ARN from the key store with which to associate the instance for TDE encryption.
///
///
///
/// This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
///
///
public string TdeCredentialArn
{
get { return this._tdeCredentialArn; }
set { this._tdeCredentialArn = value; }
}
// Check to see if TdeCredentialArn property is set
internal bool IsSetTdeCredentialArn()
{
return this._tdeCredentialArn != null;
}
///
/// Gets and sets the property TdeCredentialPassword.
///
/// The password for the given ARN from the key store in order to access the device.
///
///
///
/// This setting doesn't apply to RDS Custom DB instances.
///
///
public string TdeCredentialPassword
{
get { return this._tdeCredentialPassword; }
set { this._tdeCredentialPassword = value; }
}
// Check to see if TdeCredentialPassword property is set
internal bool IsSetTdeCredentialPassword()
{
return this._tdeCredentialPassword != null;
}
///
/// Gets and sets the property Timezone.
///
/// The time zone of the DB instance. The time zone parameter is currently supported only
/// by Microsoft
/// SQL Server.
///
///
public string Timezone
{
get { return this._timezone; }
set { this._timezone = value; }
}
// Check to see if Timezone property is set
internal bool IsSetTimezone()
{
return this._timezone != null;
}
///
/// Gets and sets the property VpcSecurityGroupIds.
///
/// A list of Amazon EC2 VPC security groups to associate with this DB instance.
///
///
///
/// This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2
/// VPC security groups is managed by the DB cluster.
///
///
///
/// Default: The default EC2 VPC security group for the DB subnet group's VPC.
///
///
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;
}
}
}