software.amazon.awssdk.services.ssm.model

Interface SendAutomationSignalRequest.Builder

All Superinterfaces:

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

Enclosing class:

SendAutomationSignalRequest

public static interface SendAutomationSignalRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>

Method Summary

Modifier and Type	Method and Description
SendAutomationSignalRequest.Builder	automationExecutionId(String automationExecutionId) The unique identifier for an existing Automation execution that you want to send the signal to.
SendAutomationSignalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SendAutomationSignalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SendAutomationSignalRequest.Builder	payload(Map<String,? extends Collection<String>> payload) The data sent with the signal.
SendAutomationSignalRequest.Builder	signalType(SignalType signalType) The type of signal to send to an Automation execution.
SendAutomationSignalRequest.Builder	signalType(String signalType) The type of signal to send to an Automation execution.

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

build

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

overrideConfiguration

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

automationExecutionId

SendAutomationSignalRequest.Builder automationExecutionId(String automationExecutionId)

The unique identifier for an existing Automation execution that you want to send the signal to.

Parameters:

automationExecutionId - The unique identifier for an existing Automation execution that you want to send the signal to.

Returns:

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

signalType

SendAutomationSignalRequest.Builder signalType(String signalType)

The type of signal to send to an Automation execution.

Parameters:

signalType - The type of signal to send to an Automation execution.

Returns:

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

See Also:

SignalType, SignalType

signalType

SendAutomationSignalRequest.Builder signalType(SignalType signalType)

The type of signal to send to an Automation execution.

Parameters:

signalType - The type of signal to send to an Automation execution.

Returns:

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

See Also:

SignalType, SignalType

payload

SendAutomationSignalRequest.Builder payload(Map<String,? extends Collection<String>> payload)

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Parameters:

payload - The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Returns:

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

overrideConfiguration

SendAutomationSignalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder