Class: Aws::SecurityHub::Types::AwsBackupRecoveryPointDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsBackupRecoveryPointDetails data as a hash:

{
  backup_size_in_bytes: 1,
  backup_vault_arn: "NonEmptyString",
  backup_vault_name: "NonEmptyString",
  calculated_lifecycle: {
    delete_at: "NonEmptyString",
    move_to_cold_storage_at: "NonEmptyString",
  },
  completion_date: "NonEmptyString",
  created_by: {
    backup_plan_arn: "NonEmptyString",
    backup_plan_id: "NonEmptyString",
    backup_plan_version: "NonEmptyString",
    backup_rule_id: "NonEmptyString",
  },
  creation_date: "NonEmptyString",
  encryption_key_arn: "NonEmptyString",
  iam_role_arn: "NonEmptyString",
  is_encrypted: false,
  last_restore_time: "NonEmptyString",
  lifecycle: {
    delete_after_days: 1,
    move_to_cold_storage_after_days: 1,
  },
  recovery_point_arn: "NonEmptyString",
  resource_arn: "NonEmptyString",
  resource_type: "NonEmptyString",
  source_backup_vault_arn: "NonEmptyString",
  status: "NonEmptyString",
  status_message: "NonEmptyString",
  storage_class: "NonEmptyString",
}

Contains detailed information about the recovery points stored in an Backup backup vault. A backup, or recovery point, represents the content of a resource at a specified time.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_size_in_bytesInteger

The size, in bytes, of a backup.

Returns:

  • (Integer)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_arnString

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#backup_vault_nameString

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

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#calculated_lifecycleTypes::AwsBackupRecoveryPointCalculatedLifecycleDetails

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.



2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#completion_dateString

The date and time that a job to create a recovery point is completed, in Unix format and 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.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#created_byTypes::AwsBackupRecoveryPointCreatedByDetails

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.



2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateString

The date and time a recovery point is created, in Unix format and 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.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arnString

The ARN for the server-side encryption key that is used to protect your backups.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

Specifies the IAM role ARN used to create the target recovery point

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#is_encryptedBoolean

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

Returns:

  • (Boolean)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#last_restore_timeString

The date and time that a recovery point was last restored, in Unix format and 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.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleTypes::AwsBackupRecoveryPointLifecycleDetails

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



2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arnString

An ARN that uniquely identifies a recovery point.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_vault_arnString

The ARN for 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.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

A status code specifying the state of the recovery point. Valid values are as follows:

  • COMPLETED

  • DELETING

  • EXPIRED

  • PARTIAL

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

A message explaining the reason of the recovery point deletion failure.

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end

#storage_classString

Specifies the storage class of the recovery point. Valid values are as follows:

  • COLD

  • DELETED

  • WARM

Returns:

  • (String)


2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 2850

class AwsBackupRecoveryPointDetails < Struct.new(
  :backup_size_in_bytes,
  :backup_vault_arn,
  :backup_vault_name,
  :calculated_lifecycle,
  :completion_date,
  :created_by,
  :creation_date,
  :encryption_key_arn,
  :iam_role_arn,
  :is_encrypted,
  :last_restore_time,
  :lifecycle,
  :recovery_point_arn,
  :resource_arn,
  :resource_type,
  :source_backup_vault_arn,
  :status,
  :status_message,
  :storage_class)
  SENSITIVE = []
  include Aws::Structure
end