software.amazon.awssdk.services.ssm.model

Interface Runbook.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Runbook.Builder,Runbook>, SdkBuilder<Runbook.Builder,Runbook>, SdkPojo

Enclosing class:

Runbook

public static interface Runbook.Builder
extends SdkPojo, CopyableBuilder<Runbook.Builder,Runbook>

Method Summary

Modifier and Type	Method and Description
Runbook.Builder	documentName(String documentName) The name of the Automation runbook used in a runbook workflow.
Runbook.Builder	documentVersion(String documentVersion) The version of the Automation runbook used in a runbook workflow.
Runbook.Builder	maxConcurrency(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.
Runbook.Builder	maxErrors(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.
Runbook.Builder	parameters(Map<String,? extends Collection<String>> parameters) The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
Runbook.Builder	targetLocations(Collection<TargetLocation> targetLocations) Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Runbook.Builder	targetLocations(Consumer<TargetLocation.Builder>... targetLocations) Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Runbook.Builder	targetLocations(TargetLocation... targetLocations) Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
Runbook.Builder	targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps) A key-value mapping of runbook parameters to target resources.
Runbook.Builder	targetMaps(Map<String,? extends Collection<String>>... targetMaps) A key-value mapping of runbook parameters to target resources.
Runbook.Builder	targetParameterName(String targetParameterName) The name of the parameter used as the target resource for the rate-controlled runbook workflow.
Runbook.Builder	targets(Collection<Target> targets) A key-value mapping to target resources that the runbook operation performs tasks on.
Runbook.Builder	targets(Consumer<Target.Builder>... targets) A key-value mapping to target resources that the runbook operation performs tasks on.
Runbook.Builder	targets(Target... targets) A key-value mapping to target resources that the runbook operation performs tasks on.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

documentName

Runbook.Builder documentName(String documentName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

documentVersion

Runbook.Builder documentVersion(String documentVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

Runbook.Builder parameters(Map<String,? extends Collection<String>> parameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetParameterName

Runbook.Builder targetParameterName(String targetParameterName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

Runbook.Builder targets(Collection<Target> targets)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

Runbook.Builder targets(Target... targets)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

Runbook.Builder targets(Consumer<Target.Builder>... targets)

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

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #targets(List).

Parameters:

targets - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#targets(List)

targetMaps

Runbook.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetMaps

Runbook.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maxConcurrency

Runbook.Builder maxConcurrency(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxErrors

Runbook.Builder maxErrors(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

targetLocations

Runbook.Builder targetLocations(Collection<TargetLocation> targetLocations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetLocations

Runbook.Builder targetLocations(TargetLocation... targetLocations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

targetLocations

Runbook.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)

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

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #targetLocations(List).

Parameters:

targetLocations - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#targetLocations(List)