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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::ParameterStringFilter

Includes:

Aws::Structure

Defined in:

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.

<note markdown=“1”> The ‘Name` field can’t be used with the GetParametersByPath API action.

</note>

See Also:

• AWS API Documentation

Instance Attribute Summary

• #key ⇒ String

  The name of the filter.

• #option ⇒ String

  Valid options are Equals and BeginsWith.

• #values ⇒ Array<String>

  The value you want to search for.

Instance Attribute Details

#key ⇒ String

The name of the filter.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 9902

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)

# File 'lib/aws-sdk-ssm/types.rb', line 9902

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

#values ⇒ Array<String>

The value you want to search for.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ssm/types.rb', line 9902

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