Module Values.GetDbClusterOutputSource

Retrieves information about a Timestream for InfluxDB cluster.

Sourcetype nonrec t = {
  1. id : DbClusterId.t option;
    (*

    Service-generated unique identifier of the DB cluster to retrieve.

    *)
  2. name : DbClusterName.t option;
    (*

    Customer-supplied name of the Timestream for InfluxDB cluster.

    *)
  3. arn : Arn.t option;
    (*

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

    *)
  4. status : ClusterStatus.t option;
    (*

    The status of the DB cluster.

    *)
  5. endpoint : String_.t option;
    (*

    The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

    *)
  6. readerEndpoint : String_.t option;
    (*

    The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

    *)
  7. port : Port.t option;
    (*

    The port number on which InfluxDB accepts connections.

    *)
  8. deploymentType : ClusterDeploymentType.t option;
    (*

    Deployment type of the DB cluster.

    *)
  9. dbInstanceType : DbInstanceType.t option;
    (*

    The Timestream for InfluxDB instance type that InfluxDB runs on.

    *)
  10. networkType : NetworkType.t option;
    (*

    Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

    *)
  11. dbStorageType : DbStorageType.t option;
    (*

    The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

    *)
  12. allocatedStorage : AllocatedStorage.t option;
    (*

    The amount of storage allocated for your DB storage type (in gibibytes).

    *)
  13. engineType : EngineType.t option;
    (*

    The engine type of your DB cluster.

    *)
  14. publiclyAccessible : Boolean.t option;
    (*

    Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

    *)
  15. dbParameterGroupIdentifier : DbParameterGroupIdentifier.t option;
    (*

    The ID of the DB parameter group assigned to your DB cluster.

    *)
  16. logDeliveryConfiguration : LogDeliveryConfiguration.t option;
    (*

    Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

    *)
  17. maintenanceSchedule : MaintenanceSchedule.t option;
    (*

    The maintenance schedule for the DB cluster.

    *)
  18. lastMaintenanceTime : SyntheticTimestamp_date_time.t option;
    (*

    The timestamp of the last completed maintenance operation on the DB cluster.

    *)
  19. nextMaintenanceTime : SyntheticTimestamp_date_time.t option;
    (*

    The timestamp of the next scheduled maintenance operation on the DB cluster.

    *)
  20. influxAuthParametersSecretArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

    *)
  21. vpcSubnetIds : VpcSubnetIdList.t option;
    (*

    A list of VPC subnet IDs associated with the DB cluster.

    *)
  22. vpcSecurityGroupIds : VpcSecurityGroupIdList.t option;
    (*

    A list of VPC security group IDs associated with the DB cluster.

    *)
  23. failoverMode : FailoverMode.t option;
    (*

    The configured failover mode for the DB cluster.

    *)
  24. clusterConfiguration : ClusterConfiguration.t option;
    (*

    Configuration for node modes in the DbCluster.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?name:??? -> ?arn:??? -> ?status:??? -> ?endpoint:??? -> ?readerEndpoint:??? -> ?port:??? -> ?deploymentType:??? -> ?dbInstanceType:??? -> ?networkType:??? -> ?dbStorageType:??? -> ?allocatedStorage:??? -> ?engineType:??? -> ?publiclyAccessible:??? -> ?dbParameterGroupIdentifier:??? -> ?logDeliveryConfiguration:??? -> ?maintenanceSchedule:??? -> ?lastMaintenanceTime:??? -> ?nextMaintenanceTime:??? -> ?influxAuthParametersSecretArn:??? -> ?vpcSubnetIds:??? -> ?vpcSecurityGroupIds:??? -> ?failoverMode:??? -> ?clusterConfiguration:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Port.t | `List of [> `String of VpcSubnetId.t ] list | `String of DbClusterId.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `String of IanaTimezone.t | `Structure of (string * [> `Boolean of Boolean.t | `String of S3ConfigurationBucketNameString.t ]) list ]) list | `Timestamp of SyntheticTimestamp_date_time.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