amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.Types.DBCluster

Description

 
Synopsis

Documentation

data DBCluster Source #

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

See: newDBCluster smart constructor.

Constructors

DBCluster' 

Fields

  • activityStreamKinesisStreamName :: Maybe Text

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

  • 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 KMS key.

  • activityStreamMode :: Maybe ActivityStreamMode

    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

  • activityStreamStatus :: Maybe ActivityStreamStatus

    The status of the database activity stream.

  • allocatedStorage :: Maybe Int

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

  • associatedRoles :: Maybe [DBClusterRole]

    Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

  • autoMinorVersionUpgrade :: Maybe Bool

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • automaticRestartTime :: Maybe ISO8601

    The time when a stopped DB cluster is restarted automatically.

  • availabilityZones :: Maybe [Text]

    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

  • backtrackConsumedChangeRecords :: Maybe Integer

    The number of change records stored for Backtrack.

  • backtrackWindow :: Maybe Integer

    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

  • backupRetentionPeriod :: Maybe Int

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

  • capacity :: Maybe Int

    The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

    For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

  • characterSetName :: Maybe Text

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

  • cloneGroupId :: Maybe Text

    Identifies the clone group to which the DB cluster is associated.

  • clusterCreateTime :: Maybe ISO8601

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

  • copyTagsToSnapshot :: Maybe Bool

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

  • crossAccountClone :: Maybe Bool

    Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

  • customEndpoints :: Maybe [Text]

    Identifies all custom endpoints associated with the cluster.

  • dbClusterArn :: Maybe Text

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

  • dbClusterIdentifier :: Maybe Text

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

  • dbClusterInstanceClass :: Maybe Text

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • dbClusterMembers :: Maybe [DBClusterMember]

    Provides the list of instances that make up the DB cluster.

  • dbClusterOptionGroupMemberships :: Maybe [DBClusterOptionGroupStatus]

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

  • dbClusterParameterGroup :: Maybe Text

    Specifies the name of the DB cluster parameter group for the DB cluster.

  • dbSubnetGroup :: Maybe Text

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

  • dbSystemId :: Maybe Text

    Reserved for future use.

  • databaseName :: Maybe Text

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

  • dbClusterResourceId :: Maybe Text

    The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

  • deletionProtection :: Maybe Bool

    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

  • domainMemberships :: Maybe [DomainMembership]

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

  • earliestBacktrackTime :: Maybe ISO8601

    The earliest time to which a DB cluster can be backtracked.

  • earliestRestorableTime :: Maybe ISO8601

    The earliest time to which a database can be restored with point-in-time restore.

  • enabledCloudwatchLogsExports :: Maybe [Text]

    A list of log types that this DB cluster 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 Aurora User Guide.

  • endpoint :: Maybe Text

    Specifies the connection endpoint for the primary instance of the DB cluster.

  • engine :: Maybe Text

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

  • engineMode :: Maybe Text

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

    For more information, see CreateDBCluster.

  • engineVersion :: Maybe Text

    Indicates the database engine version.

  • globalWriteForwardingRequested :: Maybe Bool

    Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

  • globalWriteForwardingStatus :: Maybe WriteForwardingStatus

    Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

  • hostedZoneId :: Maybe Text

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

  • httpEndpointEnabled :: Maybe Bool

    A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

    For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

  • iAMDatabaseAuthenticationEnabled :: Maybe Bool

    A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

  • iops :: Maybe Int

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • kmsKeyId :: Maybe Text

    If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

  • latestRestorableTime :: Maybe ISO8601

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

  • masterUserSecret :: Maybe 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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

  • masterUsername :: Maybe Text

    Contains the master username for the DB cluster.

  • monitoringInterval :: Maybe Int

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • monitoringRoleArn :: Maybe Text

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • multiAZ :: Maybe Bool

    Specifies whether the DB cluster has instances in multiple Availability Zones.

  • networkType :: Maybe Text

    The network type of the DB instance.

    Valid values:

    • IPV4
    • DUAL

    The network type is determined by the DBSubnetGroup specified for the DB cluster. 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 Aurora User Guide.

    This setting is only for Aurora DB clusters.

  • pendingModifiedValues :: Maybe ClusterPendingModifiedValues

    A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

  • percentProgress :: Maybe Text

    Specifies the progress of the operation as a percentage.

  • performanceInsightsEnabled :: Maybe Bool

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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • 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 KMS key.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • performanceInsightsRetentionPeriod :: Maybe Int

    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

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • port :: Maybe Int

    Specifies the port that the database engine is listening on.

  • preferredBackupWindow :: Maybe Text

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

  • preferredMaintenanceWindow :: Maybe Text

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

  • publiclyAccessible :: Maybe Bool

    Specifies the accessibility options for the DB instance.

    When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

    When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

    For more information, see CreateDBInstance.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • readReplicaIdentifiers :: Maybe [Text]

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

  • readerEndpoint :: Maybe Text

    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

    If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

  • replicationSourceIdentifier :: Maybe Text

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

  • scalingConfigurationInfo :: Maybe ScalingConfigurationInfo
     
  • serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfigurationInfo
     
  • status :: Maybe Text

    Specifies the current state of this DB cluster.

  • storageEncrypted :: Maybe Bool

    Specifies whether the DB cluster is encrypted.

  • storageType :: Maybe Text

    The storage type associated with the DB cluster.

    This setting is only for non-Aurora Multi-AZ DB clusters.

  • tagList :: Maybe [Tag]
     
  • vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]

    Provides a list of VPC security groups that the DB cluster belongs to.

Instances

Instances details
FromXML DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

parseXML :: [Node] -> Either String DBCluster #

Generic DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Associated Types

type Rep DBCluster :: Type -> Type #

Methods

from :: DBCluster -> Rep DBCluster x #

to :: Rep DBCluster x -> DBCluster #

Read DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

readsPrec :: Int -> ReadS DBCluster #

readList :: ReadS [DBCluster] #

readPrec :: ReadPrec DBCluster #

readListPrec :: ReadPrec [DBCluster] #

Show DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

showsPrec :: Int -> DBCluster -> ShowS #

show :: DBCluster -> String #

showList :: [DBCluster] -> ShowS #

NFData DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

rnf :: DBCluster -> () #

Eq DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

(==) :: DBCluster -> DBCluster -> Bool #

(/=) :: DBCluster -> DBCluster -> Bool #

Hashable DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

Methods

hashWithSalt :: Int -> DBCluster -> Int #

hash :: DBCluster -> Int #

type Rep DBCluster Source # 
Instance details

Defined in Amazonka.RDS.Types.DBCluster

type Rep DBCluster = D1 ('MetaData "DBCluster" "Amazonka.RDS.Types.DBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBCluster'" 'PrefixI 'True) ((((((S1 ('MetaSel ('Just "activityStreamKinesisStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "activityStreamKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "activityStreamMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamMode)) :*: S1 ('MetaSel ('Just "activityStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActivityStreamStatus)))) :*: ((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "associatedRoles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterRole]))) :*: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "automaticRestartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :*: (((S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "backtrackConsumedChangeRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "backtrackWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cloneGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))) :*: ((((S1 ('MetaSel ('Just "crossAccountClone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "customEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "dbClusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbClusterInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterMember]))) :*: (S1 ('MetaSel ('Just "dbClusterOptionGroupMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterOptionGroupStatus])) :*: (S1 ('MetaSel ('Just "dbClusterParameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSubnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "dbSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dbClusterResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "domainMemberships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainMembership])) :*: S1 ('MetaSel ('Just "earliestBacktrackTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "earliestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "enabledCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))) :*: (((((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalWriteForwardingRequested") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "globalWriteForwardingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WriteForwardingStatus)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpEndpointEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "masterUserSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MasterUserSecret)) :*: S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingModifiedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterPendingModifiedValues))))))) :*: ((((S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "readReplicaIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "readerEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicationSourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "scalingConfigurationInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScalingConfigurationInfo)) :*: S1 ('MetaSel ('Just "serverlessV2ScalingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerlessV2ScalingConfigurationInfo)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "vpcSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcSecurityGroupMembership]))))))))))

newDBCluster :: DBCluster Source #

Create a value of DBCluster 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:activityStreamKinesisStreamName:DBCluster', dbCluster_activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.

$sel:activityStreamKmsKeyId:DBCluster', dbCluster_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:DBCluster', dbCluster_activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

$sel:activityStreamStatus:DBCluster', dbCluster_activityStreamStatus - The status of the database activity stream.

DBCluster, dbCluster_allocatedStorage - For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

$sel:associatedRoles:DBCluster', dbCluster_associatedRoles - Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

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

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:automaticRestartTime:DBCluster', dbCluster_automaticRestartTime - The time when a stopped DB cluster is restarted automatically.

$sel:availabilityZones:DBCluster', dbCluster_availabilityZones - Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

$sel:backtrackConsumedChangeRecords:DBCluster', dbCluster_backtrackConsumedChangeRecords - The number of change records stored for Backtrack.

$sel:backtrackWindow:DBCluster', dbCluster_backtrackWindow - The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

DBCluster, dbCluster_backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

$sel:capacity:DBCluster', dbCluster_capacity - The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

$sel:characterSetName:DBCluster', dbCluster_characterSetName - If present, specifies the name of the character set that this cluster is associated with.

$sel:cloneGroupId:DBCluster', dbCluster_cloneGroupId - Identifies the clone group to which the DB cluster is associated.

$sel:clusterCreateTime:DBCluster', dbCluster_clusterCreateTime - Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

$sel:copyTagsToSnapshot:DBCluster', dbCluster_copyTagsToSnapshot - Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

$sel:crossAccountClone:DBCluster', dbCluster_crossAccountClone - Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

$sel:customEndpoints:DBCluster', dbCluster_customEndpoints - Identifies all custom endpoints associated with the cluster.

$sel:dbClusterArn:DBCluster', dbCluster_dbClusterArn - The Amazon Resource Name (ARN) for the DB cluster.

DBCluster, dbCluster_dbClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

$sel:dbClusterInstanceClass:DBCluster', dbCluster_dbClusterInstanceClass - The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:dbClusterMembers:DBCluster', dbCluster_dbClusterMembers - Provides the list of instances that make up the DB cluster.

$sel:dbClusterOptionGroupMemberships:DBCluster', dbCluster_dbClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.

$sel:dbClusterParameterGroup:DBCluster', dbCluster_dbClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.

$sel:dbSubnetGroup:DBCluster', dbCluster_dbSubnetGroup - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

$sel:dbSystemId:DBCluster', dbCluster_dbSystemId - Reserved for future use.

$sel:databaseName:DBCluster', dbCluster_databaseName - Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

$sel:dbClusterResourceId:DBCluster', dbCluster_dbClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

$sel:deletionProtection:DBCluster', dbCluster_deletionProtection - Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

$sel:domainMemberships:DBCluster', dbCluster_domainMemberships - The Active Directory Domain membership records associated with the DB cluster.

$sel:earliestBacktrackTime:DBCluster', dbCluster_earliestBacktrackTime - The earliest time to which a DB cluster can be backtracked.

$sel:earliestRestorableTime:DBCluster', dbCluster_earliestRestorableTime - The earliest time to which a database can be restored with point-in-time restore.

$sel:enabledCloudwatchLogsExports:DBCluster', dbCluster_enabledCloudwatchLogsExports - A list of log types that this DB cluster 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 Aurora User Guide.

$sel:endpoint:DBCluster', dbCluster_endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.

$sel:engine:DBCluster', dbCluster_engine - The name of the database engine to be used for this DB cluster.

$sel:engineMode:DBCluster', dbCluster_engineMode - The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

DBCluster, dbCluster_engineVersion - Indicates the database engine version.

$sel:globalWriteForwardingRequested:DBCluster', dbCluster_globalWriteForwardingRequested - Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

$sel:globalWriteForwardingStatus:DBCluster', dbCluster_globalWriteForwardingStatus - Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

$sel:hostedZoneId:DBCluster', dbCluster_hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

$sel:httpEndpointEnabled:DBCluster', dbCluster_httpEndpointEnabled - A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

DBCluster, dbCluster_iAMDatabaseAuthenticationEnabled - A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

DBCluster, dbCluster_iops - The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

DBCluster, dbCluster_kmsKeyId - If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

$sel:masterUserSecret:DBCluster', dbCluster_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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

$sel:masterUsername:DBCluster', dbCluster_masterUsername - Contains the master username for the DB cluster.

$sel:monitoringInterval:DBCluster', dbCluster_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

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

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:multiAZ:DBCluster', dbCluster_multiAZ - Specifies whether the DB cluster has instances in multiple Availability Zones.

$sel:networkType:DBCluster', dbCluster_networkType - The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. 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 Aurora User Guide.

This setting is only for Aurora DB clusters.

$sel:pendingModifiedValues:DBCluster', dbCluster_pendingModifiedValues - A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

$sel:percentProgress:DBCluster', dbCluster_percentProgress - Specifies the progress of the operation as a percentage.

$sel:performanceInsightsEnabled:DBCluster', dbCluster_performanceInsightsEnabled - True if Performance Insights is enabled for the DB cluster, and otherwise false.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:performanceInsightsKMSKeyId:DBCluster', dbCluster_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.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:performanceInsightsRetentionPeriod:DBCluster', dbCluster_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

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:port:DBCluster', dbCluster_port - Specifies the port that the database engine is listening on.

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

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

$sel:publiclyAccessible:DBCluster', dbCluster_publiclyAccessible - Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:readReplicaIdentifiers:DBCluster', dbCluster_readReplicaIdentifiers - Contains one or more identifiers of the read replicas associated with this DB cluster.

$sel:readerEndpoint:DBCluster', dbCluster_readerEndpoint - The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

$sel:replicationSourceIdentifier:DBCluster', dbCluster_replicationSourceIdentifier - Contains the identifier of the source DB cluster if this DB cluster is a read replica.

$sel:scalingConfigurationInfo:DBCluster', dbCluster_scalingConfigurationInfo - Undocumented member.

$sel:serverlessV2ScalingConfiguration:DBCluster', dbCluster_serverlessV2ScalingConfiguration - Undocumented member.

DBCluster, dbCluster_status - Specifies the current state of this DB cluster.

$sel:storageEncrypted:DBCluster', dbCluster_storageEncrypted - Specifies whether the DB cluster is encrypted.

$sel:storageType:DBCluster', dbCluster_storageType - The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

$sel:tagList:DBCluster', dbCluster_tagList - Undocumented member.

$sel:vpcSecurityGroups:DBCluster', dbCluster_vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.

dbCluster_activityStreamKinesisStreamName :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_activityStreamKmsKeyId :: Lens' DBCluster (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.

dbCluster_activityStreamMode :: Lens' DBCluster (Maybe ActivityStreamMode) Source #

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

dbCluster_activityStreamStatus :: Lens' DBCluster (Maybe ActivityStreamStatus) Source #

The status of the database activity stream.

dbCluster_allocatedStorage :: Lens' DBCluster (Maybe Int) Source #

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole]) Source #

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

dbCluster_autoMinorVersionUpgrade :: Lens' DBCluster (Maybe Bool) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_automaticRestartTime :: Lens' DBCluster (Maybe UTCTime) Source #

The time when a stopped DB cluster is restarted automatically.

dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text]) Source #

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

dbCluster_backtrackConsumedChangeRecords :: Lens' DBCluster (Maybe Integer) Source #

The number of change records stored for Backtrack.

dbCluster_backtrackWindow :: Lens' DBCluster (Maybe Integer) Source #

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #

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

dbCluster_capacity :: Lens' DBCluster (Maybe Int) Source #

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

dbCluster_characterSetName :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_cloneGroupId :: Lens' DBCluster (Maybe Text) Source #

Identifies the clone group to which the DB cluster is associated.

dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime) Source #

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

dbCluster_copyTagsToSnapshot :: Lens' DBCluster (Maybe Bool) Source #

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

dbCluster_crossAccountClone :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

dbCluster_customEndpoints :: Lens' DBCluster (Maybe [Text]) Source #

Identifies all custom endpoints associated with the cluster.

dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbClusterInstanceClass :: Lens' DBCluster (Maybe Text) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember]) Source #

Provides the list of instances that make up the DB cluster.

dbCluster_dbClusterOptionGroupMemberships :: Lens' DBCluster (Maybe [DBClusterOptionGroupStatus]) Source #

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

dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source #

Specifies the name of the DB cluster parameter group for the DB cluster.

dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbSystemId :: Lens' DBCluster (Maybe Text) Source #

Reserved for future use.

dbCluster_databaseName :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text) Source #

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool) Source #

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

dbCluster_domainMemberships :: Lens' DBCluster (Maybe [DomainMembership]) Source #

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

dbCluster_earliestBacktrackTime :: Lens' DBCluster (Maybe UTCTime) Source #

The earliest time to which a DB cluster can be backtracked.

dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

The earliest time to which a database can be restored with point-in-time restore.

dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text]) Source #

A list of log types that this DB cluster 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 Aurora User Guide.

dbCluster_endpoint :: Lens' DBCluster (Maybe Text) Source #

Specifies the connection endpoint for the primary instance of the DB cluster.

dbCluster_engine :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_engineMode :: Lens' DBCluster (Maybe Text) Source #

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

dbCluster_engineVersion :: Lens' DBCluster (Maybe Text) Source #

Indicates the database engine version.

dbCluster_globalWriteForwardingRequested :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

dbCluster_globalWriteForwardingStatus :: Lens' DBCluster (Maybe WriteForwardingStatus) Source #

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text) Source #

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

dbCluster_httpEndpointEnabled :: Lens' DBCluster (Maybe Bool) Source #

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

dbCluster_iAMDatabaseAuthenticationEnabled :: Lens' DBCluster (Maybe Bool) Source #

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

dbCluster_iops :: Lens' DBCluster (Maybe Int) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text) Source #

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #

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

dbCluster_masterUserSecret :: Lens' DBCluster (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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

dbCluster_masterUsername :: Lens' DBCluster (Maybe Text) Source #

Contains the master username for the DB cluster.

dbCluster_monitoringInterval :: Lens' DBCluster (Maybe Int) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_monitoringRoleArn :: Lens' DBCluster (Maybe Text) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster has instances in multiple Availability Zones.

dbCluster_networkType :: Lens' DBCluster (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 cluster. 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 Aurora User Guide.

This setting is only for Aurora DB clusters.

dbCluster_pendingModifiedValues :: Lens' DBCluster (Maybe ClusterPendingModifiedValues) Source #

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

dbCluster_percentProgress :: Lens' DBCluster (Maybe Text) Source #

Specifies the progress of the operation as a percentage.

dbCluster_performanceInsightsEnabled :: Lens' DBCluster (Maybe Bool) Source #

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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_performanceInsightsKMSKeyId :: Lens' DBCluster (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.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_performanceInsightsRetentionPeriod :: Lens' DBCluster (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

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_port :: Lens' DBCluster (Maybe Int) Source #

Specifies the port that the database engine is listening on.

dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_publiclyAccessible :: Lens' DBCluster (Maybe Bool) Source #

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text]) Source #

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

dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text) Source #

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text) Source #

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

dbCluster_scalingConfigurationInfo :: Lens' DBCluster (Maybe ScalingConfigurationInfo) Source #

Undocumented member.

dbCluster_serverlessV2ScalingConfiguration :: Lens' DBCluster (Maybe ServerlessV2ScalingConfigurationInfo) Source #

Undocumented member.

dbCluster_status :: Lens' DBCluster (Maybe Text) Source #

Specifies the current state of this DB cluster.

dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool) Source #

Specifies whether the DB cluster is encrypted.

dbCluster_storageType :: Lens' DBCluster (Maybe Text) Source #

The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

dbCluster_tagList :: Lens' DBCluster (Maybe [Tag]) Source #

Undocumented member.

dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership]) Source #

Provides a list of VPC security groups that the DB cluster belongs to.