AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeRecoveryPointOutput

import "github.com/aws/aws-sdk-go/service/backup"

type DescribeRecoveryPointOutput struct { BackupSizeInBytes *int64 `type:"long"` BackupVaultArn *string `type:"string"` BackupVaultName *string `type:"string"` CalculatedLifecycle *CalculatedLifecycle `type:"structure"` CompletionDate *time.Time `type:"timestamp"` CreatedBy *RecoveryPointCreator `type:"structure"` CreationDate *time.Time `type:"timestamp"` EncryptionKeyArn *string `type:"string"` IamRoleArn *string `type:"string"` IsEncrypted *bool `type:"boolean"` LastRestoreTime *time.Time `type:"timestamp"` Lifecycle *Lifecycle `type:"structure"` RecoveryPointArn *string `type:"string"` ResourceArn *string `type:"string"` ResourceType *string `type:"string"` Status *string `type:"string" enum:"RecoveryPointStatus"` StorageClass *string `type:"string" enum:"StorageClass"` }

BackupSizeInBytes

Type: *int64

The size, in bytes, of a backup.

BackupVaultArn

Type: *string

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

BackupVaultName

Type: *string

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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

CalculatedLifecycle

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

CompletionDate

Type: *time.Time

The date and time that a job to create 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.

CreatedBy

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

CreationDate

Type: *time.Time

The date and time that 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.

EncryptionKeyArn

Type: *string

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

IamRoleArn

Type: *string

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

IsEncrypted

Type: *bool

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

LastRestoreTime

Type: *time.Time

The date and time that 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

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

RecoveryPointArn

Type: *string

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

ResourceArn

Type: *string

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

ResourceType

Type: *string

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Status

Type: *string

A status code specifying the state of the recovery point.

A partial status indicates that the recovery point was not successfully re-created and must be retried.

StorageClass

Type: *string

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

Method

GoString

func (s DescribeRecoveryPointOutput) GoString() string

GoString returns the string representation

SetBackupSizeInBytes

func (s *DescribeRecoveryPointOutput) SetBackupSizeInBytes(v int64) *DescribeRecoveryPointOutput

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

SetBackupVaultArn

func (s *DescribeRecoveryPointOutput) SetBackupVaultArn(v string) *DescribeRecoveryPointOutput

SetBackupVaultArn sets the BackupVaultArn field's value.

SetBackupVaultName

func (s *DescribeRecoveryPointOutput) SetBackupVaultName(v string) *DescribeRecoveryPointOutput

SetBackupVaultName sets the BackupVaultName field's value.

SetCalculatedLifecycle

func (s *DescribeRecoveryPointOutput) SetCalculatedLifecycle(v *CalculatedLifecycle) *DescribeRecoveryPointOutput

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

SetCompletionDate

func (s *DescribeRecoveryPointOutput) SetCompletionDate(v time.Time) *DescribeRecoveryPointOutput

SetCompletionDate sets the CompletionDate field's value.

SetCreatedBy

func (s *DescribeRecoveryPointOutput) SetCreatedBy(v *RecoveryPointCreator) *DescribeRecoveryPointOutput

SetCreatedBy sets the CreatedBy field's value.

SetCreationDate

func (s *DescribeRecoveryPointOutput) SetCreationDate(v time.Time) *DescribeRecoveryPointOutput

SetCreationDate sets the CreationDate field's value.

SetEncryptionKeyArn

func (s *DescribeRecoveryPointOutput) SetEncryptionKeyArn(v string) *DescribeRecoveryPointOutput

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

SetIamRoleArn

func (s *DescribeRecoveryPointOutput) SetIamRoleArn(v string) *DescribeRecoveryPointOutput

SetIamRoleArn sets the IamRoleArn field's value.

SetIsEncrypted

func (s *DescribeRecoveryPointOutput) SetIsEncrypted(v bool) *DescribeRecoveryPointOutput

SetIsEncrypted sets the IsEncrypted field's value.

SetLastRestoreTime

func (s *DescribeRecoveryPointOutput) SetLastRestoreTime(v time.Time) *DescribeRecoveryPointOutput

SetLastRestoreTime sets the LastRestoreTime field's value.

SetLifecycle

func (s *DescribeRecoveryPointOutput) SetLifecycle(v *Lifecycle) *DescribeRecoveryPointOutput

SetLifecycle sets the Lifecycle field's value.

SetRecoveryPointArn

func (s *DescribeRecoveryPointOutput) SetRecoveryPointArn(v string) *DescribeRecoveryPointOutput

SetRecoveryPointArn sets the RecoveryPointArn field's value.

SetResourceArn

func (s *DescribeRecoveryPointOutput) SetResourceArn(v string) *DescribeRecoveryPointOutput

SetResourceArn sets the ResourceArn field's value.

SetResourceType

func (s *DescribeRecoveryPointOutput) SetResourceType(v string) *DescribeRecoveryPointOutput

SetResourceType sets the ResourceType field's value.

SetStatus

func (s *DescribeRecoveryPointOutput) SetStatus(v string) *DescribeRecoveryPointOutput

SetStatus sets the Status field's value.

SetStorageClass

func (s *DescribeRecoveryPointOutput) SetStorageClass(v string) *DescribeRecoveryPointOutput

SetStorageClass sets the StorageClass field's value.

String

func (s DescribeRecoveryPointOutput) String() string

String returns the string representation

On this page: