Module Values.SnapshotSource

Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.

Sourcetype nonrec t = {
  1. snapshotName : String_.t option;
    (*

    The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

    *)
  2. replicationGroupId : String_.t option;
    (*

    The unique identifier of the source replication group.

    *)
  3. replicationGroupDescription : String_.t option;
    (*

    A description of the source replication group.

    *)
  4. cacheClusterId : String_.t option;
    (*

    The user-supplied identifier of the source cluster.

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

    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

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

    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

    *)
  7. cacheNodeType : String_.t option;
    (*

    The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    *)
  8. engine : String_.t option;
    (*

    The name of the cache engine (memcached or redis) used by the source cluster.

    *)
  9. engineVersion : String_.t option;
    (*

    The version of the cache engine version that is used by the source cluster.

    *)
  10. numCacheNodes : IntegerOptional.t option;
    (*

    The number of cache nodes in the source cluster. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    *)
  11. preferredAvailabilityZone : String_.t option;
    (*

    The name of the Availability Zone in which the source cluster is located.

    *)
  12. preferredOutpostArn : String_.t option;
    (*

    The ARN (Amazon Resource Name) of the preferred outpost.

    *)
  13. cacheClusterCreateTime : TStamp.t option;
    (*

    The date and time when the source cluster was created.

    *)
  14. preferredMaintenanceWindow : String_.t option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30

    *)
  15. topicArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

    *)
  16. port : IntegerOptional.t option;
    (*

    The port number used by each cache nodes in the source cluster.

    *)
  17. cacheParameterGroupName : String_.t option;
    (*

    The cache parameter group that is associated with the source cluster.

    *)
  18. cacheSubnetGroupName : String_.t option;
    (*

    The name of the cache subnet group associated with the source cluster.

    *)
  19. vpcId : String_.t option;
    (*

    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

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

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  21. snapshotRetentionLimit : IntegerOptional.t option;
    (*

    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  22. snapshotWindow : String_.t option;
    (*

    The daily time range during which ElastiCache takes daily snapshots of the source cluster.

    *)
  23. numNodeGroups : IntegerOptional.t option;
    (*

    The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

    *)
  24. automaticFailover : AutomaticFailoverStatus.t option;
    (*

    Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.

    *)
  25. nodeSnapshots : NodeSnapshotList.t option;
    (*

    A list of the cache nodes in the source cluster.

    *)
  26. kmsKeyId : String_.t option;
    (*

    The ID of the KMS key used to encrypt the snapshot.

    *)
  27. aRN : String_.t option;
    (*

    The ARN (Amazon Resource Name) of the snapshot.

    *)
  28. dataTiering : DataTieringStatus.t option;
    (*

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    *)
}
Sourceval make : ?snapshotName:??? -> ?replicationGroupId:??? -> ?replicationGroupDescription:??? -> ?cacheClusterId:??? -> ?snapshotStatus:??? -> ?snapshotSource:??? -> ?cacheNodeType:??? -> ?engine:??? -> ?engineVersion:??? -> ?numCacheNodes:??? -> ?preferredAvailabilityZone:??? -> ?preferredOutpostArn:??? -> ?cacheClusterCreateTime:??? -> ?preferredMaintenanceWindow:??? -> ?topicArn:??? -> ?port:??? -> ?cacheParameterGroupName:??? -> ?cacheSubnetGroupName:??? -> ?vpcId:??? -> ?autoMinorVersionUpgrade:??? -> ?snapshotRetentionLimit:??? -> ?snapshotWindow:??? -> ?numNodeGroups:??? -> ?automaticFailover:??? -> ?nodeSnapshots:??? -> ?kmsKeyId:??? -> ?aRN:??? -> ?dataTiering:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of IntegerOptional.t | `List of [> `Structure of (string * [> `String of String_.t | `Structure of (string * [> `Integer of IntegerOptional.t | `List of [> `String of String_.t ] list | `String of AllowedNodeGroupId.t ]) list | `Timestamp of TStamp.t ]) list ] list | `String of String_.t | `Timestamp of TStamp.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