DBInstance

rds.services.k8s.aws/v1alpha1

TypeLink
GoDocrds-controller/apis/v1alpha1#DBInstance

Metadata

PropertyValue
ScopeNamespaced
KindDBInstance
ListKindDBInstanceList
Pluraldbinstances
Singulardbinstance

Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Spec

allocatedStorage: integer
autoMinorVersionUpgrade: boolean
availabilityZone: string
backupRetentionPeriod: integer
backupTarget: string
characterSetName: string
copyTagsToSnapshot: boolean
customIAMInstanceProfile: string
dbClusterIdentifier: string
dbInstanceClass: string
dbInstanceIdentifier: string
dbName: string
dbParameterGroupName: string
dbParameterGroupRef: 
  from: 
    name: string
dbSnapshotIdentifier: string
dbSubnetGroupName: string
dbSubnetGroupRef: 
  from: 
    name: string
deletionProtection: boolean
destinationRegion: string
domain: string
domainIAMRoleName: string
enableCloudwatchLogsExports:
- string
enableCustomerOwnedIP: boolean
enableIAMDatabaseAuthentication: boolean
engine: string
engineVersion: string
iops: integer
kmsKeyID: string
kmsKeyRef: 
  from: 
    name: string
licenseModel: string
masterUserPassword: 
  key: string
  name: string
  namespace: string
masterUsername: string
maxAllocatedStorage: integer
monitoringInterval: integer
monitoringRoleARN: string
multiAZ: boolean
ncharCharacterSetName: string
networkType: string
optionGroupName: string
performanceInsightsEnabled: boolean
performanceInsightsKMSKeyID: string
performanceInsightsRetentionPeriod: integer
port: integer
preSignedURL: string
preferredBackupWindow: string
preferredMaintenanceWindow: string
processorFeatures:
- name: string
  value: string
promotionTier: integer
publiclyAccessible: boolean
replicaMode: string
sourceDBInstanceIdentifier: string
sourceRegion: string
storageEncrypted: boolean
storageType: string
tags:
- key: string
  value: string
tdeCredentialARN: string
tdeCredentialPassword: string
timezone: string
useDefaultProcessorFeatures: boolean
vpcSecurityGroupIDs:
- string
vpcSecurityGroupRefs:
  from: 
    name: string
FieldDescription
allocatedStorage
Optional
integer
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
Type: Integer
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.
Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
MySQL
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
MariaDB
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
Oracle
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
SQL Server
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2): 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.
autoMinorVersionUpgrade
Optional
boolean
A value that indicates 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.
availabilityZone
Optional
string
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
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.
Example: us-east-1d
Constraint: 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.
backupRetentionPeriod
Optional
integer
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.
Amazon Aurora
Not applicable. 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
backupTarget
Optional
string
Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.
characterSetName
Optional
string
For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.
This setting doesn’t apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
copyTagsToSnapshot
Optional
boolean
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. 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
Optional
string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
* 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the Amazon RDS User Guide.
This setting is required for RDS Custom.
dbClusterIdentifier
Optional
string
The identifier of the DB cluster that the instance will belong to.
This setting doesn’t apply to RDS Custom.
dbInstanceClass
Required
string
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the Amazon Aurora User Guide.
dbInstanceIdentifier
Required
string
The DB instance identifier. 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
dbName
Optional
string
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 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:
* 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.
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 or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
* It can’t be a word reserved by the database engine.
dbParameterGroupName
Optional
string
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
This setting doesn’t apply to RDS Custom.
Constraints:
* Must be 1 to 255 letters, numbers, or hyphens.
* First character must be a letter
* Can’t end with a hyphen or contain two consecutive hyphens
dbParameterGroupRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
dbParameterGroupRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
dbParameterGroupRef.from.name
Optional
string
dbSnapshotIdentifier
Optional
string
The identifier for the DB snapshot to restore from.
Constraints:
* Must match the identifier of an existing DBSnapshot.
* If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
dbSubnetGroupName
Optional
string
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
dbSubnetGroupRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
dbSubnetGroupRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
dbSubnetGroupRef.from.name
Optional
string
deletionProtection
Optional
boolean
A value that indicates 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
Amazon Aurora
Not applicable. 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.
destinationRegion
Optional
string
DestinationRegion is used for presigning the request to a given region.
domain
Optional
string
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
domainIAMRoleName
Optional
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
enableCloudwatchLogsExports
Optional
array
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are audit, error, general, and slowquery.
Microsoft SQL Server
Possible values are agent and error.
MySQL
Possible values are audit, error, general, and slowquery.
Oracle
Possible values are alert, audit, listener, trace, and oemagent.
PostgreSQL
Possible values are postgresql and upgrade.
enableCloudwatchLogsExports.[]
Required
string
enableIAMDatabaseAuthentication
Optional
boolean
A value that indicates 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
engine
Required
string
The name of the database engine to be used for this instance.
Not every database engine is available for every Amazon Web Services Region.
Valid Values:
* aurora (for MySQL 5.6-compatible Aurora)
* aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
* aurora-postgresql
* custom-oracle-ee (for RDS Custom for Oracle instances)
* custom-sqlserver-ee (for RDS Custom for SQL Server instances)
* custom-sqlserver-se (for RDS Custom for SQL Server instances)
* custom-sqlserver-web (for RDS Custom for SQL Server instances)
* mariadb
* mysql
* oracle-ee
* oracle-ee-cdb
* oracle-se2
* oracle-se2-cdb
* postgres
* sqlserver-ee
* sqlserver-se
* sqlserver-ex
* sqlserver-web
engineVersion
Optional
string
The version number of the database engine to use.
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 Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
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 . An example identifier is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) in the Amazon RDS User Guide.
Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html) in the Amazon RDS User Guide.
MariaDB
For information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the Amazon RDS User Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the Amazon RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the Amazon RDS User Guide.
iops
Optional
integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
kmsKeyID
Optional
string
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.
Amazon Aurora
Not applicable. 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.
Amazon RDS Custom
A KMS key is required for RDS Custom 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.
kmsKeyRef
Optional
object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
kmsKeyRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
kmsKeyRef.from.name
Optional
string
licenseModel
Optional
string
License model information for this DB instance.
Valid values: license-included
masterUserPassword
Optional
object
The password for the master user. The password can include any printable ASCII character except “/”, “"”, or “@”.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword.key
Required
string
Key is the key within the secret
masterUserPassword.name
Optional
string
Name is unique within a namespace to reference a secret resource.
masterUserPassword.namespace
Optional
string
Namespace defines the space within which the secret name must be unique.
masterUsername
Optional
string
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
* Required.
* 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.
maxAllocatedStorage
Optional
integer
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
monitoringInterval
Optional
integer
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. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn’t apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringRoleARN
Optional
string
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) 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.
multiAZ
Optional
boolean
A value that indicates 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 RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
ncharCharacterSetName
Optional
string
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn’t apply to RDS Custom.
networkType
Optional
string
The network type of the DB instance.
Valid values:
* IPV4
* DUAL
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the Amazon RDS User Guide.
optionGroupName
Optional
string
A value that indicates that the DB instance should be associated with the specified option group.
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 RDS Custom.
Amazon Aurora
Not applicable.
performanceInsightsEnabled
Optional
boolean
A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the Amazon RDS User Guide.
This setting doesn’t apply to RDS Custom.
performanceInsightsKMSKeyID
Optional
string
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 do not 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.
performanceInsightsRetentionPeriod
Optional
integer
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
* 7
* month * 31, where month is a number of months from 1-23
* 731
For example, the following values are valid:
* 93 (3 months * 31)
* 341 (11 months * 31)
* 589 (19 months * 31)
* 731
If you specify a retention period such as 94, which isn’t a valid value, RDS issues an error.
This setting doesn’t apply to RDS Custom.
port
Optional
integer
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
preSignedURL
Optional
string
When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It’s ignored in other Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don’t specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
* DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
* KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
* SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn’t supported for SQL Server, because Amazon RDS for SQL Server doesn’t support cross-Region read replicas.
This setting doesn’t apply to RDS Custom.
preferredBackupWindow
Optional
string
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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. 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.
preferredMaintenanceWindow
Optional
string
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).
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 Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
processorFeatures
Optional
array
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 RDS Custom.
Amazon Aurora
Not applicable.
processorFeatures.[]
Required
object
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter. In addition, you can use the following actions for DB instance class processor information:
  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
  • You are accessing an Oracle DB instance.
  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
  • The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the Amazon RDS User Guide. || processorFeatures.[].name
    Optional | string
    | | processorFeatures.[].value
    Optional | string
    | | promotionTier
    Optional | integer
    A value that specifies the order 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the Amazon Aurora User Guide.
    This setting doesn’t apply to RDS Custom.
    Default: 1
    Valid Values: 0 - 15 | | publiclyAccessible
    Optional | boolean
    A value that indicates 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. | | replicaMode
    Optional | string
    The open mode of the replica database: mounted or read-only.
    This parameter is only supported for Oracle DB instances.
    Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn’t use Active Data Guard to transmit information to the mounted replica. Because it doesn’t accept user connections, a mounted replica can’t serve a read-only workload.
    You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the Amazon RDS User Guide.
    For RDS Custom, you must specify this parameter and set it to mounted. The value won’t be set by default. After replica creation, you can manage the open mode manually. | | sourceDBInstanceIdentifier
    Optional | string
    The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
    Constraints:
    * Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
    * Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.
    * For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the Amazon RDS User Guide.
    * For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html) in the Amazon RDS User Guide.
    * Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region replication).
    * The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
    * If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
    * If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing) in the Amazon RDS User Guide. This doesn’t apply to SQL Server or RDS Custom, which don’t support cross-Region replicas. | | sourceRegion
    Optional | string
    SourceRegion is the source region where the resource exists. This is not sent over the wire and is only used for presigning. This value should always have the same region as the source ARN. | | storageEncrypted
    Optional | boolean
    A value that indicates whether the DB instance is encrypted. By default, it isn’t encrypted.
    For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.
    Amazon Aurora
    Not applicable. The encryption for DB instances is managed by the DB cluster. | | storageType
    Optional | string
    Specifies the storage type to be associated with the DB instance.
    Valid values: standard | gp2 | io1
    If you specify io1, you must also include a value for the Iops parameter.
    Default: io1 if the Iops parameter is specified, otherwise gp2
    Amazon Aurora
    Not applicable. Storage is managed by the DB cluster. | | tags
    Optional | array
    Tags to assign to the DB instance. | | tags.[]
    Required | object
    Metadata assigned to an Amazon RDS resource consisting of a key-value pair. || tags.[].key
    Optional | string
    | | tags.[].value
    Optional | string
    | | tdeCredentialARN
    Optional | string
    The ARN from the key store with which to associate the instance for TDE encryption.
    This setting doesn’t apply to RDS Custom.
    Amazon Aurora
    Not applicable. | | tdeCredentialPassword
    Optional | string
    The password for the given ARN from the key store in order to access the device.
    This setting doesn’t apply to RDS Custom. | | timezone
    Optional | string
    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). | | useDefaultProcessorFeatures
    Optional | boolean
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    This setting doesn’t apply to RDS Custom. | | vpcSecurityGroupIDs
    Optional | array
    A list of Amazon EC2 VPC security groups to associate with this DB instance.
    Amazon Aurora
    Not applicable. 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. | | vpcSecurityGroupIDs.[]
    Required | string
    || vpcSecurityGroupRefs
    Optional | array
    | | vpcSecurityGroupRefs.[]
    Required | object
    AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api || vpcSecurityGroupRefs.[].from
    Optional | object
    AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) | | vpcSecurityGroupRefs.[].from.name
    Optional | string
    |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
activityStreamEngineNativeAuditFieldsIncluded: boolean
activityStreamKMSKeyID: string
activityStreamKinesisStreamName: string
activityStreamMode: string
activityStreamPolicyStatus: string
activityStreamStatus: string
associatedRoles:
- featureName: string
  roleARN: string
  status: string
automaticRestartTime: string
automationMode: string
awsBackupRecoveryPointARN: string
caCertificateIdentifier: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
customerOwnedIPEnabled: boolean
dbInstanceAutomatedBackupsReplications:
- dbInstanceAutomatedBackupsARN: string
dbInstancePort: integer
dbInstanceStatus: string
dbParameterGroups:
- dbParameterGroupName: string
  parameterApplyStatus: string
dbSubnetGroup: 
  dbSubnetGroupARN: string
  dbSubnetGroupDescription: string
  dbSubnetGroupName: string
  subnetGroupStatus: string
  subnets:
    subnetAvailabilityZone: 
      name: string
    subnetIdentifier: string
    subnetOutpost: 
      arn: string
    subnetStatus: string
  supportedNetworkTypes:
  - string
  vpcID: string
dbiResourceID: string
domainMemberships:
- domain: string
  fQDN: string
  iamRoleName: string
  status: string
enabledCloudwatchLogsExports:
- string
endpoint: 
  address: string
  hostedZoneID: string
  port: integer
enhancedMonitoringResourceARN: string
iamDatabaseAuthenticationEnabled: boolean
instanceCreateTime: string
latestRestorableTime: string
listenerEndpoint: 
  address: string
  hostedZoneID: string
  port: integer
optionGroupMemberships:
- optionGroupName: string
  status: string
pendingModifiedValues: 
  allocatedStorage: integer
  automationMode: string
  backupRetentionPeriod: integer
  caCertificateIdentifier: string
  dbInstanceClass: string
  dbInstanceIdentifier: string
  dbSubnetGroupName: string
  engineVersion: string
  iamDatabaseAuthenticationEnabled: boolean
  iops: integer
  licenseModel: string
  masterUserPassword: string
  multiAZ: boolean
  pendingCloudwatchLogsExports: 
    logTypesToDisable:
    - string
    logTypesToEnable:
    - string
  port: integer
  processorFeatures:
  - name: string
    value: string
  resumeFullAutomationModeTime: string
  storageType: string
readReplicaDBClusterIdentifiers:
- string
readReplicaDBInstanceIdentifiers:
- string
readReplicaSourceDBInstanceIdentifier: string
resumeFullAutomationModeTime: string
secondaryAvailabilityZone: string
statusInfos:
- message: string
  normal: boolean
  status: string
  statusType: string
vpcSecurityGroups:
- status: string
  vpcSecurityGroupID: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
activityStreamEngineNativeAuditFieldsIncluded
Optional
boolean
Indicates whether engine-native audit fields are included in the database activity stream.
activityStreamKMSKeyID
Optional
string
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activityStreamKinesisStreamName
Optional
string
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamMode
Optional
string
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
activityStreamPolicyStatus
Optional
string
The status of the policy state of the activity stream.
activityStreamStatus
Optional
string
The status of the database activity stream.
associatedRoles
Optional
array
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
associatedRoles.[]
Required
object
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
associatedRoles.[].roleARN
Optional
string
associatedRoles.[].status
Optional
string
automaticRestartTime
Optional
string
The time when a stopped DB instance is restarted automatically.
automationMode
Optional
string
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by –resume-full-automation-mode-minutes.
awsBackupRecoveryPointARN
Optional
string
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
caCertificateIdentifier
Optional
string
The identifier of the CA certificate for this DB instance.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition
customerOwnedIPEnabled
Optional
boolean
Specifies whether a customer-owned IP address (CoIP) is enabled 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) in the Amazon Web Services Outposts User Guide.
dbInstanceAutomatedBackupsReplications
Optional
array
The list of replicated automated backups associated with the DB instance.
dbInstanceAutomatedBackupsReplications.[]
Required
object
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
dbInstancePort
Optional
integer
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
dbInstanceStatus
Optional
string
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) in the Amazon RDS User Guide.
dbParameterGroups
Optional
array
Provides the list of DB parameter groups applied to this DB instance.
dbParameterGroups.[]
Required
object
The status of the DB parameter group.
This data type is used as a response element in the following actions:
  • CreateDBInstance
  • CreateDBInstanceReadReplica
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot || dbParameterGroups.[].dbParameterGroupName
    Optional | string
    | | dbParameterGroups.[].parameterApplyStatus
    Optional | string
    | | dbSubnetGroup
    Optional | object
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. | | dbSubnetGroup.dbSubnetGroupARN
    Optional | string
    | | dbSubnetGroup.dbSubnetGroupDescription
    Optional | string
    | | dbSubnetGroup.dbSubnetGroupName
    Optional | string
    | | dbSubnetGroup.subnetGroupStatus
    Optional | string
    | | dbSubnetGroup.subnets
    Optional | array
    | | dbSubnetGroup.subnets.[]
    Required | object
    This data type is used as a response element for the DescribeDBSubnetGroups operation. || dbSubnetGroup.subnets.[].subnetAvailabilityZone
    Optional | object
    Contains Availability Zone information.
    This data type is used as an element in the OrderableDBInstanceOption data type. | | dbSubnetGroup.subnets.[].subnetAvailabilityZone.name
    Optional | string
    | | dbSubnetGroup.subnets.[].subnetIdentifier
    Optional | string
    | | dbSubnetGroup.subnets.[].subnetOutpost
    Optional | object
    A data type that represents an Outpost.
    For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide. | | dbSubnetGroup.subnets.[].subnetOutpost.arn
    Optional | string
    | | dbSubnetGroup.subnets.[].subnetStatus
    Optional | string
    | | dbSubnetGroup.supportedNetworkTypes
    Optional | array
    | | dbSubnetGroup.supportedNetworkTypes.[]
    Required | string
    || dbSubnetGroup.vpcID
    Optional | string
    | | dbiResourceID
    Optional | string
    The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. | | domainMemberships
    Optional | array
    The Active Directory Domain membership records associated with the DB instance. | | domainMemberships.[]
    Required | object
    An Active Directory Domain membership record associated with the DB instance or cluster. || domainMemberships.[].domain
    Optional | string
    | | domainMemberships.[].fQDN
    Optional | string
    | | domainMemberships.[].iamRoleName
    Optional | string
    | | domainMemberships.[].status
    Optional | string
    | | enabledCloudwatchLogsExports
    Optional | array
    A list of log types that this DB instance is configured to export to CloudWatch Logs.
    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the Amazon RDS User Guide. | | enabledCloudwatchLogsExports.[]
    Required | string
    || endpoint
    Optional | object
    Specifies the connection endpoint.
    The endpoint might not be shown for instances whose status is creating. | | endpoint.address
    Optional | string
    | | endpoint.hostedZoneID
    Optional | string
    | | endpoint.port
    Optional | integer
    | | enhancedMonitoringResourceARN
    Optional | string
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance. | | iamDatabaseAuthenticationEnabled
    Optional | boolean
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    IAM database authentication can be enabled for the following database engines
    * For MySQL 5.6, minor version 5.6.34 or higher
    * For MySQL 5.7, minor version 5.7.16 or higher
    * Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type. | | instanceCreateTime
    Optional | string
    Provides the date and time the DB instance was created. | | latestRestorableTime
    Optional | string
    Specifies the latest time to which a database can be restored with point-in-time restore. | | listenerEndpoint
    Optional | object
    Specifies the listener connection endpoint for SQL Server Always On. | | listenerEndpoint.address
    Optional | string
    | | listenerEndpoint.hostedZoneID
    Optional | string
    | | listenerEndpoint.port
    Optional | integer
    | | optionGroupMemberships
    Optional | array
    Provides the list of option group memberships for this DB instance. | | optionGroupMemberships.[]
    Required | object
    Provides information on the option groups the DB instance is a member of. || optionGroupMemberships.[].optionGroupName
    Optional | string
    | | optionGroupMemberships.[].status
    Optional | string
    | | pendingModifiedValues
    Optional | object
    A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. | | pendingModifiedValues.allocatedStorage
    Optional | integer
    | | pendingModifiedValues.automationMode
    Optional | string
    | | pendingModifiedValues.backupRetentionPeriod
    Optional | integer
    | | pendingModifiedValues.caCertificateIdentifier
    Optional | string
    | | pendingModifiedValues.dbInstanceClass
    Optional | string
    | | pendingModifiedValues.dbInstanceIdentifier
    Optional | string
    | | pendingModifiedValues.dbSubnetGroupName
    Optional | string
    | | pendingModifiedValues.engineVersion
    Optional | string
    | | pendingModifiedValues.iamDatabaseAuthenticationEnabled
    Optional | boolean
    | | pendingModifiedValues.iops
    Optional | integer
    | | pendingModifiedValues.licenseModel
    Optional | string
    | | pendingModifiedValues.masterUserPassword
    Optional | string
    | | pendingModifiedValues.multiAZ
    Optional | boolean
    | | pendingModifiedValues.pendingCloudwatchLogsExports
    Optional | object
    A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. | | pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable
    Optional | array
    | | pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]
    Required | string
    || pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable
    Optional | array
    | | pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]
    Required | string
    || pendingModifiedValues.port
    Optional | integer
    | | pendingModifiedValues.processorFeatures
    Optional | array
    | | pendingModifiedValues.processorFeatures.[]
    Required | object
    Contains the processor features of a DB instance class. To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter. You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter. In addition, you can use the following actions for DB instance class processor information:
  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
  • You are accessing an Oracle DB instance.
  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
  • The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the Amazon RDS User Guide. || pendingModifiedValues.processorFeatures.[].name
    Optional | string
    | | pendingModifiedValues.processorFeatures.[].value
    Optional | string
    | | pendingModifiedValues.resumeFullAutomationModeTime
    Optional | string
    | | pendingModifiedValues.storageType
    Optional | string
    | | readReplicaDBClusterIdentifiers
    Optional | array
    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn’t contain information about cross-Region Aurora read replicas.
    Currently, each RDS DB instance can have only one Aurora read replica. | | readReplicaDBClusterIdentifiers.[]
    Required | string
    || readReplicaDBInstanceIdentifiers
    Optional | array
    Contains one or more identifiers of the read replicas associated with this DB instance. | | readReplicaDBInstanceIdentifiers.[]
    Required | string
    || readReplicaSourceDBInstanceIdentifier
    Optional | string
    Contains the identifier of the source DB instance if this DB instance is a read replica. | | resumeFullAutomationModeTime
    Optional | string
    The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. | | secondaryAvailabilityZone
    Optional | string
    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. | | statusInfos
    Optional | array
    The status of a read replica. If the instance isn’t a read replica, this is blank. | | statusInfos.[]
    Required | object
    Provides a list of status information for a DB instance. || statusInfos.[].message
    Optional | string
    | | statusInfos.[].normal
    Optional | boolean
    | | statusInfos.[].status
    Optional | string
    | | statusInfos.[].statusType
    Optional | string
    | | vpcSecurityGroups
    Optional | array
    Provides a list of VPC security group elements that the DB instance belongs to. | | vpcSecurityGroups.[]
    Required | object
    This data type is used as a response element for queries on VPC security group membership. || vpcSecurityGroups.[].status
    Optional | string
    | | vpcSecurityGroups.[].vpcSecurityGroupID
    Optional | string
    |