Interface StartExecutionPreviewRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartExecutionPreviewRequest.Builder,StartExecutionPreviewRequest>, SdkBuilder<StartExecutionPreviewRequest.Builder,StartExecutionPreviewRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

StartExecutionPreviewRequest

@Mutable
@NotThreadSafe
public static interface StartExecutionPreviewRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<StartExecutionPreviewRequest.Builder,StartExecutionPreviewRequest>

Method Summary

Modifier and Type	Method	Description
StartExecutionPreviewRequest.Builder	documentName(String documentName)	The name of the Automation runbook to run.
StartExecutionPreviewRequest.Builder	documentVersion(String documentVersion)	The version of the Automation runbook to run.
default StartExecutionPreviewRequest.Builder	executionInputs(Consumer<ExecutionInputs.Builder> executionInputs)	Information about the inputs that can be specified for the preview operation.
StartExecutionPreviewRequest.Builder	executionInputs(ExecutionInputs executionInputs)	Information about the inputs that can be specified for the preview operation.
StartExecutionPreviewRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartExecutionPreviewRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Method Details

documentName

StartExecutionPreviewRequest.Builder documentName(String documentName)

The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.

Parameters:

documentName - The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.

Returns:

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

documentVersion

StartExecutionPreviewRequest.Builder documentVersion(String documentVersion)

The version of the Automation runbook to run. The default value is $DEFAULT.

Parameters:

documentVersion - The version of the Automation runbook to run. The default value is $DEFAULT.

Returns:

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

executionInputs

StartExecutionPreviewRequest.Builder executionInputs(ExecutionInputs executionInputs)

Information about the inputs that can be specified for the preview operation.

Parameters:

executionInputs - Information about the inputs that can be specified for the preview operation.

Returns:

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

executionInputs

default StartExecutionPreviewRequest.Builder executionInputs(Consumer<ExecutionInputs.Builder> executionInputs)

Information about the inputs that can be specified for the preview operation.

This is a convenience method that creates an instance of the ExecutionInputs.Builder avoiding the need to create one manually via ExecutionInputs.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionInputs(ExecutionInputs).

Parameters:

executionInputs - a consumer that will call methods on ExecutionInputs.Builder

Returns:

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

See Also:

• executionInputs(ExecutionInputs)

overrideConfiguration

StartExecutionPreviewRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartExecutionPreviewRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.