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 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 used in a runbook workflow.
String	documentVersion() The version of the Automation runbook used in a runbook workflow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters() For responses, this returns true if the service returned a value for the Parameters property.
boolean	hasTargetLocations() For responses, this returns true if the service returned a value for the TargetLocations property.
boolean	hasTargetMaps() For responses, this returns true if the service returned a value for the TargetMaps property.
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
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 Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
List<Map<String,List<String>>>	targetMaps() A key-value mapping of runbook parameters to target resources.
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()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, 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 used in a runbook workflow.

Returns:

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

documentVersion

public final String documentVersion()

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

Returns:

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

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

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()

For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.

Returns:

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

hasTargetMaps

public final boolean hasTargetMaps()

For responses, this returns true if the service returned a value for the TargetMaps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targetMaps

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

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetMaps() method.

Returns:

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

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()

For responses, this returns true if the service returned a value for the TargetLocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targetLocations

public final List<TargetLocation> targetLocations()

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetLocations() method.

Returns:

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

toBuilder

public Runbook.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Runbook.Builder,Runbook>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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