Module Values.RecoveryPointByBackupVaultSource

Contains detailed information about the recovery points stored in a backup vault.

Sourcetype nonrec t = {
  1. recoveryPointArn : ARN.t option;
    (*

    An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    *)
  2. backupVaultName : BackupVaultName.t option;
    (*

    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

    *)
  3. backupVaultArn : ARN.t option;
    (*

    An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    *)
  4. sourceBackupVaultArn : ARN.t option;
    (*

    The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

    *)
  5. resourceArn : ARN.t option;
    (*

    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

    *)
  6. resourceType : ResourceType.t option;
    (*

    The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

    *)
  7. createdBy : RecoveryPointCreator.t option;
    (*

    Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

    *)
  8. iamRoleArn : IAMRoleArn.t option;
    (*

    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    *)
  9. status : RecoveryPointStatus.t option;
    (*

    A status code specifying the state of the recovery point.

    *)
  10. statusMessage : string option;
    (*

    A message explaining the current status of the recovery point.

    *)
  11. creationDate : string option;
    (*

    The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  12. initiationDate : string option;
    (*

    The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).

    *)
  13. completionDate : string option;
    (*

    The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  14. backupSizeInBytes : Long.t option;
    (*

    The size, in bytes, of a backup.

    *)
  15. calculatedLifecycle : CalculatedLifecycle.t option;
    (*

    A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

    *)
  16. lifecycle : Lifecycle.t option;
    (*

    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

    *)
  17. encryptionKeyArn : ARN.t option;
    (*

    The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    *)
  18. isEncrypted : bool option;
    (*

    A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

    *)
  19. lastRestoreTime : string option;
    (*

    The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    *)
  20. parentRecoveryPointArn : ARN.t option;
    (*

    The Amazon Resource Name (ARN) of the parent (composite) recovery point.

    *)
  21. compositeMemberIdentifier : string option;
    (*

    The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

    *)
  22. isParent : bool option;
    (*

    This is a boolean value indicating this is a parent (composite) recovery point.

    *)
  23. resourceName : string option;
    (*

    The non-unique name of the resource that belongs to the specified backup.

    *)
  24. vaultType : VaultType.t option;
    (*

    The type of vault in which the described recovery point is stored.

    *)
  25. indexStatus : IndexStatus.t option;
    (*

    This is the current status for the backup index associated with the specified recovery point. Statuses are: PENDING | ACTIVE | FAILED | DELETING A recovery point with an index that has the status of ACTIVE can be included in a search.

    *)
  26. indexStatusMessage : string option;
    (*

    A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.

    *)
  27. encryptionKeyType : EncryptionKeyType.t option;
    (*

    The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.

    *)
  28. aggregatedScanResult : AggregatedScanResult.t option;
    (*

    Contains the latest scanning results against the recovery point and currently include FailedScan, Findings, LastComputed.

    *)
}
Sourceval make : ?recoveryPointArn:??? -> ?backupVaultName:??? -> ?backupVaultArn:??? -> ?sourceBackupVaultArn:??? -> ?resourceArn:??? -> ?resourceType:??? -> ?createdBy:??? -> ?iamRoleArn:??? -> ?status:??? -> ?statusMessage:??? -> ?creationDate:??? -> ?initiationDate:??? -> ?completionDate:??? -> ?backupSizeInBytes:??? -> ?calculatedLifecycle:??? -> ?lifecycle:??? -> ?encryptionKeyArn:??? -> ?isEncrypted:??? -> ?lastRestoreTime:??? -> ?parentRecoveryPointArn:??? -> ?compositeMemberIdentifier:??? -> ?isParent:??? -> ?resourceName:??? -> ?vaultType:??? -> ?indexStatus:??? -> ?indexStatusMessage:??? -> ?encryptionKeyType:??? -> ?aggregatedScanResult:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of bool | `Enum of string | `Long of Long.t | `String of ARN.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `List of [> `Enum of string ] list | `Long of Long.t | `String of string | `Timestamp of string ]) list | `Timestamp of string ]) 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