ssm/aws.sdk.kotlin.services.ssm.model/Runbook

Runbook

Information about an Automation runbook used in a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Types

Builder

class Builder

Companion

object Companion

Properties

documentName

val documentName: String

The name of the Automation runbook used in a runbook workflow.

documentVersion

val documentVersion: String?

The version of the Automation runbook used in a runbook workflow.

maxConcurrency

val maxConcurrency: String?

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

maxErrors

val maxErrors: String?

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

parameters

val parameters: Map<String, List<String>>?

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

targetLocations

val targetLocations: List<TargetLocation>?

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

targetMaps

val targetMaps: List<Map<String, List<String>>>?

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

targetParameterName

val targetParameterName: String?

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

targets

val targets: List<Target>?

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String