Class: Aws::CloudHSMV2::Types::DescribeBackupsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudHSMV2::Types::DescribeBackupsRequest
- Defined in:
- gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filters ⇒ Hash<String,Array<String>>
One or more filters to limit the items returned in the response.
-
#max_results ⇒ Integer
The maximum number of backups to return in the response.
-
#next_token ⇒ String
The
NextToken
value that you received in the previous response. -
#sort_ascending ⇒ Boolean
Designates whether or not to sort the return backups by ascending chronological order of generation.
Instance Attribute Details
#filters ⇒ Hash<String,Array<String>>
One or more filters to limit the items returned in the response.
Use the backupIds
filter to return only the specified backups.
Specify backups by their backup identifier (ID).
Use the sourceBackupIds
filter to return only the backups created
from a source backup. The sourceBackupID
of a source backup is
returned by the CopyBackupToRegion operation.
Use the clusterIds
filter to return only the backups for the
specified clusters. Specify clusters by their cluster identifier
(ID).
Use the states
filter to return only backups that match the
specified state.
Use the neverExpires
filter to return backups filtered by the
value in the neverExpires
parameter. True
returns all backups
exempt from the backup retention policy. False
returns all backups
with a backup retention policy defined at the cluster.
588 589 590 591 592 593 594 595 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 588 class DescribeBackupsRequest < Struct.new( :next_token, :max_results, :filters, :sort_ascending) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of backups to return in the response. When there
are more backups than the number you specify, the response contains
a NextToken
value.
588 589 590 591 592 593 594 595 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 588 class DescribeBackupsRequest < Struct.new( :next_token, :max_results, :filters, :sort_ascending) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
The NextToken
value that you received in the previous response.
Use this value to get more backups.
588 589 590 591 592 593 594 595 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 588 class DescribeBackupsRequest < Struct.new( :next_token, :max_results, :filters, :sort_ascending) SENSITIVE = [] include Aws::Structure end |
#sort_ascending ⇒ Boolean
Designates whether or not to sort the return backups by ascending chronological order of generation.
588 589 590 591 592 593 594 595 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 588 class DescribeBackupsRequest < Struct.new( :next_token, :max_results, :filters, :sort_ascending) SENSITIVE = [] include Aws::Structure end |