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 DBCluster = DBCluster' {
- associatedRoles :: Maybe [DBClusterRole]
- availabilityZones :: Maybe [Text]
- backupRetentionPeriod :: Maybe Int
- cloneGroupId :: Maybe Text
- clusterCreateTime :: Maybe ISO8601
- dbClusterArn :: Maybe Text
- dbClusterIdentifier :: Maybe Text
- dbClusterMembers :: Maybe [DBClusterMember]
- dbClusterParameterGroup :: Maybe Text
- dbSubnetGroup :: Maybe Text
- dbClusterResourceId :: Maybe Text
- deletionProtection :: Maybe Bool
- earliestRestorableTime :: Maybe ISO8601
- enabledCloudwatchLogsExports :: Maybe [Text]
- endpoint :: Maybe Text
- engine :: Maybe Text
- engineVersion :: Maybe Text
- hostedZoneId :: Maybe Text
- kmsKeyId :: Maybe Text
- latestRestorableTime :: Maybe ISO8601
- masterUsername :: Maybe Text
- multiAZ :: Maybe Bool
- percentProgress :: Maybe Text
- port :: Maybe Int
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- readReplicaIdentifiers :: Maybe [Text]
- readerEndpoint :: Maybe Text
- replicationSourceIdentifier :: Maybe Text
- status :: Maybe Text
- storageEncrypted :: Maybe Bool
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- newDBCluster :: DBCluster
- dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole])
- dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text])
- dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int)
- dbCluster_cloneGroupId :: Lens' DBCluster (Maybe Text)
- dbCluster_clusterCreateTime :: Lens' DBCluster (Maybe UTCTime)
- dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text)
- dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text)
- dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember])
- dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text)
- dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text)
- dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text)
- dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool)
- dbCluster_earliestRestorableTime :: Lens' DBCluster (Maybe UTCTime)
- dbCluster_enabledCloudwatchLogsExports :: Lens' DBCluster (Maybe [Text])
- dbCluster_endpoint :: Lens' DBCluster (Maybe Text)
- dbCluster_engine :: Lens' DBCluster (Maybe Text)
- dbCluster_engineVersion :: Lens' DBCluster (Maybe Text)
- dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text)
- dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text)
- dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime)
- dbCluster_masterUsername :: Lens' DBCluster (Maybe Text)
- dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool)
- dbCluster_percentProgress :: Lens' DBCluster (Maybe Text)
- dbCluster_port :: Lens' DBCluster (Maybe Int)
- dbCluster_preferredBackupWindow :: Lens' DBCluster (Maybe Text)
- dbCluster_preferredMaintenanceWindow :: Lens' DBCluster (Maybe Text)
- dbCluster_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text])
- dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text)
- dbCluster_replicationSourceIdentifier :: Lens' DBCluster (Maybe Text)
- dbCluster_status :: Lens' DBCluster (Maybe Text)
- dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool)
- dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership])
Documentation
Detailed information about a cluster.
See: newDBCluster
smart constructor.
DBCluster' | |
|
Instances
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:associatedRoles:DBCluster'
, dbCluster_associatedRoles
- Provides a list of the Identity and Access Management (IAM) roles that
are associated with the cluster. (IAM) roles that are associated with a
cluster grant permission for the cluster to access other Amazon Web
Services services on your behalf.
$sel:availabilityZones:DBCluster'
, dbCluster_availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the
cluster can be created in.
$sel:backupRetentionPeriod:DBCluster'
, dbCluster_backupRetentionPeriod
- Specifies the number of days for which automatic snapshots are retained.
$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 cluster was created, in Universal
Coordinated Time (UTC).
$sel:dbClusterArn:DBCluster'
, dbCluster_dbClusterArn
- The Amazon Resource Name (ARN) for the cluster.
$sel:dbClusterIdentifier:DBCluster'
, dbCluster_dbClusterIdentifier
- Contains a user-supplied cluster identifier. This identifier is the
unique key that identifies a cluster.
$sel:dbClusterMembers:DBCluster'
, dbCluster_dbClusterMembers
- Provides the list of instances that make up the cluster.
$sel:dbClusterParameterGroup:DBCluster'
, dbCluster_dbClusterParameterGroup
- Specifies the name of the cluster parameter group for the cluster.
$sel:dbSubnetGroup:DBCluster'
, dbCluster_dbSubnetGroup
- Specifies information on the subnet group that is associated with the
cluster, including the name, description, and subnets in the subnet
group.
$sel:dbClusterResourceId:DBCluster'
, dbCluster_dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the
cluster. This identifier is found in CloudTrail log entries whenever the
KMS key for the cluster is accessed.
$sel:deletionProtection:DBCluster'
, dbCluster_deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
$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 cluster is configured to export to Amazon
CloudWatch Logs.
$sel:endpoint:DBCluster'
, dbCluster_endpoint
- Specifies the connection endpoint for the primary instance of the
cluster.
$sel:engine:DBCluster'
, dbCluster_engine
- Provides the name of the database engine to be used for this cluster.
$sel:engineVersion:DBCluster'
, dbCluster_engineVersion
- Indicates the database engine version.
$sel:hostedZoneId:DBCluster'
, dbCluster_hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted
zone.
$sel:kmsKeyId:DBCluster'
, dbCluster_kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the
encrypted cluster.
$sel:latestRestorableTime:DBCluster'
, dbCluster_latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.
$sel:masterUsername:DBCluster'
, dbCluster_masterUsername
- Contains the master user name for the cluster.
$sel:multiAZ:DBCluster'
, dbCluster_multiAZ
- Specifies whether the cluster has instances in multiple Availability
Zones.
$sel:percentProgress:DBCluster'
, dbCluster_percentProgress
- Specifies the progress of the operation as a percentage.
$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:readReplicaIdentifiers:DBCluster'
, dbCluster_readReplicaIdentifiers
- Contains one or more identifiers of the secondary clusters that are
associated with this cluster.
$sel:readerEndpoint:DBCluster'
, dbCluster_readerEndpoint
- The reader endpoint for the cluster. The reader endpoint for a cluster
load balances connections across the Amazon DocumentDB replicas that are
available in a cluster. As clients request new connections to the reader
endpoint, Amazon DocumentDB distributes the connection requests among
the Amazon DocumentDB replicas in the cluster. This functionality can
help balance your read workload across multiple Amazon DocumentDB
replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
$sel:replicationSourceIdentifier:DBCluster'
, dbCluster_replicationSourceIdentifier
- Contains the identifier of the source cluster if this cluster is a
secondary cluster.
DBCluster
, dbCluster_status
- Specifies the current state of this cluster.
$sel:storageEncrypted:DBCluster'
, dbCluster_storageEncrypted
- Specifies whether the cluster is encrypted.
$sel:vpcSecurityGroups:DBCluster'
, dbCluster_vpcSecurityGroups
- Provides a list of virtual private cloud (VPC) security groups that the
cluster belongs to.
dbCluster_associatedRoles :: Lens' DBCluster (Maybe [DBClusterRole]) Source #
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
dbCluster_availabilityZones :: Lens' DBCluster (Maybe [Text]) Source #
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
dbCluster_backupRetentionPeriod :: Lens' DBCluster (Maybe Int) Source #
Specifies the number of days for which automatic snapshots are retained.
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 cluster was created, in Universal Coordinated Time (UTC).
dbCluster_dbClusterArn :: Lens' DBCluster (Maybe Text) Source #
The Amazon Resource Name (ARN) for the cluster.
dbCluster_dbClusterIdentifier :: Lens' DBCluster (Maybe Text) Source #
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
dbCluster_dbClusterMembers :: Lens' DBCluster (Maybe [DBClusterMember]) Source #
Provides the list of instances that make up the cluster.
dbCluster_dbClusterParameterGroup :: Lens' DBCluster (Maybe Text) Source #
Specifies the name of the cluster parameter group for the cluster.
dbCluster_dbSubnetGroup :: Lens' DBCluster (Maybe Text) Source #
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
dbCluster_dbClusterResourceId :: Lens' DBCluster (Maybe Text) Source #
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
dbCluster_deletionProtection :: Lens' DBCluster (Maybe Bool) Source #
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection
is disabled. DeletionProtection
protects clusters
from being accidentally deleted.
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 cluster is configured to export to Amazon CloudWatch Logs.
dbCluster_endpoint :: Lens' DBCluster (Maybe Text) Source #
Specifies the connection endpoint for the primary instance of the cluster.
dbCluster_engine :: Lens' DBCluster (Maybe Text) Source #
Provides the name of the database engine to be used for this cluster.
dbCluster_engineVersion :: Lens' DBCluster (Maybe Text) Source #
Indicates the database engine version.
dbCluster_hostedZoneId :: Lens' DBCluster (Maybe Text) Source #
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
dbCluster_kmsKeyId :: Lens' DBCluster (Maybe Text) Source #
If StorageEncrypted
is true
, the KMS key identifier for the
encrypted cluster.
dbCluster_latestRestorableTime :: Lens' DBCluster (Maybe UTCTime) Source #
Specifies the latest time to which a database can be restored with point-in-time restore.
dbCluster_masterUsername :: Lens' DBCluster (Maybe Text) Source #
Contains the master user name for the cluster.
dbCluster_multiAZ :: Lens' DBCluster (Maybe Bool) Source #
Specifies whether the cluster has instances in multiple Availability Zones.
dbCluster_percentProgress :: Lens' DBCluster (Maybe Text) Source #
Specifies the progress of the operation as a percentage.
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_readReplicaIdentifiers :: Lens' DBCluster (Maybe [Text]) Source #
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
dbCluster_readerEndpoint :: Lens' DBCluster (Maybe Text) Source #
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB 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 cluster if this cluster is a secondary cluster.
dbCluster_status :: Lens' DBCluster (Maybe Text) Source #
Specifies the current state of this cluster.
dbCluster_storageEncrypted :: Lens' DBCluster (Maybe Bool) Source #
Specifies whether the cluster is encrypted.
dbCluster_vpcSecurityGroups :: Lens' DBCluster (Maybe [VpcSecurityGroupMembership]) Source #
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.