software.amazon.awssdk.services.ssm.model

Class Runbook

java.lang.Object

software.amazon.awssdk.services.ssm.model.Runbook

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Runbook.Builder,Runbook>

@Generated(value="software.amazon.awssdk:codegen")
public final class Runbook
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Runbook.Builder,Runbook>

Information about an Automation runbook (Automation document) 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Runbook.Builder

Method Summary

Modifier and Type	Method and Description
static Runbook.Builder	builder()
String	documentName() The name of the Automation runbook (Automation document) used in a runbook workflow.
String	documentVersion() The version of the Automation runbook (Automation document) used in a runbook workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargetLocations() Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	maxConcurrency() 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.
String	maxErrors() 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.
Map<String,List<String>>	parameters() The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
List<SdkField<?>>	sdkFields()
static Class<? extends Runbook.Builder>	serializableBuilderClass()
List<TargetLocation>	targetLocations() Information about the AWS Regions and accounts targeted by the current Runbook operation.
String	targetParameterName() The name of the parameter used as the target resource for the rate-controlled runbook workflow.
List<Target>	targets() A key-value mapping to target resources that the Runbook operation performs tasks on.
Runbook.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

documentName

public final String documentName()

The name of the Automation runbook (Automation document) used in a runbook workflow.

Returns:

The name of the Automation runbook (Automation document) used in a runbook workflow.

documentVersion

public final String documentVersion()

The version of the Automation runbook (Automation document) used in a runbook workflow.

Returns:

The version of the Automation runbook (Automation document) used in a runbook workflow.

hasParameters

public final boolean hasParameters()

Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameters

public final Map<String,List<String>> parameters()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasParameters() to see if a value was sent in this field.

Returns:

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

targetParameterName

public final String targetParameterName()

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

Returns:

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

hasTargets

public final boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

public final List<Target> targets()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargets() to see if a value was sent in this field.

Returns:

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

maxConcurrency

public final String maxConcurrency()

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.

Returns:

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

public final String maxErrors()

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.

Returns:

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.

hasTargetLocations

public final boolean hasTargetLocations()

Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetLocations

public final List<TargetLocation> targetLocations()

Information about the AWS Regions and accounts targeted by the current Runbook operation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargetLocations() to see if a value was sent in this field.

Returns:

Information about the AWS Regions and accounts targeted by the current Runbook operation.

toBuilder

public Runbook.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Runbook.Builder,Runbook>

Returns:

a builder for type T

builder

public static Runbook.Builder builder()

serializableBuilderClass

public static Class<? extends Runbook.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.