Skip to content

RecoveryPointByBackupVault

Source code in docs_src/capo_backup/types/recovery_point_by_backup_vault.py
class RecoveryPointByBackupVault(TypedDict, closed=True):
    recovery_point_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"""
    backup_vault_name: NotRequired[
        "capo_backup.types.backup_vault_name.BackupVaultName"
    ]
    """<p>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.</p>"""
    backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"""
    source_backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>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 <code>null</code>.</p>"""
    resource_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"""
    resource_type: NotRequired["capo_backup.types.resource_type.ResourceType"]
    """<p>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.</p>"""
    created_by: NotRequired[
        "capo_backup.types.recovery_point_creator.RecoveryPointCreator"
    ]
    """<p>Contains identifying information about the creation of a recovery point, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>"""
    iam_role_arn: NotRequired["capo_backup.types.iam_role_arn.IAMRoleArn"]
    """<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    status: NotRequired["capo_backup.types.recovery_point_status.RecoveryPointStatus"]
    """<p>A status code specifying the state of the recovery point.</p>"""
    status_message: NotRequired["capo_backup.types.string.string"]
    """<p>A message explaining the current status of the recovery point.</p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    initiation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).</p>"""
    completion_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    backup_size_in_bytes: NotRequired["capo_backup.types.long.Long"]
    """<p>The size, in bytes, of a backup.</p>"""
    calculated_lifecycle: NotRequired[
        "capo_backup.types.calculated_lifecycle.CalculatedLifecycle"
    ]
    """<p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps.</p>"""
    lifecycle: NotRequired["capo_backup.types.lifecycle.Lifecycle"]
    """<p>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. </p> <p>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. </p> <p>Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"""
    encryption_key_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"""
    is_encrypted: "capo_backup.types.boolean2.Boolean2"
    """<p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>"""
    last_restore_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastRestoreTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    parent_recovery_point_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the parent (composite) recovery point.</p>"""
    composite_member_identifier: NotRequired["capo_backup.types.string.string"]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax"> logical ID</a> within a stack.</p>"""
    is_parent: "capo_backup.types.boolean2.Boolean2"
    """<p>This is a boolean value indicating this is a parent (composite) recovery point.</p>"""
    resource_name: NotRequired["capo_backup.types.string.string"]
    """<p>The non-unique name of the resource that belongs to the specified backup.</p>"""
    vault_type: NotRequired["capo_backup.types.vault_type.VaultType"]
    """<p>The type of vault in which the described recovery point is stored.</p>"""
    index_status: NotRequired["capo_backup.types.index_status.IndexStatus"]
    """<p>This is the current status for the backup index associated with the specified recovery point.</p> <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code> </p> <p>A recovery point with an index that has the status of <code>ACTIVE</code> can be included in a search.</p>"""
    index_status_message: NotRequired["capo_backup.types.string.string"]
    """<p>A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.</p>"""
    encryption_key_type: NotRequired[
        "capo_backup.types.encryption_key_type.EncryptionKeyType"
    ]
    """<p>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.</p>"""
    aggregated_scan_result: NotRequired[
        "capo_backup.types.aggregated_scan_result.AggregatedScanResult"
    ]
    """<p>Contains the latest scanning results against the recovery point and currently include <code>FailedScan</code>, <code>Findings</code>, <code>LastComputed</code>.</p>"""

aggregated_scan_result instance-attribute

aggregated_scan_result: NotRequired[AggregatedScanResult]

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

backup_size_in_bytes instance-attribute

backup_size_in_bytes: NotRequired[Long]

The size, in bytes, of a backup.

backup_vault_arn instance-attribute

backup_vault_arn: NotRequired[ARN]

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

backup_vault_name instance-attribute

backup_vault_name: NotRequired[BackupVaultName]

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.

calculated_lifecycle instance-attribute

calculated_lifecycle: NotRequired[CalculatedLifecycle]

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

completion_date instance-attribute

completion_date: NotRequired[timestamp]

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.

composite_member_identifier instance-attribute

composite_member_identifier: NotRequired[string]

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.

created_by instance-attribute

created_by: NotRequired[RecoveryPointCreator]

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.

creation_date instance-attribute

creation_date: NotRequired[timestamp]

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.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[ARN]

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.

encryption_key_type instance-attribute

encryption_key_type: NotRequired[EncryptionKeyType]

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.

iam_role_arn instance-attribute

iam_role_arn: NotRequired[IAMRoleArn]

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

index_status instance-attribute

index_status: NotRequired[IndexStatus]

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.

index_status_message instance-attribute

index_status_message: NotRequired[string]

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

initiation_date instance-attribute

initiation_date: NotRequired[timestamp]

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

is_encrypted instance-attribute

is_encrypted: Boolean2

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

is_parent instance-attribute

is_parent: Boolean2

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

last_restore_time instance-attribute

last_restore_time: NotRequired[timestamp]

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.

lifecycle instance-attribute

lifecycle: NotRequired[Lifecycle]

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.

parent_recovery_point_arn instance-attribute

parent_recovery_point_arn: NotRequired[ARN]

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

recovery_point_arn instance-attribute

recovery_point_arn: NotRequired[ARN]

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.

resource_arn instance-attribute

resource_arn: NotRequired[ARN]

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

resource_name instance-attribute

resource_name: NotRequired[string]

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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.

source_backup_vault_arn instance-attribute

source_backup_vault_arn: NotRequired[ARN]

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.

status instance-attribute

status: NotRequired[RecoveryPointStatus]

A status code specifying the state of the recovery point.

status_message instance-attribute

status_message: NotRequired[string]

A message explaining the current status of the recovery point.

vault_type instance-attribute

vault_type: NotRequired[VaultType]

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