Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data DBInstance = DBInstance' {
- activityStreamEngineNativeAuditFieldsIncluded :: Maybe Bool
- activityStreamKinesisStreamName :: Maybe Text
- activityStreamKmsKeyId :: Maybe Text
- activityStreamMode :: Maybe ActivityStreamMode
- activityStreamPolicyStatus :: Maybe ActivityStreamPolicyStatus
- activityStreamStatus :: Maybe ActivityStreamStatus
- allocatedStorage :: Maybe Int
- associatedRoles :: Maybe [DBInstanceRole]
- autoMinorVersionUpgrade :: Maybe Bool
- automaticRestartTime :: Maybe ISO8601
- automationMode :: Maybe AutomationMode
- availabilityZone :: Maybe Text
- awsBackupRecoveryPointArn :: Maybe Text
- backupRetentionPeriod :: Maybe Int
- backupTarget :: Maybe Text
- cACertificateIdentifier :: Maybe Text
- certificateDetails :: Maybe CertificateDetails
- characterSetName :: Maybe Text
- copyTagsToSnapshot :: Maybe Bool
- customIamInstanceProfile :: Maybe Text
- customerOwnedIpEnabled :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- dbInstanceArn :: Maybe Text
- dbInstanceAutomatedBackupsReplications :: Maybe [DBInstanceAutomatedBackupsReplication]
- dbInstanceClass :: Maybe Text
- dbInstanceIdentifier :: Maybe Text
- dbInstanceStatus :: Maybe Text
- dbName :: Maybe Text
- dbParameterGroups :: Maybe [DBParameterGroupStatus]
- dbSecurityGroups :: Maybe [DBSecurityGroupMembership]
- dbSubnetGroup :: Maybe DBSubnetGroup
- dbSystemId :: Maybe Text
- dbInstancePort :: Maybe Int
- dbiResourceId :: Maybe Text
- deletionProtection :: Maybe Bool
- domainMemberships :: Maybe [DomainMembership]
- enabledCloudwatchLogsExports :: Maybe [Text]
- endpoint :: Maybe Endpoint
- engine :: Maybe Text
- engineVersion :: Maybe Text
- enhancedMonitoringResourceArn :: Maybe Text
- iAMDatabaseAuthenticationEnabled :: Maybe Bool
- instanceCreateTime :: Maybe ISO8601
- iops :: Maybe Int
- kmsKeyId :: Maybe Text
- latestRestorableTime :: Maybe ISO8601
- licenseModel :: Maybe Text
- listenerEndpoint :: Maybe Endpoint
- masterUserSecret :: Maybe MasterUserSecret
- masterUsername :: Maybe Text
- maxAllocatedStorage :: Maybe Int
- monitoringInterval :: Maybe Int
- monitoringRoleArn :: Maybe Text
- multiAZ :: Maybe Bool
- ncharCharacterSetName :: Maybe Text
- networkType :: Maybe Text
- optionGroupMemberships :: Maybe [OptionGroupMembership]
- pendingModifiedValues :: Maybe PendingModifiedValues
- performanceInsightsEnabled :: Maybe Bool
- performanceInsightsKMSKeyId :: Maybe Text
- performanceInsightsRetentionPeriod :: Maybe Int
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- processorFeatures :: Maybe [ProcessorFeature]
- promotionTier :: Maybe Int
- publiclyAccessible :: Maybe Bool
- readReplicaDBClusterIdentifiers :: Maybe [Text]
- readReplicaDBInstanceIdentifiers :: Maybe [Text]
- readReplicaSourceDBInstanceIdentifier :: Maybe Text
- replicaMode :: Maybe ReplicaMode
- resumeFullAutomationModeTime :: Maybe ISO8601
- secondaryAvailabilityZone :: Maybe Text
- statusInfos :: Maybe [DBInstanceStatusInfo]
- storageEncrypted :: Maybe Bool
- storageThroughput :: Maybe Int
- storageType :: Maybe Text
- tagList :: Maybe [Tag]
- tdeCredentialArn :: Maybe Text
- timezone :: Maybe Text
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- newDBInstance :: DBInstance
- dbInstance_activityStreamEngineNativeAuditFieldsIncluded :: Lens' DBInstance (Maybe Bool)
- dbInstance_activityStreamKinesisStreamName :: Lens' DBInstance (Maybe Text)
- dbInstance_activityStreamKmsKeyId :: Lens' DBInstance (Maybe Text)
- dbInstance_activityStreamMode :: Lens' DBInstance (Maybe ActivityStreamMode)
- dbInstance_activityStreamPolicyStatus :: Lens' DBInstance (Maybe ActivityStreamPolicyStatus)
- dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus)
- dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int)
- dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole])
- dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool)
- dbInstance_automaticRestartTime :: Lens' DBInstance (Maybe UTCTime)
- dbInstance_automationMode :: Lens' DBInstance (Maybe AutomationMode)
- dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text)
- dbInstance_awsBackupRecoveryPointArn :: Lens' DBInstance (Maybe Text)
- dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int)
- dbInstance_backupTarget :: Lens' DBInstance (Maybe Text)
- dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text)
- dbInstance_certificateDetails :: Lens' DBInstance (Maybe CertificateDetails)
- dbInstance_characterSetName :: Lens' DBInstance (Maybe Text)
- dbInstance_copyTagsToSnapshot :: Lens' DBInstance (Maybe Bool)
- dbInstance_customIamInstanceProfile :: Lens' DBInstance (Maybe Text)
- dbInstance_customerOwnedIpEnabled :: Lens' DBInstance (Maybe Bool)
- dbInstance_dbClusterIdentifier :: Lens' DBInstance (Maybe Text)
- dbInstance_dbInstanceArn :: Lens' DBInstance (Maybe Text)
- dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication])
- dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text)
- dbInstance_dbInstanceIdentifier :: Lens' DBInstance (Maybe Text)
- dbInstance_dbInstanceStatus :: Lens' DBInstance (Maybe Text)
- dbInstance_dbName :: Lens' DBInstance (Maybe Text)
- dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus])
- dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership])
- dbInstance_dbSubnetGroup :: Lens' DBInstance (Maybe DBSubnetGroup)
- dbInstance_dbSystemId :: Lens' DBInstance (Maybe Text)
- dbInstance_dbInstancePort :: Lens' DBInstance (Maybe Int)
- dbInstance_dbiResourceId :: Lens' DBInstance (Maybe Text)
- dbInstance_deletionProtection :: Lens' DBInstance (Maybe Bool)
- dbInstance_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership])
- dbInstance_enabledCloudwatchLogsExports :: Lens' DBInstance (Maybe [Text])
- dbInstance_endpoint :: Lens' DBInstance (Maybe Endpoint)
- dbInstance_engine :: Lens' DBInstance (Maybe Text)
- dbInstance_engineVersion :: Lens' DBInstance (Maybe Text)
- dbInstance_enhancedMonitoringResourceArn :: Lens' DBInstance (Maybe Text)
- dbInstance_iAMDatabaseAuthenticationEnabled :: Lens' DBInstance (Maybe Bool)
- dbInstance_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime)
- dbInstance_iops :: Lens' DBInstance (Maybe Int)
- dbInstance_kmsKeyId :: Lens' DBInstance (Maybe Text)
- dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime)
- dbInstance_licenseModel :: Lens' DBInstance (Maybe Text)
- dbInstance_listenerEndpoint :: Lens' DBInstance (Maybe Endpoint)
- dbInstance_masterUserSecret :: Lens' DBInstance (Maybe MasterUserSecret)
- dbInstance_masterUsername :: Lens' DBInstance (Maybe Text)
- dbInstance_maxAllocatedStorage :: Lens' DBInstance (Maybe Int)
- dbInstance_monitoringInterval :: Lens' DBInstance (Maybe Int)
- dbInstance_monitoringRoleArn :: Lens' DBInstance (Maybe Text)
- dbInstance_multiAZ :: Lens' DBInstance (Maybe Bool)
- dbInstance_ncharCharacterSetName :: Lens' DBInstance (Maybe Text)
- dbInstance_networkType :: Lens' DBInstance (Maybe Text)
- dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership])
- dbInstance_pendingModifiedValues :: Lens' DBInstance (Maybe PendingModifiedValues)
- dbInstance_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool)
- dbInstance_performanceInsightsKMSKeyId :: Lens' DBInstance (Maybe Text)
- dbInstance_performanceInsightsRetentionPeriod :: Lens' DBInstance (Maybe Int)
- dbInstance_preferredBackupWindow :: Lens' DBInstance (Maybe Text)
- dbInstance_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text)
- dbInstance_processorFeatures :: Lens' DBInstance (Maybe [ProcessorFeature])
- dbInstance_promotionTier :: Lens' DBInstance (Maybe Int)
- dbInstance_publiclyAccessible :: Lens' DBInstance (Maybe Bool)
- dbInstance_readReplicaDBClusterIdentifiers :: Lens' DBInstance (Maybe [Text])
- dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text])
- dbInstance_readReplicaSourceDBInstanceIdentifier :: Lens' DBInstance (Maybe Text)
- dbInstance_replicaMode :: Lens' DBInstance (Maybe ReplicaMode)
- dbInstance_resumeFullAutomationModeTime :: Lens' DBInstance (Maybe UTCTime)
- dbInstance_secondaryAvailabilityZone :: Lens' DBInstance (Maybe Text)
- dbInstance_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo])
- dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool)
- dbInstance_storageThroughput :: Lens' DBInstance (Maybe Int)
- dbInstance_storageType :: Lens' DBInstance (Maybe Text)
- dbInstance_tagList :: Lens' DBInstance (Maybe [Tag])
- dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text)
- dbInstance_timezone :: Lens' DBInstance (Maybe Text)
- dbInstance_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership])
Documentation
data DBInstance Source #
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
.
See: newDBInstance
smart constructor.
DBInstance' | |
|
Instances
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:activityStreamEngineNativeAuditFieldsIncluded:DBInstance'
, dbInstance_activityStreamEngineNativeAuditFieldsIncluded
- Indicates whether engine-native audit fields are included in the
database activity stream.
$sel:activityStreamKinesisStreamName:DBInstance'
, dbInstance_activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database
activity stream.
$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 KMS
key.
$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:activityStreamPolicyStatus:DBInstance'
, dbInstance_activityStreamPolicyStatus
- The status of the policy state of the activity stream.
$sel:activityStreamStatus:DBInstance'
, dbInstance_activityStreamStatus
- The status of the database activity stream.
DBInstance
, dbInstance_allocatedStorage
- Specifies the allocated storage size specified in gibibytes (GiB).
$sel:associatedRoles:DBInstance'
, dbInstance_associatedRoles
- The Amazon Web Services Identity and Access Management (IAM) roles
associated with the DB instance.
$sel:autoMinorVersionUpgrade:DBInstance'
, dbInstance_autoMinorVersionUpgrade
- A value that indicates that minor version patches are applied
automatically.
$sel:automaticRestartTime:DBInstance'
, dbInstance_automaticRestartTime
- The time when a stopped DB instance is restarted automatically.
DBInstance
, dbInstance_automationMode
- 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
.
$sel:availabilityZone:DBInstance'
, dbInstance_availabilityZone
- Specifies the name of the Availability Zone the DB instance is located
in.
$sel:awsBackupRecoveryPointArn:DBInstance'
, dbInstance_awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web
Services Backup.
DBInstance
, dbInstance_backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.
$sel:backupTarget:DBInstance'
, dbInstance_backupTarget
- Specifies where automated backups and manual snapshots are stored:
Amazon Web Services Outposts or the Amazon Web Services Region.
DBInstance
, dbInstance_cACertificateIdentifier
- The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
$sel:certificateDetails:DBInstance'
, dbInstance_certificateDetails
- The details of the DB instance's server certificate.
$sel:characterSetName:DBInstance'
, dbInstance_characterSetName
- If present, specifies the name of the character set that this instance
is associated with.
$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:customIamInstanceProfile:DBInstance'
, dbInstance_customIamInstanceProfile
- 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 in the Amazon RDS User Guide.
$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: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:dbInstanceArn:DBInstance'
, dbInstance_dbInstanceArn
- The Amazon Resource Name (ARN) for the DB instance.
$sel:dbInstanceAutomatedBackupsReplications:DBInstance'
, dbInstance_dbInstanceAutomatedBackupsReplications
- The list of replicated automated backups associated with the DB
instance.
DBInstance
, dbInstance_dbInstanceClass
- Contains the name of the compute and memory capacity class of the DB
instance.
DBInstance
, dbInstance_dbInstanceIdentifier
- Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.
$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: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.
$sel:dbParameterGroups:DBInstance'
, dbInstance_dbParameterGroups
- Provides the list of DB parameter groups applied to this DB instance.
$sel:dbSecurityGroups:DBInstance'
, dbInstance_dbSecurityGroups
- A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
$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:dbSystemId:DBInstance'
, dbInstance_dbSystemId
- The Oracle system ID (Oracle SID) for a container database (CDB). The
Oracle SID is also the name of the CDB. This setting is valid for RDS
Custom only.
$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: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 key for the DB instance is
accessed.
$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:domainMemberships:DBInstance'
, dbInstance_domainMemberships
- The Active Directory Domain membership records associated with the 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:endpoint:DBInstance'
, dbInstance_endpoint
- Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is
creating
.
$sel:engine:DBInstance'
, dbInstance_engine
- The name of the database engine to be used for this DB instance.
DBInstance
, dbInstance_engineVersion
- Indicates the database engine version.
$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.
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:instanceCreateTime:DBInstance'
, dbInstance_instanceCreateTime
- Provides the date and time the DB instance was created.
DBInstance
, dbInstance_iops
- Specifies the Provisioned IOPS (I/O operations per second) value.
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 KMS key.
$sel:latestRestorableTime:DBInstance'
, dbInstance_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
DBInstance
, dbInstance_licenseModel
- License model information for this DB instance. This setting doesn't
apply to RDS Custom.
$sel:listenerEndpoint:DBInstance'
, dbInstance_listenerEndpoint
- Specifies the listener connection endpoint for SQL Server Always On.
$sel:masterUserSecret:DBInstance'
, dbInstance_masterUserSecret
- Contains the secret managed by RDS in Amazon Web Services Secrets
Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
$sel:masterUsername:DBInstance'
, dbInstance_masterUsername
- Contains the master username for the DB instance.
$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:monitoringInterval:DBInstance'
, dbInstance_monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.
$sel:monitoringRoleArn:DBInstance'
, dbInstance_monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring
metrics to Amazon CloudWatch Logs.
DBInstance
, dbInstance_multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. This setting
doesn't apply to RDS Custom.
$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:networkType:DBInstance'
, dbInstance_networkType
- 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 in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
$sel:optionGroupMemberships:DBInstance'
, dbInstance_optionGroupMemberships
- Provides the list of option group memberships for this DB instance.
$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:performanceInsightsEnabled:DBInstance'
, dbInstance_performanceInsightsEnabled
- True if Performance Insights is enabled for the DB instance, and
otherwise false.
$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 KMS key.
$sel:performanceInsightsRetentionPeriod:DBInstance'
, dbInstance_performanceInsightsRetentionPeriod
- 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
$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:preferredMaintenanceWindow:DBInstance'
, dbInstance_preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).
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: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:publiclyAccessible:DBInstance'
, dbInstance_publiclyAccessible
- Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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: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 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.
$sel:readReplicaDBInstanceIdentifiers:DBInstance'
, dbInstance_readReplicaDBInstanceIdentifiers
- Contains one or more identifiers of the read replicas associated with
this DB instance.
$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.
DBInstance
, dbInstance_resumeFullAutomationModeTime
- 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.
$sel:secondaryAvailabilityZone:DBInstance'
, dbInstance_secondaryAvailabilityZone
- If present, specifies the name of the secondary Availability Zone for a
DB instance with multi-AZ support.
$sel:statusInfos:DBInstance'
, dbInstance_statusInfos
- The status of a read replica. If the instance isn't a read replica,
this is blank.
$sel:storageEncrypted:DBInstance'
, dbInstance_storageEncrypted
- Specifies whether the DB instance is encrypted.
DBInstance
, dbInstance_storageThroughput
- Specifies the storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
DBInstance
, dbInstance_storageType
- Specifies the storage type associated with the DB instance.
$sel:tagList:DBInstance'
, dbInstance_tagList
- Undocumented member.
$sel:tdeCredentialArn:DBInstance'
, dbInstance_tdeCredentialArn
- The ARN from the key store with which the instance is associated for TDE
encryption.
$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:vpcSecurityGroups:DBInstance'
, dbInstance_vpcSecurityGroups
- Provides a list of VPC security group elements that the DB instance
belongs to.
dbInstance_activityStreamEngineNativeAuditFieldsIncluded :: Lens' DBInstance (Maybe Bool) Source #
Indicates whether engine-native audit fields are included in the database activity stream.
dbInstance_activityStreamKinesisStreamName :: Lens' DBInstance (Maybe Text) Source #
The name of the Amazon Kinesis data stream used for the database activity stream.
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 KMS key.
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_activityStreamPolicyStatus :: Lens' DBInstance (Maybe ActivityStreamPolicyStatus) Source #
The status of the policy state of the activity stream.
dbInstance_activityStreamStatus :: Lens' DBInstance (Maybe ActivityStreamStatus) Source #
The status of the database activity stream.
dbInstance_allocatedStorage :: Lens' DBInstance (Maybe Int) Source #
Specifies the allocated storage size specified in gibibytes (GiB).
dbInstance_associatedRoles :: Lens' DBInstance (Maybe [DBInstanceRole]) Source #
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
dbInstance_autoMinorVersionUpgrade :: Lens' DBInstance (Maybe Bool) Source #
A value that indicates that minor version patches are applied automatically.
dbInstance_automaticRestartTime :: Lens' DBInstance (Maybe UTCTime) Source #
The time when a stopped DB instance is restarted automatically.
dbInstance_automationMode :: Lens' DBInstance (Maybe AutomationMode) Source #
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
.
dbInstance_availabilityZone :: Lens' DBInstance (Maybe Text) Source #
Specifies the name of the Availability Zone the DB instance is located in.
dbInstance_awsBackupRecoveryPointArn :: Lens' DBInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
dbInstance_backupRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #
Specifies the number of days for which automatic DB snapshots are retained.
dbInstance_backupTarget :: Lens' DBInstance (Maybe Text) Source #
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
dbInstance_cACertificateIdentifier :: Lens' DBInstance (Maybe Text) Source #
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
dbInstance_certificateDetails :: Lens' DBInstance (Maybe CertificateDetails) Source #
The details of the DB instance's server certificate.
dbInstance_characterSetName :: Lens' DBInstance (Maybe Text) Source #
If present, specifies the name of the character set that this instance is associated with.
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_customIamInstanceProfile :: Lens' DBInstance (Maybe Text) Source #
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 in the Amazon RDS User Guide.
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_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_dbInstanceArn :: Lens' DBInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) for the DB instance.
dbInstance_dbInstanceAutomatedBackupsReplications :: Lens' DBInstance (Maybe [DBInstanceAutomatedBackupsReplication]) Source #
The list of replicated automated backups associated with the DB instance.
dbInstance_dbInstanceClass :: Lens' DBInstance (Maybe Text) Source #
Contains the name of the compute and memory capacity class of the 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_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_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.
dbInstance_dbParameterGroups :: Lens' DBInstance (Maybe [DBParameterGroupStatus]) Source #
Provides the list of DB parameter groups applied to this DB instance.
dbInstance_dbSecurityGroups :: Lens' DBInstance (Maybe [DBSecurityGroupMembership]) Source #
A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
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_dbSystemId :: Lens' DBInstance (Maybe Text) Source #
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.
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_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 key for the DB instance is accessed.
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_domainMemberships :: Lens' DBInstance (Maybe [DomainMembership]) Source #
The Active Directory Domain membership records associated with the 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_endpoint :: Lens' DBInstance (Maybe Endpoint) Source #
Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is
creating
.
dbInstance_engine :: Lens' DBInstance (Maybe Text) Source #
The name of the database engine to be used for this DB instance.
dbInstance_engineVersion :: Lens' DBInstance (Maybe Text) Source #
Indicates the database engine version.
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_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_instanceCreateTime :: Lens' DBInstance (Maybe UTCTime) Source #
Provides the date and time the DB instance was created.
dbInstance_iops :: Lens' DBInstance (Maybe Int) Source #
Specifies the Provisioned IOPS (I/O operations per second) value.
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 KMS key.
dbInstance_latestRestorableTime :: Lens' DBInstance (Maybe UTCTime) Source #
Specifies the latest time to which a database can be restored with point-in-time restore.
dbInstance_licenseModel :: Lens' DBInstance (Maybe Text) Source #
License model information for this DB instance. This setting doesn't apply to RDS Custom.
dbInstance_listenerEndpoint :: Lens' DBInstance (Maybe Endpoint) Source #
Specifies the listener connection endpoint for SQL Server Always On.
dbInstance_masterUserSecret :: Lens' DBInstance (Maybe MasterUserSecret) Source #
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
dbInstance_masterUsername :: Lens' DBInstance (Maybe Text) Source #
Contains the master username for the DB instance.
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_monitoringInterval :: Lens' DBInstance (Maybe Int) Source #
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
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_multiAZ :: Lens' DBInstance (Maybe Bool) Source #
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
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_networkType :: Lens' DBInstance (Maybe Text) Source #
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 in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
dbInstance_optionGroupMemberships :: Lens' DBInstance (Maybe [OptionGroupMembership]) Source #
Provides the list of option group memberships for this DB instance.
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_performanceInsightsEnabled :: Lens' DBInstance (Maybe Bool) Source #
True if Performance Insights is enabled for the DB instance, and otherwise false.
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 KMS key.
dbInstance_performanceInsightsRetentionPeriod :: Lens' DBInstance (Maybe Int) Source #
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
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_preferredMaintenanceWindow :: Lens' DBInstance (Maybe Text) Source #
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
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_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_publiclyAccessible :: Lens' DBInstance (Maybe Bool) Source #
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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_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 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.
dbInstance_readReplicaDBInstanceIdentifiers :: Lens' DBInstance (Maybe [Text]) Source #
Contains one or more identifiers of the read replicas associated with this DB instance.
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_resumeFullAutomationModeTime :: Lens' DBInstance (Maybe UTCTime) Source #
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.
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_statusInfos :: Lens' DBInstance (Maybe [DBInstanceStatusInfo]) Source #
The status of a read replica. If the instance isn't a read replica, this is blank.
dbInstance_storageEncrypted :: Lens' DBInstance (Maybe Bool) Source #
Specifies whether the DB instance is encrypted.
dbInstance_storageThroughput :: Lens' DBInstance (Maybe Int) Source #
Specifies the storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
dbInstance_storageType :: Lens' DBInstance (Maybe Text) Source #
Specifies the storage type associated with the DB instance.
dbInstance_tagList :: Lens' DBInstance (Maybe [Tag]) Source #
Undocumented member.
dbInstance_tdeCredentialArn :: Lens' DBInstance (Maybe Text) Source #
The ARN from the key store with which the instance is associated for TDE encryption.
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_vpcSecurityGroups :: Lens' DBInstance (Maybe [VpcSecurityGroupMembership]) Source #
Provides a list of VPC security group elements that the DB instance belongs to.