@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.
Modifier and Type | Class and Description |
---|---|
static interface |
Runbook.Builder |
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.
|
copy
public final String documentName()
The name of the Automation runbook (Automation document) used in a runbook workflow.
public final String documentVersion()
The version of the Automation runbook (Automation document) used in a runbook workflow.
public final boolean hasParameters()
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.
StartChangeRequestExecution
.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
.
Targets
.public final boolean hasTargets()
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.
TargetParameterName
.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.
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.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.
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.public final boolean hasTargetLocations()
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.
public Runbook.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Runbook.Builder,Runbook>
public static Runbook.Builder builder()
public static Class<? extends Runbook.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.