Class: Aws::SecretsManager::Types::Filter

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

Overview

Note:

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

{
  key: "description", # accepts description, name, tag-key, tag-value, primary-region, all
  values: ["FilterValueStringType"],
}

Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The following are keys you can use:

  • description: Prefix match, not case-sensitive.

  • name: Prefix match, case-sensitive.

  • tag-key: Prefix match, case-sensitive.

  • tag-value: Prefix match, case-sensitive.

  • primary-region: Prefix match, case-sensitive.

  • all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

Returns:

  • (String)


702
703
704
705
706
707
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 702

class Filter < Struct.new(
  :key,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

The keyword to filter for.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

Returns:

  • (Array<String>)


702
703
704
705
706
707
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 702

class Filter < Struct.new(
  :key,
  :values)
  SENSITIVE = []
  include Aws::Structure
end