Class CfnDBInstance
The AWS::RDS::DBInstance
resource creates an Amazon DB instance.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBInstance : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDBInstance
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB 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 .
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources .
Updating DB instances
When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
After you restore a DB instance with a DBSnapshotIdentifier
property, you can delete the DBSnapshotIdentifier
property. 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.
For more information about updating other properties of this resource, see ModifyDBInstance
. For more information about updating stacks, see AWS CloudFormation Stacks Updates .
Deleting DB instances
For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to retain the DB instance, to delete the DB instance, or to create a snapshot of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier
property:
For more information, see DeletionPolicy Attribute .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html
CloudformationResource: AWS::RDS::DBInstance
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 cfnDBInstance = new CfnDBInstance(this, "MyCfnDBInstance", new CfnDBInstanceProps {
AllocatedStorage = "allocatedStorage",
AllowMajorVersionUpgrade = false,
AssociatedRoles = new [] { new DBInstanceRoleProperty {
FeatureName = "featureName",
RoleArn = "roleArn"
} },
AutomaticBackupReplicationKmsKeyId = "automaticBackupReplicationKmsKeyId",
AutomaticBackupReplicationRegion = "automaticBackupReplicationRegion",
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
BackupRetentionPeriod = 123,
CaCertificateIdentifier = "caCertificateIdentifier",
CertificateDetails = new CertificateDetailsProperty {
CaIdentifier = "caIdentifier",
ValidTill = "validTill"
},
CertificateRotationRestart = false,
CharacterSetName = "characterSetName",
CopyTagsToSnapshot = false,
CustomIamInstanceProfile = "customIamInstanceProfile",
DbClusterIdentifier = "dbClusterIdentifier",
DbClusterSnapshotIdentifier = "dbClusterSnapshotIdentifier",
DbInstanceClass = "dbInstanceClass",
DbInstanceIdentifier = "dbInstanceIdentifier",
DbName = "dbName",
DbParameterGroupName = "dbParameterGroupName",
DbSecurityGroups = new [] { "dbSecurityGroups" },
DbSnapshotIdentifier = "dbSnapshotIdentifier",
DbSubnetGroupName = "dbSubnetGroupName",
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,
Endpoint = new EndpointProperty {
Address = "address",
HostedZoneId = "hostedZoneId",
Port = "port"
},
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
CfnDBInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDBInstance(Construct, String, ICfnDBInstanceProps) |
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. |
AssociatedRoles | The AWS Identity and Access Management (IAM) roles associated with the DB instance. |
AttrCertificateDetailsCaIdentifier | The CA identifier of the CA certificate used for the DB instance's server certificate. |
AttrCertificateDetailsValidTill | The expiration date of the DB instance’s server certificate. |
AttrDbInstanceArn | The Amazon Resource Name (ARN) for the DB instance. |
AttrDbiResourceId | The AWS Region-unique, immutable identifier for the DB instance. |
AttrDbSystemId | The Oracle system ID (Oracle SID) for a container database (CDB). |
AttrEndpointAddress | The connection endpoint for the database. For example: |
AttrEndpointHostedZoneId | The ID that Amazon Route 53 assigns when you create a hosted zone. |
AttrEndpointPort | The port number on which the database accepts connections. |
AttrMasterUserSecretSecretArn | The Amazon Resource Name (ARN) of the secret. |
AutomaticBackupReplicationKmsKeyId | The AWS KMS key identifier for encryption of the replicated automated backups. |
AutomaticBackupReplicationRegion | The AWS Region associated with the automated backup. |
AutoMinorVersionUpgrade | A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. |
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. |
CertificateDetails | The details of the DB instance's server certificate. |
CertificateRotationRestart | Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
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. |
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. |
Endpoint | The connection endpoint 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. |
MasterUsername | The master user name for the DB instance. |
MasterUserPassword | The password for the master user. |
MasterUserSecret | The secret managed by RDS in AWS Secrets Manager for the master user password. |
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. |
StorageThroughput | Specifies the storage throughput value for the DB instance. |
StorageType | The storage type to associate with the DB instance. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Tags to assign to the DB instance. |
TdeCredentialArn | |
TdeCredentialPassword | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDBInstance(Construct, String, ICfnDBInstanceProps)
public CfnDBInstance(Construct scope, string id, ICfnDBInstanceProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBInstanceProps
Resource properties.
Properties
AllocatedStorage
The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
public virtual string AllocatedStorage { get; set; }
Property Value
System.String
AllowMajorVersionUpgrade
A value that indicates whether major version upgrades are allowed.
public virtual object AllowMajorVersionUpgrade { get; set; }
Property Value
System.Object
AssociatedRoles
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
public virtual object AssociatedRoles { get; set; }
Property Value
System.Object
AttrCertificateDetailsCaIdentifier
The CA identifier of the CA certificate used for the DB instance's server certificate.
public virtual string AttrCertificateDetailsCaIdentifier { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CertificateDetails.CAIdentifier
AttrCertificateDetailsValidTill
The expiration date of the DB instance’s server certificate.
public virtual string AttrCertificateDetailsValidTill { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CertificateDetails.ValidTill
AttrDbInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
public virtual string AttrDbInstanceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DBInstanceArn
AttrDbiResourceId
The AWS Region-unique, immutable identifier for the DB instance.
public virtual string AttrDbiResourceId { get; }
Property Value
System.String
Remarks
This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
CloudformationAttribute: DbiResourceId
AttrDbSystemId
The Oracle system ID (Oracle SID) for a container database (CDB).
public virtual string AttrDbSystemId { get; }
Property Value
System.String
Remarks
The Oracle SID is also the name of the CDB.
This setting is valid for RDS Custom only.
CloudformationAttribute: DBSystemId
AttrEndpointAddress
The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
.
public virtual string AttrEndpointAddress { get; }
Property Value
System.String
Remarks
For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.
CloudformationAttribute: Endpoint.Address
AttrEndpointHostedZoneId
The ID that Amazon Route 53 assigns when you create a hosted zone.
public virtual string AttrEndpointHostedZoneId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Endpoint.HostedZoneId
AttrEndpointPort
The port number on which the database accepts connections.
public virtual string AttrEndpointPort { get; }
Property Value
System.String
Remarks
For example: 3306
CloudformationAttribute: Endpoint.Port
AttrMasterUserSecretSecretArn
The Amazon Resource Name (ARN) of the secret.
public virtual string AttrMasterUserSecretSecretArn { get; }
Property Value
System.String
Remarks
This parameter is a return value that you can retrieve using the Fn::GetAtt
intrinsic function. For more information, see Return values .
CloudformationAttribute: MasterUserSecret.SecretArn
AutomaticBackupReplicationKmsKeyId
The AWS KMS key identifier for encryption of the replicated automated backups.
public virtual string AutomaticBackupReplicationKmsKeyId { get; set; }
Property Value
System.String
AutomaticBackupReplicationRegion
The AWS Region associated with the automated backup.
public virtual string AutomaticBackupReplicationRegion { get; set; }
Property Value
System.String
AutoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
AvailabilityZone
The Availability Zone (AZ) where the database will be created.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
BackupRetentionPeriod
The number of days for which automated backups are retained.
public virtual Nullable<double> BackupRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
CaCertificateIdentifier
The identifier of the CA certificate for this DB instance.
public virtual string CaCertificateIdentifier { get; set; }
Property Value
System.String
CertificateDetails
The details of the DB instance's server certificate.
public virtual object CertificateDetails { get; set; }
Property Value
System.Object
CertificateRotationRestart
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
public virtual object CertificateRotationRestart { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CharacterSetName
For supported engines, indicates that the DB instance should be associated with the specified character set.
public virtual string CharacterSetName { get; set; }
Property Value
System.String
CopyTagsToSnapshot
Specifies whether to copy tags from the DB instance to snapshots of the DB instance.
public virtual object CopyTagsToSnapshot { get; set; }
Property Value
System.Object
CustomIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
public virtual string CustomIamInstanceProfile { get; set; }
Property Value
System.String
DbClusterIdentifier
The identifier of the DB cluster that this DB instance will belong to.
public virtual string DbClusterIdentifier { get; set; }
Property Value
System.String
DbClusterSnapshotIdentifier
The identifier for the Multi-AZ DB cluster snapshot to restore from.
public virtual string DbClusterSnapshotIdentifier { get; set; }
Property Value
System.String
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 virtual string DbInstanceClass { get; set; }
Property Value
System.String
DbInstanceIdentifier
A name for the DB instance.
public virtual string DbInstanceIdentifier { get; set; }
Property Value
System.String
DbName
The meaning of this parameter differs according to the database engine you use.
public virtual string DbName { get; set; }
Property Value
System.String
DbParameterGroupName
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
public virtual string DbParameterGroupName { get; set; }
Property Value
System.String
DbSecurityGroups
A list of the DB security groups to assign to the DB instance.
public virtual string[] DbSecurityGroups { get; set; }
Property Value
System.String[]
DbSnapshotIdentifier
The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.
public virtual string DbSnapshotIdentifier { get; set; }
Property Value
System.String
DbSubnetGroupName
A DB subnet group to associate with the DB instance.
public virtual string DbSubnetGroupName { get; set; }
Property Value
System.String
DedicatedLogVolume
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
public virtual object DedicatedLogVolume { get; set; }
Property Value
System.Object
DeleteAutomatedBackups
A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
public virtual object DeleteAutomatedBackups { get; set; }
Property Value
System.Object
DeletionProtection
Specifies whether the DB instance has deletion protection enabled.
public virtual object DeletionProtection { get; set; }
Property Value
System.Object
Domain
The Active Directory directory ID to create the DB instance in.
public virtual string Domain { get; set; }
Property Value
System.String
DomainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
public virtual string DomainAuthSecretArn { get; set; }
Property Value
System.String
DomainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
public virtual string[] DomainDnsIps { get; set; }
Property Value
System.String[]
DomainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
public virtual string DomainFqdn { get; set; }
Property Value
System.String
DomainIamRoleName
The name of the IAM role to use when making API calls to the Directory Service.
public virtual string DomainIamRoleName { get; set; }
Property Value
System.String
DomainOu
The Active Directory organizational unit for your DB instance to join.
public virtual string DomainOu { get; set; }
Property Value
System.String
EnableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
public virtual string[] EnableCloudwatchLogsExports { get; set; }
Property Value
System.String[]
EnableIamDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
public virtual object EnableIamDatabaseAuthentication { get; set; }
Property Value
System.Object
EnablePerformanceInsights
Specifies whether to enable Performance Insights for the DB instance.
public virtual object EnablePerformanceInsights { get; set; }
Property Value
System.Object
Endpoint
The connection endpoint for the DB instance.
public virtual object Endpoint { get; set; }
Property Value
System.Object
Engine
The name of the database engine to use for this DB instance.
public virtual string Engine { get; set; }
Property Value
System.String
EngineLifecycleSupport
The life cycle type for this DB instance.
public virtual string EngineLifecycleSupport { get; set; }
Property Value
System.String
EngineVersion
The version number of the database engine to use.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Iops
The number of I/O operations per second (IOPS) that the database provisions.
public virtual Nullable<double> Iops { get; set; }
Property Value
System.Nullable<System.Double>
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 virtual string KmsKeyId { get; set; }
Property Value
System.String
LicenseModel
License model information for this DB instance.
public virtual string LicenseModel { get; set; }
Property Value
System.String
ManageMasterUserPassword
Specifies whether to manage the master user password with AWS Secrets Manager.
public virtual object ManageMasterUserPassword { get; set; }
Property Value
System.Object
MasterUsername
The master user name for the DB instance.
public virtual string MasterUsername { get; set; }
Property Value
System.String
MasterUserPassword
The password for the master user.
public virtual string MasterUserPassword { get; set; }
Property Value
System.String
Remarks
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.
public virtual object MasterUserSecret { get; set; }
Property Value
System.Object
MaxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
public virtual Nullable<double> MaxAllocatedStorage { get; set; }
Property Value
System.Nullable<System.Double>
MonitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
public virtual Nullable<double> MonitoringInterval { get; set; }
Property Value
System.Nullable<System.Double>
MonitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
public virtual string MonitoringRoleArn { get; set; }
Property Value
System.String
MultiAz
Specifies whether the DB instance is a Multi-AZ deployment.
public virtual object MultiAz { get; set; }
Property Value
System.Object
NcharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance.
public virtual string NcharCharacterSetName { get; set; }
Property Value
System.String
NetworkType
The network type of the DB instance.
public virtual string NetworkType { get; set; }
Property Value
System.String
OptionGroupName
Indicates that the DB instance should be associated with the specified option group.
public virtual string OptionGroupName { get; set; }
Property Value
System.String
PerformanceInsightsKmsKeyId
The AWS KMS key identifier for encryption of Performance Insights data.
public virtual string PerformanceInsightsKmsKeyId { get; set; }
Property Value
System.String
PerformanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
public virtual Nullable<double> PerformanceInsightsRetentionPeriod { get; set; }
Property Value
System.Nullable<System.Double>
Port
The port number on which the database accepts connections.
public virtual string Port { get; set; }
Property Value
System.String
PreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod
parameter.
public virtual string PreferredBackupWindow { get; set; }
Property Value
System.String
PreferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
ProcessorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public virtual object ProcessorFeatures { get; set; }
Property Value
System.Object
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 virtual Nullable<double> PromotionTier { get; set; }
Property Value
System.Nullable<System.Double>
PubliclyAccessible
Indicates whether the DB instance is an internet-facing instance.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
ReplicaMode
The open mode of an Oracle read replica.
public virtual string ReplicaMode { get; set; }
Property Value
System.String
RestoreTime
The date and time to restore from.
public virtual string RestoreTime { get; set; }
Property Value
System.String
SourceDbClusterIdentifier
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.
public virtual string SourceDbClusterIdentifier { get; set; }
Property Value
System.String
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 virtual string SourceDbInstanceAutomatedBackupsArn { get; set; }
Property Value
System.String
SourceDbInstanceIdentifier
If you want to create a read replica DB instance, specify the ID of the source DB instance.
public virtual string SourceDbInstanceIdentifier { get; set; }
Property Value
System.String
SourceDbiResourceId
The resource ID of the source DB instance from which to restore.
public virtual string SourceDbiResourceId { get; set; }
Property Value
System.String
SourceRegion
The ID of the region that contains the source DB instance for the read replica.
public virtual string SourceRegion { get; set; }
Property Value
System.String
StorageEncrypted
A value that indicates whether the DB instance is encrypted.
public virtual object StorageEncrypted { get; set; }
Property Value
System.Object
Remarks
By default, it isn't encrypted.
StorageThroughput
Specifies the storage throughput value for the DB instance.
public virtual Nullable<double> StorageThroughput { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This setting applies only to the gp3
storage type.
StorageType
The storage type to associate with the DB instance.
public virtual string StorageType { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Tags to assign to the DB instance.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TdeCredentialArn
public virtual string TdeCredentialArn { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
TdeCredentialPassword
public virtual string TdeCredentialPassword { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
Timezone
The time zone of the DB instance.
public virtual string Timezone { get; set; }
Property Value
System.String
UseDefaultProcessorFeatures
Specifies whether the DB instance class of the DB instance uses its default processor features.
public virtual object UseDefaultProcessorFeatures { get; set; }
Property Value
System.Object
UseLatestRestorableTime
Specifies whether the DB instance is restored from the latest backup time.
public virtual object UseLatestRestorableTime { get; set; }
Property Value
System.Object
VpcSecurityGroups
A list of the VPC security group IDs to assign to the DB instance.
public virtual string[] VpcSecurityGroups { get; set; }
Property Value
System.String[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>