Class: Aws::IoT::Types::DocumentParameter

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

Overview

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8465

class DocumentParameter < Struct.new(
  :key,
  :description,
  :regex,
  :example,
  :optional)
  SENSITIVE = []
  include Aws::Structure
end

#exampleString

An example illustrating a pattern that need to be replaced in a managed template job document schema.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8465

class DocumentParameter < Struct.new(
  :key,
  :description,
  :regex,
  :example,
  :optional)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8465

class DocumentParameter < Struct.new(
  :key,
  :description,
  :regex,
  :example,
  :optional)
  SENSITIVE = []
  include Aws::Structure
end

#optionalBoolean

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

Returns:

  • (Boolean)


8465
8466
8467
8468
8469
8470
8471
8472
8473
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8465

class DocumentParameter < Struct.new(
  :key,
  :description,
  :regex,
  :example,
  :optional)
  SENSITIVE = []
  include Aws::Structure
end

#regexString

A regular expression of the patterns that need to be replaced in a managed template job document schema.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8465

class DocumentParameter < Struct.new(
  :key,
  :description,
  :regex,
  :example,
  :optional)
  SENSITIVE = []
  include Aws::Structure
end