Package software.amazon.awssdk.services.ssm.model

Interface AutomationExecution.Builder

    • Method Detail

      • automationExecutionId

        AutomationExecution.Builder automationExecutionId​(String automationExecutionId)

        The execution ID.

        Parameters:
        automationExecutionId - The execution ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentName

        AutomationExecution.Builder documentName​(String documentName)

        The name of the Automation runbook used during the execution.

        Parameters:
        documentName - The name of the Automation runbook used during the execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentVersion

        AutomationExecution.Builder documentVersion​(String documentVersion)

        The version of the document to use during execution.

        Parameters:
        documentVersion - The version of the document to use during execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionStartTime

        AutomationExecution.Builder executionStartTime​(Instant executionStartTime)

        The time the execution started.

        Parameters:
        executionStartTime - The time the execution started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionEndTime

        AutomationExecution.Builder executionEndTime​(Instant executionEndTime)

        The time the execution finished.

        Parameters:
        executionEndTime - The time the execution finished.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stepExecutions

        AutomationExecution.Builder stepExecutions​(Collection<StepExecution> stepExecutions)

        A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

        Parameters:
        stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stepExecutions

        AutomationExecution.Builder stepExecutions​(StepExecution... stepExecutions)

        A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

        Parameters:
        stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stepExecutions

        AutomationExecution.Builder stepExecutions​(Consumer<StepExecution.Builder>... stepExecutions)

        A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #stepExecutions(List).

        Parameters:
        stepExecutions - a consumer that will call methods on StepExecution.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #stepExecutions(java.util.Collection)

      • stepExecutionsTruncated

        AutomationExecution.Builder stepExecutionsTruncated​(Boolean stepExecutionsTruncated)

        A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

        Parameters:
        stepExecutionsTruncated - A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputs

        AutomationExecution.Builder outputs​(Map<String,​? extends Collection<String>> outputs)

        The list of execution outputs as defined in the Automation runbook.

        Parameters:
        outputs - The list of execution outputs as defined in the Automation runbook.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureMessage

        AutomationExecution.Builder failureMessage​(String failureMessage)

        A message describing why an execution has failed, if the status is set to Failed.

        Parameters:
        failureMessage - A message describing why an execution has failed, if the status is set to Failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentAutomationExecutionId

        AutomationExecution.Builder parentAutomationExecutionId​(String parentAutomationExecutionId)

        The AutomationExecutionId of the parent automation.

        Parameters:
        parentAutomationExecutionId - The AutomationExecutionId of the parent automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executedBy

        AutomationExecution.Builder executedBy​(String executedBy)

        The Amazon Resource Name (ARN) of the user who ran the automation.

        Parameters:
        executedBy - The Amazon Resource Name (ARN) of the user who ran the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • currentStepName

        AutomationExecution.Builder currentStepName​(String currentStepName)

        The name of the step that is currently running.

        Parameters:
        currentStepName - The name of the step that is currently running.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • currentAction

        AutomationExecution.Builder currentAction​(String currentAction)

        The action of the step that is currently running.

        Parameters:
        currentAction - The action of the step that is currently running.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetParameterName

        AutomationExecution.Builder targetParameterName​(String targetParameterName)

        The parameter name.

        Parameters:
        targetParameterName - The parameter name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        AutomationExecution.Builder targets​(Collection<Target> targets)

        The specified targets.

        Parameters:
        targets - The specified targets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        AutomationExecution.Builder targets​(Target... targets)

        The specified targets.

        Parameters:
        targets - The specified targets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetMaps

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

        The specified key-value mapping of document parameters to target resources.

        Parameters:
        targetMaps - The specified key-value mapping of document parameters to target resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetMaps

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

        The specified key-value mapping of document parameters to target resources.

        Parameters:
        targetMaps - The specified key-value mapping of document parameters to target resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resolvedTargets

        AutomationExecution.Builder resolvedTargets​(ResolvedTargets resolvedTargets)

        A list of resolved targets in the rate control execution.

        Parameters:
        resolvedTargets - A list of resolved targets in the rate control execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxConcurrency

        AutomationExecution.Builder maxConcurrency​(String maxConcurrency)

        The MaxConcurrency value specified by the user when the execution started.

        Parameters:
        maxConcurrency - The MaxConcurrency value specified by the user when the execution started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxErrors

        AutomationExecution.Builder maxErrors​(String maxErrors)

        The MaxErrors value specified by the user when the execution started.

        Parameters:
        maxErrors - The MaxErrors value specified by the user when the execution started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • target

        AutomationExecution.Builder target​(String target)

        The target of the execution.

        Parameters:
        target - The target of the execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocations

        AutomationExecution.Builder targetLocations​(Collection<TargetLocation> targetLocations)

        The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

        Parameters:
        targetLocations - The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocations

        AutomationExecution.Builder targetLocations​(TargetLocation... targetLocations)

        The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

        Parameters:
        targetLocations - The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • progressCounters

        AutomationExecution.Builder progressCounters​(ProgressCounters progressCounters)

        An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

        Parameters:
        progressCounters - An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarmConfiguration

        AutomationExecution.Builder alarmConfiguration​(AlarmConfiguration alarmConfiguration)

        The details for the CloudWatch alarm applied to your automation.

        Parameters:
        alarmConfiguration - The details for the CloudWatch alarm applied to your automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • triggeredAlarms

        AutomationExecution.Builder triggeredAlarms​(Collection<AlarmStateInformation> triggeredAlarms)

        The CloudWatch alarm that was invoked by the automation.

        Parameters:
        triggeredAlarms - The CloudWatch alarm that was invoked by the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • triggeredAlarms

        AutomationExecution.Builder triggeredAlarms​(AlarmStateInformation... triggeredAlarms)

        The CloudWatch alarm that was invoked by the automation.

        Parameters:
        triggeredAlarms - The CloudWatch alarm that was invoked by the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocationsURL

        AutomationExecution.Builder targetLocationsURL​(String targetLocationsURL)

        A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

        Parameters:
        targetLocationsURL - A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • automationSubtype

        AutomationExecution.Builder automationSubtype​(String automationSubtype)

        The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

        Parameters:
        automationSubtype - The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutomationSubtype, AutomationSubtype

      • automationSubtype

        AutomationExecution.Builder automationSubtype​(AutomationSubtype automationSubtype)

        The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

        Parameters:
        automationSubtype - The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AutomationSubtype, AutomationSubtype

      • scheduledTime

        AutomationExecution.Builder scheduledTime​(Instant scheduledTime)

        The date and time the Automation operation is scheduled to start.

        Parameters:
        scheduledTime - The date and time the Automation operation is scheduled to start.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runbooks

        AutomationExecution.Builder runbooks​(Collection<Runbook> runbooks)

        Information about the Automation runbooks that are run as part of a runbook workflow.

        The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

        Parameters:
        runbooks - Information about the Automation runbooks that are run as part of a runbook workflow.

        The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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

      • runbooks

        AutomationExecution.Builder runbooks​(Runbook... runbooks)

        Information about the Automation runbooks that are run as part of a runbook workflow.

        The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

        Parameters:
        runbooks - Information about the Automation runbooks that are run as part of a runbook workflow.

        The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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

      • runbooks

        AutomationExecution.Builder runbooks​(Consumer<Runbook.Builder>... runbooks)

        Information about the Automation runbooks that are run as part of a runbook workflow.

        The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #runbooks(List).

        Parameters:
        runbooks - a consumer that will call methods on Runbook.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #runbooks(java.util.Collection)

      • opsItemId

        AutomationExecution.Builder opsItemId​(String opsItemId)

        The ID of an OpsItem that is created to represent a Change Manager change request.

        Parameters:
        opsItemId - The ID of an OpsItem that is created to represent a Change Manager change request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • associationId

        AutomationExecution.Builder associationId​(String associationId)

        The ID of a State Manager association used in the Automation operation.

        Parameters:
        associationId - The ID of a State Manager association used in the Automation operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • changeRequestName

        AutomationExecution.Builder changeRequestName​(String changeRequestName)

        The name of the Change Manager change request.

        Parameters:
        changeRequestName - The name of the Change Manager change request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • variables

        AutomationExecution.Builder variables​(Map<String,​? extends Collection<String>> variables)

        Variables defined for the automation.

        Parameters:
        variables - Variables defined for the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.