Class CfnDBInstanceProps
Properties for defining a CfnDBInstance.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBInstanceProps : ICfnDBInstancePropsSyntax (vb)
Public Class CfnDBInstanceProps Implements ICfnDBInstancePropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnDBInstanceProps = new CfnDBInstanceProps {
AllocatedStorage = "allocatedStorage",
AllowMajorVersionUpgrade = false,
ApplyImmediately = false,
AssociatedRoles = new [] { new DBInstanceRoleProperty {
FeatureName = "featureName",
RoleArn = "roleArn"
} },
AutomaticBackupReplicationKmsKeyId = "automaticBackupReplicationKmsKeyId",
AutomaticBackupReplicationRegion = "automaticBackupReplicationRegion",
AutomaticBackupReplicationRetentionPeriod = 123,
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
BackupRetentionPeriod = 123,
CaCertificateIdentifier = "caCertificateIdentifier",
CertificateRotationRestart = false,
CharacterSetName = "characterSetName",
CopyTagsToSnapshot = false,
CustomIamInstanceProfile = "customIamInstanceProfile",
DatabaseInsightsMode = "databaseInsightsMode",
DbClusterIdentifier = "dbClusterIdentifier",
DbClusterSnapshotIdentifier = "dbClusterSnapshotIdentifier",
DbInstanceClass = "dbInstanceClass",
DbInstanceIdentifier = "dbInstanceIdentifier",
DbName = "dbName",
DbParameterGroupName = "dbParameterGroupName",
DbSecurityGroups = new [] { "dbSecurityGroups" },
DbSnapshotIdentifier = "dbSnapshotIdentifier",
DbSubnetGroupName = "dbSubnetGroupName",
DbSystemId = "dbSystemId",
DedicatedLogVolume = false,
DeleteAutomatedBackups = false,
DeletionProtection = false,
Domain = "domain",
DomainAuthSecretArn = "domainAuthSecretArn",
DomainDnsIps = new [] { "domainDnsIps" },
DomainFqdn = "domainFqdn",
DomainIamRoleName = "domainIamRoleName",
DomainOu = "domainOu",
EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
EnableIamDatabaseAuthentication = false,
EnablePerformanceInsights = false,
Engine = "engine",
EngineLifecycleSupport = "engineLifecycleSupport",
EngineVersion = "engineVersion",
Iops = 123,
KmsKeyId = "kmsKeyId",
LicenseModel = "licenseModel",
ManageMasterUserPassword = false,
MasterUsername = "masterUsername",
MasterUserPassword = "masterUserPassword",
MasterUserSecret = new MasterUserSecretProperty {
KmsKeyId = "kmsKeyId",
SecretArn = "secretArn"
},
MaxAllocatedStorage = 123,
MonitoringInterval = 123,
MonitoringRoleArn = "monitoringRoleArn",
MultiAz = false,
NcharCharacterSetName = "ncharCharacterSetName",
NetworkType = "networkType",
OptionGroupName = "optionGroupName",
PerformanceInsightsKmsKeyId = "performanceInsightsKmsKeyId",
PerformanceInsightsRetentionPeriod = 123,
Port = "port",
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
ProcessorFeatures = new [] { new ProcessorFeatureProperty {
Name = "name",
Value = "value"
} },
PromotionTier = 123,
PubliclyAccessible = false,
ReplicaMode = "replicaMode",
RestoreTime = "restoreTime",
SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
SourceDbInstanceAutomatedBackupsArn = "sourceDbInstanceAutomatedBackupsArn",
SourceDbInstanceIdentifier = "sourceDbInstanceIdentifier",
SourceDbiResourceId = "sourceDbiResourceId",
SourceRegion = "sourceRegion",
StorageEncrypted = false,
StorageThroughput = 123,
StorageType = "storageType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TdeCredentialArn = "tdeCredentialArn",
TdeCredentialPassword = "tdeCredentialPassword",
Timezone = "timezone",
UseDefaultProcessorFeatures = false,
UseLatestRestorableTime = false,
VpcSecurityGroups = new [] { "vpcSecurityGroups" }
};Synopsis
Constructors
| CfnDBInstanceProps() | Properties for defining a |
Properties
| AllocatedStorage | The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. |
| AllowMajorVersionUpgrade | A value that indicates whether major version upgrades are allowed. |
| ApplyImmediately | Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the |
| AssociatedRoles | The AWS Identity and Access Management (IAM) roles associated with the DB instance. |
| AutoMinorVersionUpgrade | A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. |
| AutomaticBackupReplicationKmsKeyId | The AWS KMS key identifier for encryption of the replicated automated backups. |
| AutomaticBackupReplicationRegion | The AWS Region associated with the automated backup. |
| AutomaticBackupReplicationRetentionPeriod | The retention period for automated backups in a different AWS Region. |
| AvailabilityZone | The Availability Zone (AZ) where the database will be created. |
| BackupRetentionPeriod | The number of days for which automated backups are retained. |
| CaCertificateIdentifier | The identifier of the CA certificate for this DB instance. |
| CertificateRotationRestart | Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. |
| CharacterSetName | For supported engines, indicates that the DB instance should be associated with the specified character set. |
| CopyTagsToSnapshot | Specifies whether to copy tags from the DB instance to snapshots of the DB instance. |
| CustomIamInstanceProfile | The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. |
| DatabaseInsightsMode | The mode of Database Insights to enable for the DB instance. |
| DbClusterIdentifier | The identifier of the DB cluster that this DB instance will belong to. |
| DbClusterSnapshotIdentifier | The identifier for the Multi-AZ DB cluster snapshot to restore from. |
| DbInstanceClass | The compute and memory capacity of the DB instance, for example |
| DbInstanceIdentifier | A name for the DB instance. |
| DbName | The meaning of this parameter differs according to the database engine you use. |
| DbParameterGroupName | The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. |
| DbSecurityGroups | A list of the DB security groups to assign to the DB instance. |
| DbSnapshotIdentifier | The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. |
| DbSubnetGroupName | A DB subnet group to associate with the DB instance. |
| DbSystemId | The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. |
| DedicatedLogVolume | Indicates whether the DB instance has a dedicated log volume (DLV) enabled. |
| DeleteAutomatedBackups | A value that indicates whether to remove automated backups immediately after the DB instance is deleted. |
| DeletionProtection | Specifies whether the DB instance has deletion protection enabled. |
| Domain | The Active Directory directory ID to create the DB instance in. |
| DomainAuthSecretArn | The ARN for the Secrets Manager secret with the credentials for the user joining the domain. |
| DomainDnsIps | The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. |
| DomainFqdn | The fully qualified domain name (FQDN) of an Active Directory domain. |
| DomainIamRoleName | The name of the IAM role to use when making API calls to the Directory Service. |
| DomainOu | The Active Directory organizational unit for your DB instance to join. |
| EnableCloudwatchLogsExports | The list of log types that need to be enabled for exporting to CloudWatch Logs. |
| EnableIamDatabaseAuthentication | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. |
| EnablePerformanceInsights | Specifies whether to enable Performance Insights for the DB instance. |
| Engine | The name of the database engine to use for this DB instance. |
| EngineLifecycleSupport | The life cycle type for this DB instance. |
| EngineVersion | The version number of the database engine to use. |
| Iops | The number of I/O operations per second (IOPS) that the database provisions. |
| KmsKeyId | The ARN of the AWS KMS key that's used to encrypt the DB instance, such as |
| LicenseModel | License model information for this DB instance. |
| ManageMasterUserPassword | Specifies whether to manage the master user password with AWS Secrets Manager. |
| MasterUserPassword | The password for the master user. The password can include any printable ASCII character except "/", """, or "@". |
| MasterUserSecret | The secret managed by RDS in AWS Secrets Manager for the master user password. |
| MasterUsername | The master user name for the DB instance. |
| MaxAllocatedStorage | The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. |
| MonitoringInterval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. |
| MonitoringRoleArn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. |
| MultiAz | Specifies whether the DB instance is a Multi-AZ deployment. |
| NcharCharacterSetName | The name of the NCHAR character set for the Oracle DB instance. |
| NetworkType | The network type of the DB instance. |
| OptionGroupName | Indicates that the DB instance should be associated with the specified option group. |
| PerformanceInsightsKmsKeyId | The AWS KMS key identifier for encryption of Performance Insights data. |
| PerformanceInsightsRetentionPeriod | The number of days to retain Performance Insights data. |
| Port | The port number on which the database accepts connections. |
| PreferredBackupWindow | The daily time range during which automated backups are created if automated backups are enabled, using the |
| PreferredMaintenanceWindow | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
| ProcessorFeatures | The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. |
| PromotionTier | The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. |
| PubliclyAccessible | Indicates whether the DB instance is an internet-facing instance. |
| ReplicaMode | The open mode of an Oracle read replica. |
| RestoreTime | The date and time to restore from. |
| SourceDbClusterIdentifier | The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. |
| SourceDbInstanceAutomatedBackupsArn | The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, |
| SourceDbInstanceIdentifier | If you want to create a read replica DB instance, specify the ID of the source DB instance. |
| SourceDbiResourceId | The resource ID of the source DB instance from which to restore. |
| SourceRegion | The ID of the region that contains the source DB instance for the read replica. |
| StorageEncrypted | A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. |
| StorageThroughput | Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. |
| StorageType | The storage type to associate with the DB instance. |
| Tags | Tags to assign to the DB instance. |
| TdeCredentialArn | Properties for defining a |
| TdeCredentialPassword | Properties for defining a |
| Timezone | The time zone of the DB instance. |
| UseDefaultProcessorFeatures | Specifies whether the DB instance class of the DB instance uses its default processor features. |
| UseLatestRestorableTime | Specifies whether the DB instance is restored from the latest backup time. |
| VpcSecurityGroups | A list of the VPC security group IDs to assign to the DB instance. |
Constructors
CfnDBInstanceProps()
Properties for defining a CfnDBInstance.
public CfnDBInstanceProps()Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnDBInstanceProps = new CfnDBInstanceProps {
AllocatedStorage = "allocatedStorage",
AllowMajorVersionUpgrade = false,
ApplyImmediately = false,
AssociatedRoles = new [] { new DBInstanceRoleProperty {
FeatureName = "featureName",
RoleArn = "roleArn"
} },
AutomaticBackupReplicationKmsKeyId = "automaticBackupReplicationKmsKeyId",
AutomaticBackupReplicationRegion = "automaticBackupReplicationRegion",
AutomaticBackupReplicationRetentionPeriod = 123,
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
BackupRetentionPeriod = 123,
CaCertificateIdentifier = "caCertificateIdentifier",
CertificateRotationRestart = false,
CharacterSetName = "characterSetName",
CopyTagsToSnapshot = false,
CustomIamInstanceProfile = "customIamInstanceProfile",
DatabaseInsightsMode = "databaseInsightsMode",
DbClusterIdentifier = "dbClusterIdentifier",
DbClusterSnapshotIdentifier = "dbClusterSnapshotIdentifier",
DbInstanceClass = "dbInstanceClass",
DbInstanceIdentifier = "dbInstanceIdentifier",
DbName = "dbName",
DbParameterGroupName = "dbParameterGroupName",
DbSecurityGroups = new [] { "dbSecurityGroups" },
DbSnapshotIdentifier = "dbSnapshotIdentifier",
DbSubnetGroupName = "dbSubnetGroupName",
DbSystemId = "dbSystemId",
DedicatedLogVolume = false,
DeleteAutomatedBackups = false,
DeletionProtection = false,
Domain = "domain",
DomainAuthSecretArn = "domainAuthSecretArn",
DomainDnsIps = new [] { "domainDnsIps" },
DomainFqdn = "domainFqdn",
DomainIamRoleName = "domainIamRoleName",
DomainOu = "domainOu",
EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
EnableIamDatabaseAuthentication = false,
EnablePerformanceInsights = false,
Engine = "engine",
EngineLifecycleSupport = "engineLifecycleSupport",
EngineVersion = "engineVersion",
Iops = 123,
KmsKeyId = "kmsKeyId",
LicenseModel = "licenseModel",
ManageMasterUserPassword = false,
MasterUsername = "masterUsername",
MasterUserPassword = "masterUserPassword",
MasterUserSecret = new MasterUserSecretProperty {
KmsKeyId = "kmsKeyId",
SecretArn = "secretArn"
},
MaxAllocatedStorage = 123,
MonitoringInterval = 123,
MonitoringRoleArn = "monitoringRoleArn",
MultiAz = false,
NcharCharacterSetName = "ncharCharacterSetName",
NetworkType = "networkType",
OptionGroupName = "optionGroupName",
PerformanceInsightsKmsKeyId = "performanceInsightsKmsKeyId",
PerformanceInsightsRetentionPeriod = 123,
Port = "port",
PreferredBackupWindow = "preferredBackupWindow",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
ProcessorFeatures = new [] { new ProcessorFeatureProperty {
Name = "name",
Value = "value"
} },
PromotionTier = 123,
PubliclyAccessible = false,
ReplicaMode = "replicaMode",
RestoreTime = "restoreTime",
SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
SourceDbInstanceAutomatedBackupsArn = "sourceDbInstanceAutomatedBackupsArn",
SourceDbInstanceIdentifier = "sourceDbInstanceIdentifier",
SourceDbiResourceId = "sourceDbiResourceId",
SourceRegion = "sourceRegion",
StorageEncrypted = false,
StorageThroughput = 123,
StorageType = "storageType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TdeCredentialArn = "tdeCredentialArn",
TdeCredentialPassword = "tdeCredentialPassword",
Timezone = "timezone",
UseDefaultProcessorFeatures = false,
UseLatestRestorableTime = false,
VpcSecurityGroups = new [] { "vpcSecurityGroups" }
};Properties
AllocatedStorage
The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
public string? AllocatedStorage { get; set; }Property Value
Remarks
If any value is set in the <code>Iops</code> parameter, <code>AllocatedStorage</code> must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the <code>Iops</code> value (in 1,000 IOPS increments), then you must also increase the <code>AllocatedStorage</code> value (in 100-GiB increments).
Amazon Aurora
Not applicable. 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.
Db2
Constraints to the amount of storage for each storage type are the following:
MySQL
Constraints to the amount of storage for each storage type are the following:
MariaDB
Constraints to the amount of storage for each storage type are the following:
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
Oracle
Constraints to the amount of storage for each storage type are the following:
SQL Server
Constraints to the amount of storage for each storage type are the following:
AllowMajorVersionUpgrade
A value that indicates whether major version upgrades are allowed.
public object? AllowMajorVersionUpgrade { get; set; }Property Value
Remarks
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
ApplyImmediately
Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the PreferredMaintenanceWindow setting.
public object? ApplyImmediately { get; set; }Property Value
Remarks
If set to false , changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.
In addition to the settings described in Modifying a DB instance , this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.
Default: true
AssociatedRoles
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
public object? AssociatedRoles { get; set; }Property Value
Remarks
Amazon Aurora
Not applicable. The associated roles are managed by the DB cluster.
AutoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
public object? AutoMinorVersionUpgrade { get; set; }Property Value
Remarks
By default, minor engine upgrades are applied automatically.
AutomaticBackupReplicationKmsKeyId
The AWS KMS key identifier for encryption of the replicated automated backups.
public string? AutomaticBackupReplicationKmsKeyId { get; set; }Property Value
Remarks
The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE .
AutomaticBackupReplicationRegion
The AWS Region associated with the automated backup.
public string? AutomaticBackupReplicationRegion { get; set; }Property Value
Remarks
AutomaticBackupReplicationRetentionPeriod
The retention period for automated backups in a different AWS Region.
public double? AutomaticBackupReplicationRetentionPeriod { get; set; }Property Value
Remarks
Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter.
If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
AvailabilityZone
The Availability Zone (AZ) where the database will be created.
public string? AvailabilityZone { get; set; }Property Value
Remarks
For information on AWS 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 AWS Region .
Constraints:
Example: us-east-1d
BackupRetentionPeriod
The number of days for which automated backups are retained.
public double? BackupRetentionPeriod { get; set; }Property Value
Remarks
Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
CaCertificateIdentifier
The identifier of the CA certificate for this DB instance.
public string? CaCertificateIdentifier { get; set; }Property Value
Remarks
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 .
CertificateRotationRestart
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
public object? CertificateRotationRestart { get; set; }Property Value
Remarks
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are <em>not</em> using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
This setting doesn't apply to RDS Custom DB instances.
CharacterSetName
For supported engines, indicates that the DB instance should be associated with the specified character set.
public string? CharacterSetName { get; set; }Property Value
Remarks
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster .
CopyTagsToSnapshot
Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
public object? CopyTagsToSnapshot { get; set; }Property Value
Remarks
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.
CustomIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
public string? CustomIamInstanceProfile { get; set; }Property Value
Remarks
This setting is required for RDS Custom.
Constraints:
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
DatabaseInsightsMode
The mode of Database Insights to enable for the DB instance.
public string? DatabaseInsightsMode { get; set; }Property Value
Remarks
Aurora DB instances inherit this value from the DB cluster, so you can't change this value.
DbClusterIdentifier
The identifier of the DB cluster that this DB instance will belong to.
public string? DbClusterIdentifier { get; set; }Property Value
Remarks
This setting doesn't apply to RDS Custom DB instances.
DbClusterSnapshotIdentifier
The identifier for the Multi-AZ DB cluster snapshot to restore from.
public string? DbClusterSnapshotIdentifier { get; set; }Property Value
Remarks
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .
Constraints:
DbInstanceClass
The compute and memory capacity of the DB instance, for example db.m5.large . Not all DB instance classes are available in all AWS 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 .
public string? DbInstanceClass { get; set; }Property Value
Remarks
DbInstanceIdentifier
A name for the DB instance.
public string? DbInstanceIdentifier { get; set; }Property Value
Remarks
If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type .
For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .
If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
DbName
The meaning of this parameter differs according to the database engine you use.
public string? DbName { get; set; }Property Value
Remarks
If you specify the <code>[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)</code> property, this property only applies to RDS for Oracle.
Amazon Aurora
Not applicable. The database name is managed by the DB cluster.
Db2
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:
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
DbParameterGroupName
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
public string? DbParameterGroupName { get; set; }Property Value
Remarks
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
DbSecurityGroups
A list of the DB security groups to assign to the DB instance.
public string[]? DbSecurityGroups { get; set; }Property Value
string[]
Remarks
The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType , StorageEncrypted , or KmsKeyId . If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
DbSnapshotIdentifier
The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
public string? DbSnapshotIdentifier { get; set; }Property Value
Remarks
If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties, and the point-in-time recovery properties RestoreTime and UseLatestRestorableTime . For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the Amazon RDS API Reference .
After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
Amazon Aurora
Not applicable. Snapshot restore is managed by the DB cluster.
DbSubnetGroupName
A DB subnet group to associate with the DB instance.
public string? DbSubnetGroupName { get; set; }Property Value
Remarks
If you update this value, the new subnet group must be a subnet group in a new VPC.
If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a DBSubnetGroupName , the DB instance fails to launch.
For more information about using Amazon RDS in a VPC, see Amazon VPC and Amazon RDS in the Amazon RDS User Guide .
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
DbSystemId
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.
public string? DbSystemId { get; set; }Property Value
Remarks
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.
DedicatedLogVolume
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
public object? DedicatedLogVolume { get; set; }Property Value
Remarks
DeleteAutomatedBackups
A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
public object? DeleteAutomatedBackups { get; set; }Property Value
Remarks
This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
Amazon Aurora
Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
DeletionProtection
Specifies whether the DB instance has deletion protection enabled.
public object? DeletionProtection { get; set; }Property Value
Remarks
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.
Domain
The Active Directory directory ID to create the DB instance in.
public string? Domain { get; set; }Property Value
Remarks
Currently, only Db2, MySQL, Microsoft SQL Server, 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 .
DomainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
public string? DomainAuthSecretArn { get; set; }Property Value
Remarks
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
DomainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
public string[]? DomainDnsIps { get; set; }Property Value
string[]
Remarks
Constraints:
Example: 123.124.125.126,234.235.236.237
DomainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
public string? DomainFqdn { get; set; }Property Value
Remarks
Constraints:
Example: mymanagedADtest.mymanagedAD.mydomain
DomainIamRoleName
The name of the IAM role to use when making API calls to the Directory Service.
public string? DomainIamRoleName { get; set; }Property Value
Remarks
This setting doesn't apply to the following DB instances:
DomainOu
The Active Directory organizational unit for your DB instance to join.
public string? DomainOu { get; set; }Property Value
Remarks
Constraints:
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
EnableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
public string[]? EnableCloudwatchLogsExports { get; set; }Property Value
string[]
Remarks
The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide .
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
Db2
Valid values: diag.log , notify.log
MariaDB
Valid values: audit , error , general , slowquery
Microsoft SQL Server
Valid values: agent , error
MySQL
Valid values: audit , error , general , slowquery
Oracle
Valid values: alert , audit , listener , trace , oemagent
PostgreSQL
Valid values: postgresql , upgrade
EnableIamDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
public object? EnableIamDatabaseAuthentication { get; set; }Property Value
Remarks
By default, mapping is disabled.
This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
EnablePerformanceInsights
Specifies whether to enable Performance Insights for the DB instance.
public object? EnablePerformanceInsights { get; set; }Property Value
Remarks
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
Engine
The name of the database engine to use for this DB instance.
public string? Engine { get; set; }Property Value
Remarks
Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the <code>Engine</code> value in your templates from <code>oracle-ee</code> to <code>oracle-ee-cdb</code> or from <code>oracle-se2</code> to <code>oracle-se2-cdb</code> . Converting to the CDB architecture requires an interruption.
Valid Values:
EngineLifecycleSupport
The life cycle type for this DB instance.
public string? EngineLifecycleSupport { get; set; }Property Value
Remarks
By default, this value is set to <code>open-source-rds-extended-support</code> , which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to <code>open-source-rds-extended-support-disabled</code> . In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide .
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
EngineVersion
The version number of the database engine to use.
public string? EngineVersion { get; set; }Property Value
Remarks
For a list of valid engine versions, use the DescribeDBEngineVersions action.
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 AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
Db2
See Amazon RDS for Db2 in the Amazon RDS User Guide.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
Iops
The number of I/O operations per second (IOPS) that the database provisions.
public double? Iops { get; set; }Property Value
Remarks
The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide .
If you specify <code>io1</code> for the <code>StorageType</code> property, then you must also specify the <code>Iops</code> property.
Constraints:
KmsKeyId
The ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .
public string? KmsKeyId { get; set; }Property Value
Remarks
If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.
If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.
If you specify DBSecurityGroups , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster.
LicenseModel
License model information for this DB instance.
public string? LicenseModel { get; set; }Property Value
Remarks
Valid Values:
If you've specified <code>DBSecurityGroups</code> and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
ManageMasterUserPassword
Specifies whether to manage the master user password with AWS Secrets Manager.
public object? ManageMasterUserPassword { get; set; }Property Value
Remarks
For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide.
Constraints:
MasterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
public string? MasterUserPassword { get; set; }Property Value
Remarks
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
RDS for Db2
Must contain from 8 to 255 characters.
RDS for MariaDB
Constraints: Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
RDS for MySQL
Constraints: Must contain from 8 to 41 characters.
RDS for Oracle
Constraints: Must contain from 8 to 30 characters.
RDS for PostgreSQL
Constraints: Must contain from 8 to 128 characters.
MasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password.
public object? MasterUserSecret { get; set; }Property Value
Remarks
For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide.
MasterUsername
The master user name for the DB instance.
public string? MasterUsername { get; set; }Property Value
Remarks
If you specify the <code>SourceDBInstanceIdentifier</code> or <code>DBSnapshotIdentifier</code> property, don't specify this property. The value is inherited from the source DB instance or snapshot.
When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
RDS for Db2
Constraints:
RDS for MariaDB
Constraints:
RDS for Microsoft SQL Server
Constraints:
RDS for MySQL
Constraints:
RDS for Oracle
Constraints:
RDS for PostgreSQL
Constraints:
MaxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
public double? MaxAllocatedStorage { get; set; }Property Value
Remarks
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:
MonitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public double? MonitoringInterval { get; set; }Property Value
Remarks
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
MonitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
public string? MonitoringRoleArn { get; set; }Property Value
Remarks
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.
MultiAz
Specifies whether the DB instance is a Multi-AZ deployment.
public object? MultiAz { get; set; }Property Value
Remarks
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:
NcharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance.
public string? NcharCharacterSetName { get; set; }Property Value
Remarks
This setting doesn't apply to RDS Custom DB instances.
NetworkType
The network type of the DB instance.
public string? NetworkType { get; set; }Property Value
Remarks
Valid values:
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 IPv6 protocols ( DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
OptionGroupName
Indicates that the DB instance should be associated with the specified option group.
public string? OptionGroupName { get; set; }Property Value
Remarks
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 once it is associated with a DB instance.
PerformanceInsightsKmsKeyId
The AWS KMS key identifier for encryption of Performance Insights data.
public string? PerformanceInsightsKmsKeyId { get; set; }Property Value
Remarks
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.
For information about enabling Performance Insights, see EnablePerformanceInsights .
PerformanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
public double? PerformanceInsightsRetentionPeriod { get; set; }Property Value
Remarks
When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod .
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
Default: 7 days
If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.
Port
The port number on which the database accepts connections.
public string? Port { get; set; }Property Value
Remarks
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
Constraints:
PreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
public string? PreferredBackupWindow { get; set; }Property Value
Remarks
For more information, see Backup Window in the Amazon RDS User Guide.
Constraints:
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
PreferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public string? PreferredMaintenanceWindow { get; set; }Property Value
Remarks
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide.
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
Constraints: Minimum 30-minute window.
ProcessorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public object? ProcessorFeatures { get; set; }Property Value
Remarks
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
PromotionTier
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
public double? PromotionTier { get; set; }Property Value
Remarks
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
PubliclyAccessible
Indicates whether the DB instance is an internet-facing instance.
public object? PubliclyAccessible { get; set; }Property Value
Remarks
If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference .
ReplicaMode
The open mode of an Oracle read replica.
public string? ReplicaMode { get; set; }Property Value
Remarks
For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
This setting is only supported in RDS for Oracle.
Default: open-read-only
Valid Values: open-read-only or mounted
RestoreTime
The date and time to restore from.
public string? RestoreTime { get; set; }Property Value
Remarks
This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .
Constraints:
Example: 2009-09-07T23:45:00Z
SourceDbClusterIdentifier
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
public string? SourceDbClusterIdentifier { get; set; }Property Value
Remarks
Each DB cluster can have up to 15 read replicas.
Constraints:
SourceDbInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
public string? SourceDbInstanceAutomatedBackupsArn { get; set; }Property Value
Remarks
This setting doesn't apply to RDS Custom.
SourceDbInstanceIdentifier
If you want to create a read replica DB instance, specify the ID of the source DB instance.
public string? SourceDbInstanceIdentifier { get; set; }Property Value
Remarks
Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide .
For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .
The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.
If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
<ul></ul>
SourceDbiResourceId
The resource ID of the source DB instance from which to restore.
public string? SourceDbiResourceId { get; set; }Property Value
Remarks
SourceRegion
The ID of the region that contains the source DB instance for the read replica.
public string? SourceRegion { get; set; }Property Value
Remarks
StorageEncrypted
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
public object? StorageEncrypted { get; set; }Property Value
Remarks
If you specify the KmsKeyId property, then you must enable encryption.
If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.
If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.
If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
StorageThroughput
Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.
public double? StorageThroughput { get; set; }Property Value
Remarks
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
StorageType
The storage type to associate with the DB instance.
public string? StorageType { get; set; }Property Value
Remarks
If you specify io1 , io2 , 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 | io2 | standard
Default: io1 , if the Iops parameter is specified. Otherwise, gp3 .
Tags
Tags to assign to the DB instance.
public ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
TdeCredentialArn
Properties for defining a CfnDBInstance.
[Obsolete("this property has been deprecated")]
public string? TdeCredentialArn { get; set; }Property Value
Remarks
TdeCredentialPassword
Properties for defining a CfnDBInstance.
[Obsolete("this property has been deprecated")]
public string? TdeCredentialPassword { get; set; }Property Value
Remarks
Timezone
The time zone of the DB instance.
public string? Timezone { get; set; }Property Value
Remarks
The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server .
UseDefaultProcessorFeatures
Specifies whether the DB instance class of the DB instance uses its default processor features.
public object? UseDefaultProcessorFeatures { get; set; }Property Value
Remarks
This setting doesn't apply to RDS Custom DB instances.
UseLatestRestorableTime
Specifies whether the DB instance is restored from the latest backup time.
public object? UseLatestRestorableTime { get; set; }Property Value
Remarks
By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .
Constraints:
VpcSecurityGroups
A list of the VPC security group IDs to assign to the DB instance.
public string[]? VpcSecurityGroups { get; set; }Property Value
string[]
Remarks
The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set VPCSecurityGroups , you must not set DBSecurityGroups , and vice versa.
You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:
To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.