ssm/aws.sdk.kotlin.services.ssm.model/StepExecution/Builder

Builder

Properties

var action: String?

The action this step performs. The action determines the behavior of the step.

executionEndTime

var executionEndTime: Instant?

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

executionStartTime

var executionStartTime: Instant?

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

var failureDetails: FailureDetails?

Information about the Automation failure.

var failureMessage: String?

If a step failed, this message explains why the execution failed.

var inputs: Map<String, String>?

Fully-resolved values passed into the step before execution.

var isCritical: Boolean?

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

var isEnd: Boolean?

The flag which can be used to end automation no matter whether the step succeeds or fails.

var maxAttempts: Int?

The maximum number of tries to run the action of the step. The default value is 1.

var nextStep: String?

The next step after the step succeeds.

var onFailure: String?

The action to take if the step fails. The default value is Abort.

var outputs: Map<String, List<String>>?

Returned values from the execution of the step.

overriddenParameters

var overriddenParameters: Map<String, List<String>>?

A user-specified list of parameters to override when running a step.

parentStepDetails

var parentStepDetails: ParentStepDetails?

Information about the parent step.

var response: String?

A message associated with the response code for an execution.

var responseCode: String?

The response code returned by the execution of the step.

stepExecutionId

var stepExecutionId: String?

The unique ID of a step execution.

var stepName: String?

The name of this execution step.

var stepStatus: AutomationExecutionStatus?

The execution status for this step.

var targetLocation: TargetLocation?

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

var targets: List<Target>?

The targets for the step execution.

var timeoutSeconds: Long?

The timeout seconds of the step.

triggeredAlarms

var triggeredAlarms: List<AlarmStateInformation>?

The CloudWatch alarms that were invoked by the automation.

var validNextSteps: List<String>?

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

Functions

fun failureDetails(block: FailureDetails.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.FailureDetails inside the given block

parentStepDetails

fun parentStepDetails(block: ParentStepDetails.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.ParentStepDetails inside the given block

fun targetLocation(block: TargetLocation.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.TargetLocation inside the given block