You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Backup::Types::ListRecoveryPointsByBackupVaultInput

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

Overview

Note:

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

{
  backup_vault_name: "BackupVaultName", # required
  next_token: "string",
  max_results: 1,
  by_resource_arn: "ARN",
  by_resource_type: "ResourceType",
  by_backup_plan_id: "string",
  by_created_before: Time.now,
  by_created_after: Time.now,
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_vault_nameString

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

Returns:

  • (String)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#by_backup_plan_idString

Returns only recovery points that match the specified backup plan ID.

Returns:

  • (String)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#by_created_afterTime

Returns only recovery points that were created after the specified timestamp.

Returns:

  • (Time)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#by_created_beforeTime

Returns only recovery points that were created before the specified timestamp.

Returns:

  • (Time)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#by_resource_arnString

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

Returns:

  • (String)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#by_resource_typeString

Returns only recovery points that match the specified resource type.

Returns:

  • (String)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to be returned.

Returns:

  • (Integer)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end

#next_tokenString

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (String)


2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2602

class ListRecoveryPointsByBackupVaultInput < Struct.new(
  :backup_vault_name,
  :next_token,
  :max_results,
  :by_resource_arn,
  :by_resource_type,
  :by_backup_plan_id,
  :by_created_before,
  :by_created_after)
  include Aws::Structure
end