Documentation

Contains the details of an Amazon Neptune DB cluster.

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

See: newDBCluster smart constructor.

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:allocatedStorage:DBCluster', dbCluster_allocatedStorage - AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

$sel:associatedRoles:DBCluster', dbCluster_associatedRoles - Provides a list of the Amazon 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 services on your behalf.

$sel:automaticRestartTime:DBCluster', dbCluster_automaticRestartTime - Time at which the DB cluster will be automatically restarted.

$sel:availabilityZones:DBCluster', dbCluster_availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

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

$sel:characterSetName:DBCluster', dbCluster_characterSetName - Not supported by Neptune.

$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 - /If set to true, tags are copied to any snapshot of the DB cluster that is created./

$sel:crossAccountClone:DBCluster', dbCluster_crossAccountClone - If set to true, the DB cluster can be cloned across accounts.

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

$sel:dbClusterIdentifier:DBCluster', dbCluster_dbClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

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

$sel:dbClusterOptionGroupMemberships:DBCluster', dbCluster_dbClusterOptionGroupMemberships - Not supported by Neptune.

$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: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 Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.

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

$sel:earliestRestorableTime:DBCluster', dbCluster_earliestRestorableTime - Specifies 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.

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

$sel:engine:DBCluster', dbCluster_engine - Provides the name of the database engine to be used for this DB 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:iAMDatabaseAuthenticationEnabled:DBCluster', dbCluster_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:kmsKeyId:DBCluster', dbCluster_kmsKeyId - If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB 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 - Not supported by Neptune.

$sel:multiAZ:DBCluster', dbCluster_multiAZ - Specifies whether the DB 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 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 Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

$sel:replicationSourceIdentifier:DBCluster', dbCluster_replicationSourceIdentifier - Not supported by Neptune.

$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:vpcSecurityGroups:DBCluster', dbCluster_vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Provides a list of the Amazon 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 services on your behalf.

Time at which the DB cluster will be automatically restarted.

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

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

Not supported by Neptune.

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

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

/If set to true, tags are copied to any snapshot of the DB cluster that is created./

If set to true, the DB cluster can be cloned across accounts.

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

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

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

Not supported by Neptune.

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

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

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.

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

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

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

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

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

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

Indicates the database engine version.

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

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.

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

Not supported by Neptune.

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

Specifies the progress of the operation as a percentage.

Specifies the port that the database engine is listening on.

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

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

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

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

If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

Not supported by Neptune.

Undocumented member.

Specifies the current state of this DB cluster.

Specifies whether the DB cluster is encrypted.

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