iot/aws.sdk.kotlin.services.iot.model/DocumentParameter

DocumentParameter

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.

Types

Builder

class Builder

Companion

object Companion

Properties

description

val description: String?

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

example

val example: String?

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

key

val key: String?

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

optional

val optional: Boolean

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

regex

val regex: String?

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

Functions

copy

inline fun copy(block: DocumentParameter.Builder.() -> Unit = {}): DocumentParameter

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String