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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DocumentParameter

Includes:

Structure

Defined in:

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.

<note markdown=“1”> ‘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.

</note>

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

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

• #example ⇒ String

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

• #key ⇒ String

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

• #optional ⇒ Boolean

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

• #regex ⇒ String

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

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6795

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

#example ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6795

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

#key ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6795

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

#optional ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 6795

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

#regex ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6795

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