Module Values.AwsRdsDbClusterDetailsSource

Information about an Amazon RDS DB cluster.

Sourcetype nonrec t = {
  1. allocatedStorage : Integer.t option;
    (*

    For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

    *)
  2. availabilityZones : StringList.t option;
    (*

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

    *)
  3. backupRetentionPeriod : Integer.t option;
    (*

    The number of days for which automated backups are retained.

    *)
  4. databaseName : NonEmptyString.t option;
    (*

    The name of the database.

    *)
  5. status : NonEmptyString.t option;
    (*

    The current status of this DB cluster.

    *)
  6. endpoint : NonEmptyString.t option;
    (*

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

    *)
  7. readerEndpoint : NonEmptyString.t option;
    (*

    The reader endpoint for the DB cluster.

    *)
  8. customEndpoints : StringList.t option;
    (*

    A list of custom endpoints for the DB cluster.

    *)
  9. multiAz : Boolean.t option;
    (*

    Whether the DB cluster has instances in multiple Availability Zones.

    *)
  10. engine : NonEmptyString.t option;
    (*

    The name of the database engine to use for this DB cluster. Valid values are as follows: aurora aurora-mysql aurora-postgresql

    *)
  11. engineVersion : NonEmptyString.t option;
    (*

    The version number of the database engine to use.

    *)
  12. port : Integer.t option;
    (*

    The port number on which the DB instances in the DB cluster accept connections.

    *)
  13. masterUsername : NonEmptyString.t option;
    (*

    The name of the master user for the DB cluster.

    *)
  14. preferredBackupWindow : NonEmptyString.t option;
    (*

    The range of time each day when automated backups are created, if automated backups are enabled. Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

    *)
  15. preferredMaintenanceWindow : NonEmptyString.t option;
    (*

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Uses the format <day>:HH:MM-<day>:HH:MM. For the day values, use mon|tue|wed|thu|fri|sat|sun. For example, sun:09:32-sun:10:02.

    *)
  16. readReplicaIdentifiers : StringList.t option;
    (*

    The identifiers of the read replicas that are associated with this DB cluster.

    *)
  17. vpcSecurityGroups : AwsRdsDbInstanceVpcSecurityGroups.t option;
    (*

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

    *)
  18. hostedZoneId : NonEmptyString.t option;
    (*

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

    *)
  19. storageEncrypted : Boolean.t option;
    (*

    Whether the DB cluster is encrypted.

    *)
  20. kmsKeyId : NonEmptyString.t option;
    (*

    The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

    *)
  21. dbClusterResourceId : NonEmptyString.t option;
    (*

    The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

    *)
  22. associatedRoles : AwsRdsDbClusterAssociatedRoles.t option;
    (*

    A list of the IAM roles that are associated with the DB cluster.

    *)
  23. clusterCreateTime : NonEmptyString.t option;
    (*

    Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

    *)
  24. enabledCloudWatchLogsExports : StringList.t option;
    (*

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

    *)
  25. engineMode : NonEmptyString.t option;
    (*

    The database engine mode of the DB cluster.Valid values are as follows: global multimaster parallelquery provisioned serverless

    *)
  26. deletionProtection : Boolean.t option;
    (*

    Whether the DB cluster has deletion protection enabled.

    *)
  27. httpEndpointEnabled : Boolean.t option;
    (*

    Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

    *)
  28. activityStreamStatus : NonEmptyString.t option;
    (*

    The status of the database activity stream. Valid values are as follows: started starting stopped stopping

    *)
  29. copyTagsToSnapshot : Boolean.t option;
    (*

    Whether tags are copied from the DB cluster to snapshots of the DB cluster.

    *)
  30. crossAccountClone : Boolean.t option;
    (*

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

    *)
  31. domainMemberships : AwsRdsDbDomainMemberships.t option;
    (*

    The Active Directory domain membership records that are associated with the DB cluster.

    *)
  32. dbClusterParameterGroup : NonEmptyString.t option;
    (*

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

    *)
  33. dbSubnetGroup : NonEmptyString.t option;
    (*

    The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

    *)
  34. dbClusterOptionGroupMemberships : AwsRdsDbClusterOptionGroupMemberships.t option;
    (*

    The list of option group memberships for this DB cluster.

    *)
  35. dbClusterIdentifier : NonEmptyString.t option;
    (*

    The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

    *)
  36. dbClusterMembers : AwsRdsDbClusterMembers.t option;
    (*

    The list of instances that make up the DB cluster.

    *)
  37. iamDatabaseAuthenticationEnabled : Boolean.t option;
    (*

    Whether the mapping of IAM accounts to database accounts is enabled.

    *)
  38. autoMinorVersionUpgrade : Boolean.t option;
    (*

    Indicates if minor version upgrades are automatically applied to the cluster.

    *)
}
Sourceval make : ?allocatedStorage:??? -> ?availabilityZones:??? -> ?backupRetentionPeriod:??? -> ?databaseName:??? -> ?status:??? -> ?endpoint:??? -> ?readerEndpoint:??? -> ?customEndpoints:??? -> ?multiAz:??? -> ?engine:??? -> ?engineVersion:??? -> ?port:??? -> ?masterUsername:??? -> ?preferredBackupWindow:??? -> ?preferredMaintenanceWindow:??? -> ?readReplicaIdentifiers:??? -> ?vpcSecurityGroups:??? -> ?hostedZoneId:??? -> ?storageEncrypted:??? -> ?kmsKeyId:??? -> ?dbClusterResourceId:??? -> ?associatedRoles:??? -> ?clusterCreateTime:??? -> ?enabledCloudWatchLogsExports:??? -> ?engineMode:??? -> ?deletionProtection:??? -> ?httpEndpointEnabled:??? -> ?activityStreamStatus:??? -> ?copyTagsToSnapshot:??? -> ?crossAccountClone:??? -> ?domainMemberships:??? -> ?dbClusterParameterGroup:??? -> ?dbSubnetGroup:??? -> ?dbClusterOptionGroupMemberships:??? -> ?dbClusterIdentifier:??? -> ?dbClusterMembers:??? -> ?iamDatabaseAuthenticationEnabled:??? -> ?autoMinorVersionUpgrade:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of NonEmptyString.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `String of NonEmptyString.t ]) list ] list | `String of NonEmptyString.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t