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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


15238
15239
15240
15241
15242
15243
15244
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15238

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) 


15238
15239
15240
15241
15242
15243
15244
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15238

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>) 


15238
15239
15240
15241
15242
15243
15244
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 15238

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