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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

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)

15378
15379
15380
15381
15382
15383
15384
# File 'lib/aws-sdk-ssm/types.rb', line 15378

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

#optionString

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)

15378
15379
15380
15381
15382
15383
15384
# File 'lib/aws-sdk-ssm/types.rb', line 15378

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

#valuesArray<String>

The value you want to search for.

Returns:

  • (Array<String>)

15378
15379
15380
15381
15382
15383
15384
# File 'lib/aws-sdk-ssm/types.rb', line 15378

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