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

Class: Aws::SSM::Types::ParameterStringFilter

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

Overview

Note:

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

{
  key: "ParameterStringFilterKey", # required
  option: "ParameterStringQueryOption",
  values: ["ParameterStringFilterValue"],
}

One or more filters. Use a filter to return a more specific list of results.

The Name field can't be used with the GetParametersByPath API action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The name of the filter.

Returns:

  • (String) 


10086
10087
10088
10089
10090
10091
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 10086

class ParameterStringFilter < Struct.new(
  :key,
  :option,
  :values)
  include Aws::Structure
end

#option ⇒ String

Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

Returns:

  • (String) 


10086
10087
10088
10089
10090
10091
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 10086

class ParameterStringFilter < Struct.new(
  :key,
  :option,
  :values)
  include Aws::Structure
end

#values ⇒ Array<String>

The value you want to search for.

Returns:

  • (Array<String>) 


10086
10087
10088
10089
10090
10091
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 10086

class ParameterStringFilter < Struct.new(
  :key,
  :option,
  :values)
  include Aws::Structure
end