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

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key ⇒ String

  The name of the filter.

• #option ⇒ String

  For all filters used with DescribeParameters, valid options include ‘Equals` and `BeginsWith`.

• #values ⇒ Array<String>

  The value you want to search for.

Instance Attribute Details

#key ⇒ String

The name of the filter.

The ‘ParameterStringFilter` object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for `Key` can be used with both operations.

For ‘DescribeParameters`, all of the listed patterns are valid except `Label`.

For ‘GetParametersByPath`, the following patterns listed for `Key` aren’t valid: ‘tag`, `DataType`, `Name`, `Path`, and `Tier`.

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see [Searching for Systems Manager parameters] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html

Returns:

• (String)

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

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

#option ⇒ String

For all filters used with DescribeParameters, valid options include ‘Equals` and `BeginsWith`. The `Name` filter additionally supports the `Contains` option. (Exception: For filters using the key `Path`, valid options include `Recursive` and `OneLevel`.)

For filters used with GetParametersByPath, valid options include ‘Equals` and `BeginsWith`. (Exception: For filters using `Label` as the Key name, the only valid option is `Equals`.)

Returns:

• (String)

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

class ParameterStringFilter < Struct.new(
  :key,
  :option,
  :values)
  SENSITIVE = []
  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 13919

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