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 and Tier filter keys can't be used with the GetParametersByPath API action. Also, the Label filter key can't be used with the DescribeParameters API action.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The name of the filter.

Returns:

  • (String)


12065
12066
12067
12068
12069
12070
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12065

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

#optionString

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

Returns:

  • (String)


12065
12066
12067
12068
12069
12070
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12065

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

#valuesArray<String>

The value you want to search for.

Returns:

  • (Array<String>)


12065
12066
12067
12068
12069
12070
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12065

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