You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::ParameterStringFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::ParameterStringFilter
- Defined in:
- (unknown)
Overview
When passing ParameterStringFilter as input to an Aws::Client method, you can use a vanilla Hash:
{
key: "ParameterStringFilterKey", # required
option: "ParameterStringQueryOption",
values: ["ParameterStringFilterValue"],
}
One or more filters. Use a filter to return a more specific list of results.
Instance Attribute Summary collapse
-
#key ⇒ String
The name of the filter.
-
#option ⇒ String
For all filters used with DescribeParameters, valid options include
Equals
andBeginsWith
. -
#values ⇒ Array<String>
The value you want to search for.
Instance Attribute Details
#key ⇒ String
The name of the filter.
ParameterStringFilter
object is used by the
DescribeParameters and GetParametersByPath API actions.
However, not all of the pattern values listed for Key
can be used with
both actions.
For DescribeActions
, all of the listed patterns are valid, with the
exception of Label
.
For GetParametersByPath
, the following patterns listed for Key
are
not valid: tag
, Name
, Path
, and Tier
.
For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide.
#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
.)
#values ⇒ Array<String>
The value you want to search for.