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.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

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)


8579
8580
8581
8582
8583
8584
8585
8586
8587
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8579

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)


8579
8580
8581
8582
8583
8584
8585
8586
8587
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8579

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)


8579
8580
8581
8582
8583
8584
8585
8586
8587
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8579

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)


8579
8580
8581
8582
8583
8584
8585
8586
8587
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8579

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)


8579
8580
8581
8582
8583
8584
8585
8586
8587
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8579

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