Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.Types.DBInstance

Description

Synopsis

data DBInstance = DBInstance' {
- engineVersion :: Maybe Text
- dbSecurityGroups :: Maybe [DBSecurityGroupMembership]
- deletionProtection :: Maybe Bool
- automaticRestartTime :: Maybe ISO8601
- storageEncrypted :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- publiclyAccessible :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- dbInstanceArn :: Maybe Text
- activityStreamKinesisStreamName :: Maybe Text
- activityStreamEngineNativeAuditFieldsIncluded :: Maybe Bool
- masterUsername :: Maybe Text
- readReplicaDBInstanceIdentifiers :: Maybe [Text]
- iAMDatabaseAuthenticationEnabled :: Maybe Bool
- monitoringRoleArn :: Maybe Text
- iops :: Maybe Int
- instanceCreateTime :: Maybe ISO8601
- tagList :: Maybe [Tag]
- readReplicaSourceDBInstanceIdentifier :: Maybe Text
- replicaMode :: Maybe ReplicaMode
- monitoringInterval :: Maybe Int
- engine :: Maybe Text
- processorFeatures :: Maybe [ProcessorFeature]
- latestRestorableTime :: Maybe ISO8601
- dbInstanceClass :: Maybe Text
- promotionTier :: Maybe Int
- awsBackupRecoveryPointArn :: Maybe Text
- licenseModel :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- performanceInsightsRetentionPeriod :: Maybe Int
- cACertificateIdentifier :: Maybe Text
- dbInstanceIdentifier :: Maybe Text
- characterSetName :: Maybe Text
- maxAllocatedStorage :: Maybe Int
- customerOwnedIpEnabled :: Maybe Bool
- kmsKeyId :: Maybe Text
- preferredBackupWindow :: Maybe Text
- associatedRoles :: Maybe [DBInstanceRole]
- availabilityZone :: Maybe Text
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- backupRetentionPeriod :: Maybe Int
- ncharCharacterSetName :: Maybe Text
- performanceInsightsKMSKeyId :: Maybe Text
- dbSubnetGroup :: Maybe DBSubnetGroup
- activityStreamMode :: Maybe ActivityStreamMode
- multiAZ :: Maybe Bool
- listenerEndpoint :: Maybe Endpoint
- optionGroupMemberships :: Maybe [OptionGroupMembership]
- enabledCloudwatchLogsExports :: Maybe [Text]
- enhancedMonitoringResourceArn :: Maybe Text
- secondaryAvailabilityZone :: Maybe Text
- activityStreamStatus :: Maybe ActivityStreamStatus
- performanceInsightsEnabled :: Maybe Bool
- allocatedStorage :: Maybe Int
- dbiResourceId :: Maybe Text
- dbParameterGroups :: Maybe [DBParameterGroupStatus]
- copyTagsToSnapshot :: Maybe Bool
- timezone :: Maybe Text
- tdeCredentialArn :: Maybe Text
- dbInstanceAutomatedBackupsReplications :: Maybe [DBInstanceAutomatedBackupsReplication]
- endpoint :: Maybe Endpoint
- dbInstanceStatus :: Maybe Text
- dbInstancePort :: Maybe Int
- activityStreamKmsKeyId :: Maybe Text
- pendingModifiedValues :: Maybe PendingModifiedValues
- readReplicaDBClusterIdentifiers :: Maybe [Text]
- storageType :: Maybe Text
- statusInfos :: Maybe [DBInstanceStatusInfo]
- domainMemberships :: Maybe [DomainMembership]
- dbName :: Maybe Text
}
newDBInstance :: DBInstance
dbInstance_engineVersion :: Lens' DBInstance (Maybe Text)
dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership])
dbInstance_deletionProtection :: Lens' DBInstance (Maybe Bool)
dbInstance_automaticRestartTime :: Lens' DBInstance (Maybe UTCTime)
dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool)
dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool)
dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool)
dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text)
dbInstance_activityStreamKinesisStreamName :: Lens' DBInstance (Maybe Text)
dbInstance_activityStreamEngineNativeAuditFieldsIncluded :: Lens' DBInstance (Maybe Bool)
dbInstance_masterUsername :: Lens' DBInstance (Maybe Text)
dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text])
dbInstance_iAMDatabaseAuthenticationEnabled :: Lens' DBInstance (Maybe Bool)
dbInstance_monitoringRoleArn :: Lens' DBInstance (Maybe Text)
dbInstance_iops :: Lens' DBInstance (Maybe Int)
dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime)
dbInstance_tagList :: Lens' DBInstance (Maybe [Tag])
dbInstance_readReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_replicaMode :: Lens' DBInstance (Maybe ReplicaMode)
dbInstance_monitoringInterval :: Lens' DBInstance (Maybe Int)
dbInstance_engine :: Lens' DBInstance (Maybe Text)
dbInstance_processorFeatures :: Lens' DBInstance (Maybe [ProcessorFeature])
dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime)
dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text)
dbInstance_promotionTier :: Lens' DBInstance (Maybe Int)
dbInstance_awsBackupRecoveryPointArn :: Lens' DBInstance (Maybe Text)
dbInstance_licenseModel :: Lens' DBInstance (Maybe Text)
dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text)
dbInstance_performanceInsightsRetentionPeriod :: Lens' DBInstance (Maybe Int)
dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text)
dbInstance_characterSetName :: Lens' DBInstance (Maybe Text)
dbInstance_maxAllocatedStorage :: Lens' DBInstance (Maybe Int)
dbInstance_customerOwnedIpEnabled :: Lens' DBInstance (Maybe Bool)
dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text)
dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text)
dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole])
dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text)
dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership])
dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int)
dbInstance_ncharCharacterSetName :: Lens' DBInstance (Maybe Text)
dbInstance_performanceInsightsKMSKeyId :: Lens' DBInstance (Maybe Text)
dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup)
dbInstance_activityStreamMode :: Lens' DBInstance (Maybe ActivityStreamMode)
dbInstance_multiAZ :: Lens' DBInstance (Maybe Bool)
dbInstance_listenerEndpoint :: Lens' DBInstance (Maybe Endpoint)
dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership])
dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text])
dbInstance_enhancedMonitoringResourceArn :: Lens' DBInstance (Maybe Text)
dbInstance_secondaryAvailabilityZone :: Lens' DBInstance (Maybe Text)
dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus)
dbInstance_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool)
dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int)
dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text)
dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus])
dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool)
dbInstance_timezone :: Lens' DBInstance (Maybe Text)
dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text)
dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication])
dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint)
dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text)
dbInstance_dbInstancePort :: Lens' DBInstance (Maybe Int)
dbInstance_activityStreamKmsKeyId :: Lens' DBInstance (Maybe Text)
dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues)
dbInstance_readReplicaDBClusterIdentifiers :: Lens' DBInstance (Maybe [Text])
dbInstance_storageType :: Lens' DBInstance (Maybe Text)
dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo])
dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership])
dbInstance_dbName :: Lens' DBInstance (Maybe Text)

Documentation

data DBInstance Source #

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

See: newDBInstance smart constructor.

Constructors

DBInstance'

Fields

engineVersion :: Maybe Text
Indicates the database engine version.
dbSecurityGroups :: Maybe [DBSecurityGroupMembership]
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
deletionProtection :: Maybe Bool
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
automaticRestartTime :: Maybe ISO8601
The time when a stopped DB instance is restarted automatically.
storageEncrypted :: Maybe Bool
Specifies whether the DB instance is encrypted.
dbClusterIdentifier :: Maybe Text
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
publiclyAccessible :: Maybe Bool
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
For more information, see CreateDBInstance.
autoMinorVersionUpgrade :: Maybe Bool
A value that indicates that minor version patches are applied automatically.
dbInstanceArn :: Maybe Text
The Amazon Resource Name (ARN) for the DB instance.
activityStreamKinesisStreamName :: Maybe Text
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamEngineNativeAuditFieldsIncluded :: Maybe Bool
Indicates whether engine-native audit fields are included in the database activity stream.
masterUsername :: Maybe Text
Contains the master username for the DB instance.
readReplicaDBInstanceIdentifiers :: Maybe [Text]
Contains one or more identifiers of the read replicas associated with this DB instance.
iAMDatabaseAuthenticationEnabled :: Maybe Bool
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.
monitoringRoleArn :: Maybe Text
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
iops :: Maybe Int
Specifies the Provisioned IOPS (I/O operations per second) value.
instanceCreateTime :: Maybe ISO8601
Provides the date and time the DB instance was created.
tagList :: Maybe [Tag]
readReplicaSourceDBInstanceIdentifier :: Maybe Text
Contains the identifier of the source DB instance if this DB instance is a read replica.
replicaMode :: Maybe ReplicaMode
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
monitoringInterval :: Maybe Int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
engine :: Maybe Text
The name of the database engine to be used for this DB instance.
processorFeatures :: Maybe [ProcessorFeature]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
latestRestorableTime :: Maybe ISO8601
Specifies the latest time to which a database can be restored with point-in-time restore.
dbInstanceClass :: Maybe Text
Contains the name of the compute and memory capacity class of the DB instance.
promotionTier :: Maybe Int
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 in the Amazon Aurora User Guide.
awsBackupRecoveryPointArn :: Maybe Text
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
licenseModel :: Maybe Text
License model information for this DB instance.
preferredMaintenanceWindow :: Maybe Text
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
performanceInsightsRetentionPeriod :: Maybe Int
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
cACertificateIdentifier :: Maybe Text
The identifier of the CA certificate for this DB instance.
dbInstanceIdentifier :: Maybe Text
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
characterSetName :: Maybe Text
If present, specifies the name of the character set that this instance is associated with.
maxAllocatedStorage :: Maybe Int
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
customerOwnedIpEnabled :: Maybe Bool
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 in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
kmsKeyId :: Maybe Text
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
preferredBackupWindow :: Maybe Text
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
associatedRoles :: Maybe [DBInstanceRole]
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
availabilityZone :: Maybe Text
Specifies the name of the Availability Zone the DB instance is located in.
vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
Provides a list of VPC security group elements that the DB instance belongs to.
backupRetentionPeriod :: Maybe Int
Specifies the number of days for which automatic DB snapshots are retained.
ncharCharacterSetName :: Maybe Text
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
performanceInsightsKMSKeyId :: Maybe Text
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 Amazon Web Services KMS customer master key (CMK).
dbSubnetGroup :: Maybe DBSubnetGroup
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
activityStreamMode :: Maybe ActivityStreamMode
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.
multiAZ :: Maybe Bool
Specifies if the DB instance is a Multi-AZ deployment.
listenerEndpoint :: Maybe Endpoint
Specifies the listener connection endpoint for SQL Server Always On.
optionGroupMemberships :: Maybe [OptionGroupMembership]
Provides the list of option group memberships for this DB instance.
enabledCloudwatchLogsExports :: Maybe [Text]
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 in the Amazon RDS User Guide.
enhancedMonitoringResourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
secondaryAvailabilityZone :: Maybe Text
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
activityStreamStatus :: Maybe ActivityStreamStatus
The status of the database activity stream.
performanceInsightsEnabled :: Maybe Bool
True if Performance Insights is enabled for the DB instance, and otherwise false.
allocatedStorage :: Maybe Int
Specifies the allocated storage size specified in gibibytes (GiB).
dbiResourceId :: Maybe Text
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 customer master key (CMK) for the DB instance is accessed.
dbParameterGroups :: Maybe [DBParameterGroupStatus]
Provides the list of DB parameter groups applied to this DB instance.
copyTagsToSnapshot :: Maybe Bool
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
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. For more information, see DBCluster.
timezone :: Maybe Text
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
tdeCredentialArn :: Maybe Text
The ARN from the key store with which the instance is associated for TDE encryption.
dbInstanceAutomatedBackupsReplications :: Maybe [DBInstanceAutomatedBackupsReplication]
The list of replicated automated backups associated with the DB instance.
endpoint :: Maybe Endpoint
Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is creating.
dbInstanceStatus :: Maybe Text
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
dbInstancePort :: Maybe Int
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.
activityStreamKmsKeyId :: Maybe Text
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 Amazon Web Services KMS customer master key (CMK).
pendingModifiedValues :: Maybe PendingModifiedValues
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.
readReplicaDBClusterIdentifiers :: Maybe [Text]
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
storageType :: Maybe Text
Specifies the storage type associated with DB instance.
statusInfos :: Maybe [DBInstanceStatusInfo]
The status of a read replica. If the instance isn't a read replica, this is blank.
domainMemberships :: Maybe [DomainMembership]
The Active Directory Domain membership records associated with the DB instance.
dbName :: Maybe Text
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Instances

Instances details

Eq DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods (==) :: DBInstance -> DBInstance -> Bool # (/=) :: DBInstance -> DBInstance -> Bool #
Read DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods readsPrec :: Int -> ReadS DBInstance # readList :: ReadS [DBInstance] # readPrec :: ReadPrec DBInstance # readListPrec :: ReadPrec [DBInstance] #
Show DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods showsPrec :: Int -> DBInstance -> ShowS # show :: DBInstance -> String # showList :: [DBInstance] -> ShowS #
Generic DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Associated Types type Rep DBInstance :: Type -> Type # Methods from :: DBInstance -> Rep DBInstance x # to :: Rep DBInstance x -> DBInstance #
NFData DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods rnf :: DBInstance -> () #
Hashable DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods hashWithSalt :: Int -> DBInstance -> Int # hash :: DBInstance -> Int #
FromXML DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance Methods parseXML :: [Node] -> Either String DBInstance #
type Rep DBInstance Source #
Instance details Defined in Amazonka.RDS.Types.DBInstance type Rep DBInstance = D1 ('MetaData "DBInstance" "Amazonka.RDS.Types.DBInstance" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DBInstance'" 'PrefixI 'True) ((((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSecurityGroupMembership]))) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "automaticRestartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "dbInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "activityStreamKinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "activityStreamEngineNativeAuditFieldsIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "readReplicaDBInstanceIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))) :: ((((S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "readReplicaSourceDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "replicaMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicaMode)) :: S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature]))) :: (S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :: (((S1 ('MetaSel ('Just "awsBackupRecoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxAllocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "customerOwnedIpEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))) :: (((((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceRole])) :: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership])) :: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "ncharCharacterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSubnetGroup)) :: S1 ('MetaSel ('Just "activityStreamMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode))) :: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "listenerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)))) :: ((S1 ('MetaSel ('Just "optionGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionGroupMembership])) :: S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "enhancedMonitoringResourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "secondaryAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "activityStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus))))))) :: ((((S1 ('MetaSel ('Just "performanceInsightsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBParameterGroupStatus])))) :: ((S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsReplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceAutomatedBackupsReplication])) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)))))) :: (((S1 ('MetaSel ('Just "dbInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbInstancePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "activityStreamKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingModifiedValues)))) :: ((S1 ('MetaSel ('Just "readReplicaDBClusterIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "statusInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceStatusInfo])) :: (S1 ('MetaSel ('Just "domainMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainMembership])) :*: S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))))

newDBInstance :: DBInstance Source #

Create a value of DBInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:engineVersion:DBInstance', dbInstance_engineVersion - Indicates the database engine version.

$sel:dbSecurityGroups:DBInstance', dbInstance_dbSecurityGroups - A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

$sel:deletionProtection:DBInstance', dbInstance_deletionProtection - Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

$sel:automaticRestartTime:DBInstance', dbInstance_automaticRestartTime - The time when a stopped DB instance is restarted automatically.

$sel:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Specifies whether the DB instance is encrypted.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

For more information, see CreateDBInstance.

$sel:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - A value that indicates that minor version patches are applied automatically.

$sel:dbInstanceArn:DBInstance', dbInstance_dbInstanceArn - The Amazon Resource Name (ARN) for the DB instance.

$sel:activityStreamKinesisStreamName:DBInstance', dbInstance_activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.

$sel:activityStreamEngineNativeAuditFieldsIncluded:DBInstance', dbInstance_activityStreamEngineNativeAuditFieldsIncluded - Indicates whether engine-native audit fields are included in the database activity stream.

$sel:masterUsername:DBInstance', dbInstance_masterUsername - Contains the master username for the DB instance.

$sel:readReplicaDBInstanceIdentifiers:DBInstance', dbInstance_readReplicaDBInstanceIdentifiers - Contains one or more identifiers of the read replicas associated with this DB instance.

$sel:iAMDatabaseAuthenticationEnabled:DBInstance', dbInstance_iAMDatabaseAuthenticationEnabled - 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.

$sel:monitoringRoleArn:DBInstance', dbInstance_monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

$sel:iops:DBInstance', dbInstance_iops - Specifies the Provisioned IOPS (I/O operations per second) value.

$sel:instanceCreateTime:DBInstance', dbInstance_instanceCreateTime - Provides the date and time the DB instance was created.

$sel:tagList:DBInstance', dbInstance_tagList - Undocumented member.

$sel:readReplicaSourceDBInstanceIdentifier:DBInstance', dbInstance_readReplicaSourceDBInstanceIdentifier - Contains the identifier of the source DB instance if this DB instance is a read replica.

$sel:replicaMode:DBInstance', dbInstance_replicaMode - The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

$sel:monitoringInterval:DBInstance', dbInstance_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

$sel:engine:DBInstance', dbInstance_engine - The name of the database engine to be used for this DB instance.

$sel:processorFeatures:DBInstance', dbInstance_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

$sel:latestRestorableTime:DBInstance', dbInstance_latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

$sel:dbInstanceClass:DBInstance', dbInstance_dbInstanceClass - Contains the name of the compute and memory capacity class of the DB instance.

$sel:promotionTier:DBInstance', dbInstance_promotionTier - 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 in the Amazon Aurora User Guide.

$sel:awsBackupRecoveryPointArn:DBInstance', dbInstance_awsBackupRecoveryPointArn - The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

$sel:licenseModel:DBInstance', dbInstance_licenseModel - License model information for this DB instance.

$sel:preferredMaintenanceWindow:DBInstance', dbInstance_preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

$sel:performanceInsightsRetentionPeriod:DBInstance', dbInstance_performanceInsightsRetentionPeriod - The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

$sel:cACertificateIdentifier:DBInstance', dbInstance_cACertificateIdentifier - The identifier of the CA certificate for this DB instance.

$sel:dbInstanceIdentifier:DBInstance', dbInstance_dbInstanceIdentifier - Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

$sel:characterSetName:DBInstance', dbInstance_characterSetName - If present, specifies the name of the character set that this instance is associated with.

$sel:maxAllocatedStorage:DBInstance', dbInstance_maxAllocatedStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

$sel:customerOwnedIpEnabled:DBInstance', dbInstance_customerOwnedIpEnabled - 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 in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

$sel:kmsKeyId:DBInstance', dbInstance_kmsKeyId - If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

$sel:preferredBackupWindow:DBInstance', dbInstance_preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

$sel:associatedRoles:DBInstance', dbInstance_associatedRoles - The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

$sel:availabilityZone:DBInstance', dbInstance_availabilityZone - Specifies the name of the Availability Zone the DB instance is located in.

$sel:vpcSecurityGroups:DBInstance', dbInstance_vpcSecurityGroups - Provides a list of VPC security group elements that the DB instance belongs to.

$sel:backupRetentionPeriod:DBInstance', dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

$sel:ncharCharacterSetName:DBInstance', dbInstance_ncharCharacterSetName - The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

$sel:performanceInsightsKMSKeyId:DBInstance', dbInstance_performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

$sel:dbSubnetGroup:DBInstance', dbInstance_dbSubnetGroup - Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

$sel:activityStreamMode:DBInstance', dbInstance_activityStreamMode - 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.

$sel:multiAZ:DBInstance', dbInstance_multiAZ - Specifies if the DB instance is a Multi-AZ deployment.

$sel:listenerEndpoint:DBInstance', dbInstance_listenerEndpoint - Specifies the listener connection endpoint for SQL Server Always On.

$sel:optionGroupMemberships:DBInstance', dbInstance_optionGroupMemberships - Provides the list of option group memberships for this DB instance.

$sel:enabledCloudwatchLogsExports:DBInstance', dbInstance_enabledCloudwatchLogsExports - 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 in the Amazon RDS User Guide.

$sel:enhancedMonitoringResourceArn:DBInstance', dbInstance_enhancedMonitoringResourceArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

$sel:secondaryAvailabilityZone:DBInstance', dbInstance_secondaryAvailabilityZone - If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

$sel:activityStreamStatus:DBInstance', dbInstance_activityStreamStatus - The status of the database activity stream.

$sel:performanceInsightsEnabled:DBInstance', dbInstance_performanceInsightsEnabled - True if Performance Insights is enabled for the DB instance, and otherwise false.

$sel:allocatedStorage:DBInstance', dbInstance_allocatedStorage - Specifies the allocated storage size specified in gibibytes (GiB).

$sel:dbiResourceId:DBInstance', dbInstance_dbiResourceId - 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 customer master key (CMK) for the DB instance is accessed.

$sel:dbParameterGroups:DBInstance', dbInstance_dbParameterGroups - Provides the list of DB parameter groups applied to this DB instance.

$sel:copyTagsToSnapshot:DBInstance', dbInstance_copyTagsToSnapshot - Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

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. For more information, see DBCluster.

$sel:timezone:DBInstance', dbInstance_timezone - The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

$sel:tdeCredentialArn:DBInstance', dbInstance_tdeCredentialArn - The ARN from the key store with which the instance is associated for TDE encryption.

$sel:dbInstanceAutomatedBackupsReplications:DBInstance', dbInstance_dbInstanceAutomatedBackupsReplications - The list of replicated automated backups associated with the DB instance.

$sel:endpoint:DBInstance', dbInstance_endpoint - Specifies the connection endpoint.

The endpoint might not be shown for instances whose status is creating.

$sel:dbInstanceStatus:DBInstance', dbInstance_dbInstanceStatus - Specifies the current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

$sel:dbInstancePort:DBInstance', dbInstance_dbInstancePort - 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.

$sel:activityStreamKmsKeyId:DBInstance', dbInstance_activityStreamKmsKeyId - 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 Amazon Web Services KMS customer master key (CMK).

$sel:pendingModifiedValues:DBInstance', dbInstance_pendingModifiedValues - 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.

$sel:readReplicaDBClusterIdentifiers:DBInstance', dbInstance_readReplicaDBClusterIdentifiers - 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

$sel:storageType:DBInstance', dbInstance_storageType - Specifies the storage type associated with DB instance.

$sel:statusInfos:DBInstance', dbInstance_statusInfos - The status of a read replica. If the instance isn't a read replica, this is blank.

$sel:domainMemberships:DBInstance', dbInstance_domainMemberships - The Active Directory Domain membership records associated with the DB instance.

$sel:dbName:DBInstance', dbInstance_dbName - The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

dbInstance_engineVersion :: Lens' DBInstance (Maybe Text) Source #

Indicates the database engine version.

dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership]) Source #

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

dbInstance_deletionProtection :: Lens' DBInstance (Maybe Bool) Source #

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

dbInstance_automaticRestartTime :: Lens' DBInstance (Maybe UTCTime) Source #

The time when a stopped DB instance is restarted automatically.

dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether the DB instance is encrypted.

dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text) Source #

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool) Source #

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

For more information, see CreateDBInstance.

dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source #

A value that indicates that minor version patches are applied automatically.

dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) for the DB instance.

dbInstance_activityStreamKinesisStreamName :: Lens' DBInstance (Maybe Text) Source #

The name of the Amazon Kinesis data stream used for the database activity stream.

dbInstance_activityStreamEngineNativeAuditFieldsIncluded :: Lens' DBInstance (Maybe Bool) Source #

Indicates whether engine-native audit fields are included in the database activity stream.

dbInstance_masterUsername :: Lens' DBInstance (Maybe Text) Source #

Contains the master username for the DB instance.

dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

Contains one or more identifiers of the read replicas associated with this DB instance.

dbInstance_iAMDatabaseAuthenticationEnabled :: Lens' DBInstance (Maybe Bool) Source #

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.

dbInstance_monitoringRoleArn :: Lens' DBInstance (Maybe Text) Source #

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

dbInstance_iops :: Lens' DBInstance (Maybe Int) Source #

Specifies the Provisioned IOPS (I/O operations per second) value.

dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source #

Provides the date and time the DB instance was created.

dbInstance_tagList :: Lens' DBInstance (Maybe [Tag]) Source #

Undocumented member.

dbInstance_readReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains the identifier of the source DB instance if this DB instance is a read replica.

dbInstance_replicaMode :: Lens' DBInstance (Maybe ReplicaMode) Source #

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

dbInstance_monitoringInterval :: Lens' DBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

dbInstance_engine :: Lens' DBInstance (Maybe Text) Source #

The name of the database engine to be used for this DB instance.

dbInstance_processorFeatures :: Lens' DBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source #

Specifies the latest time to which a database can be restored with point-in-time restore.

dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text) Source #

Contains the name of the compute and memory capacity class of the DB instance.

dbInstance_promotionTier :: Lens' DBInstance (Maybe Int) Source #

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 in the Amazon Aurora User Guide.

dbInstance_awsBackupRecoveryPointArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

dbInstance_licenseModel :: Lens' DBInstance (Maybe Text) Source #

License model information for this DB instance.

dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

dbInstance_performanceInsightsRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source #

The identifier of the CA certificate for this DB instance.

dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text) Source #

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

dbInstance_characterSetName :: Lens' DBInstance (Maybe Text) Source #

If present, specifies the name of the character set that this instance is associated with.

dbInstance_maxAllocatedStorage :: Lens' DBInstance (Maybe Int) Source #

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

dbInstance_customerOwnedIpEnabled :: Lens' DBInstance (Maybe Bool) Source #

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 in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text) Source #

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text) Source #

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole]) Source #

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text) Source #

Specifies the name of the Availability Zone the DB instance is located in.

dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of VPC security group elements that the DB instance belongs to.

dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #

Specifies the number of days for which automatic DB snapshots are retained.

dbInstance_ncharCharacterSetName :: Lens' DBInstance (Maybe Text) Source #

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

dbInstance_performanceInsightsKMSKeyId :: Lens' DBInstance (Maybe Text) Source #

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 Amazon Web Services KMS customer master key (CMK).

dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup) Source #

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

dbInstance_activityStreamMode :: Lens' DBInstance (Maybe ActivityStreamMode) Source #

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.

dbInstance_multiAZ :: Lens' DBInstance (Maybe Bool) Source #

Specifies if the DB instance is a Multi-AZ deployment.

dbInstance_listenerEndpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the listener connection endpoint for SQL Server Always On.

dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership]) Source #

Provides the list of option group memberships for this DB instance.

dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text]) Source #

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 in the Amazon RDS User Guide.

dbInstance_enhancedMonitoringResourceArn :: Lens' DBInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

dbInstance_secondaryAvailabilityZone :: Lens' DBInstance (Maybe Text) Source #

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

dbInstance_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool) Source #

True if Performance Insights is enabled for the DB instance, and otherwise false.

dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int) Source #

Specifies the allocated storage size specified in gibibytes (GiB).

dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text) Source #

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 customer master key (CMK) for the DB instance is accessed.

dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus]) Source #

Provides the list of DB parameter groups applied to this DB instance.

dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool) Source #

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

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. For more information, see DBCluster.

dbInstance_timezone :: Lens' DBInstance (Maybe Text) Source #

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text) Source #

The ARN from the key store with which the instance is associated for TDE encryption.

dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replicated automated backups associated with the DB instance.

dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint) Source #

Specifies the connection endpoint.

The endpoint might not be shown for instances whose status is creating.

dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text) Source #

Specifies the current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

dbInstance_dbInstancePort :: Lens' DBInstance (Maybe Int) Source #

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.

dbInstance_activityStreamKmsKeyId :: Lens' DBInstance (Maybe Text) Source #

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 Amazon Web Services KMS customer master key (CMK).

dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues) Source #

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.

dbInstance_readReplicaDBClusterIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #

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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

dbInstance_storageType :: Lens' DBInstance (Maybe Text) Source #

Specifies the storage type associated with DB instance.

dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo]) Source #

The status of a read replica. If the instance isn't a read replica, this is blank.

dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership]) Source #

The Active Directory Domain membership records associated with the DB instance.

dbInstance_dbName :: Lens' DBInstance (Maybe Text) Source #

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.