DocumentParameter

Parameters specified in a Systems Manager document that run on the server when the command is run.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

Link copied to clipboard

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

Link copied to clipboard
val name: String?

The name of the parameter.

Link copied to clipboard

The type of parameter. The type can be either String or StringList.

Functions

Link copied to clipboard
inline fun copy(block: DocumentParameter.Builder.() -> Unit = {}): DocumentParameter
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String