Class: Aws::CloudHSMV2::Types::DescribeBackupsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudhsmv2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (Hash<String,Array<String>>) 


667
668
669
670
671
672
673
674
675
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 667

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :shared,
  :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.

Returns:

  • (Integer) 


667
668
669
670
671
672
673
674
675
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 667

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :shared,
  :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.

Returns:

  • (String) 


667
668
669
670
671
672
673
674
675
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 667

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :shared,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end

#shared ⇒ Boolean

Describe backups that are shared with you.

<note markdown=“1”> By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM

PromoteResourceShareCreatedFromPolicy][1

API operation. For more

information about sharing backups, see [ Working with shared backups] in the CloudHSM User Guide.

</note>

[1]: docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html [2]: docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html

Returns:

  • (Boolean) 


667
668
669
670
671
672
673
674
675
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 667

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :shared,
  :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.

Returns:

  • (Boolean) 


667
668
669
670
671
672
673
674
675
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 667

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :shared,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end