Class: Aws::SSM::Types::ParameterStringFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::ParameterStringFilter
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
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
-
#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.
14627 14628 14629 14630 14631 14632 14633 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14627 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
.)
14627 14628 14629 14630 14631 14632 14633 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14627 class ParameterStringFilter < Struct.new( :key, :option, :values) SENSITIVE = [] include Aws::Structure end |
#values ⇒ Array<String>
The value you want to search for.
14627 14628 14629 14630 14631 14632 14633 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14627 class ParameterStringFilter < Struct.new( :key, :option, :values) SENSITIVE = [] include Aws::Structure end |