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

Interface AutomationExecutionMetadata.Builder

    • Method Detail

      • automationExecutionId

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.Builder documentName​(String documentName)

        The name of the Automation runbook used during execution.

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

      • documentVersion

        AutomationExecutionMetadata.Builder documentVersion​(String documentVersion)

        The document version used during the execution.

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

      • executionStartTime

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.Builder executionEndTime​(Instant executionEndTime)

        The time the execution finished. This isn't populated if the execution is still in progress.

        Parameters:
        executionEndTime - The time the execution finished. This isn't populated if the execution is still in progress.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executedBy

        AutomationExecutionMetadata.Builder executedBy​(String executedBy)

        The IAM role ARN of the user who ran the automation.

        Parameters:
        executedBy - The IAM role ARN of the user who ran the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logFile

        AutomationExecutionMetadata.Builder logFile​(String logFile)

        An S3 bucket where execution information is stored.

        Parameters:
        logFile - An S3 bucket where execution information is stored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputs

        AutomationExecutionMetadata.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.

      • parentAutomationExecutionId

        AutomationExecutionMetadata.Builder parentAutomationExecutionId​(String parentAutomationExecutionId)

        The execution ID of the parent automation.

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

      • currentStepName

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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.

      • failureMessage

        AutomationExecutionMetadata.Builder failureMessage​(String failureMessage)

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

        Parameters:
        failureMessage - 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.

      • targetParameterName

        AutomationExecutionMetadata.Builder targetParameterName​(String targetParameterName)

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

        Parameters:
        targetParameterName - 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.

      • targets

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

        The targets defined by the user when starting the automation.

        Parameters:
        targets - The targets defined by the user when starting the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        AutomationExecutionMetadata.Builder targets​(Target... targets)

        The targets defined by the user when starting the automation.

        Parameters:
        targets - The targets defined by the user when starting the automation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetMaps

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.Builder resolvedTargets​(ResolvedTargets resolvedTargets)

        A list of targets that resolved during the execution.

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

      • maxConcurrency

        AutomationExecutionMetadata.Builder maxConcurrency​(String maxConcurrency)

        The MaxConcurrency value specified by the user when starting the automation.

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

      • maxErrors

        AutomationExecutionMetadata.Builder maxErrors​(String maxErrors)

        The MaxErrors value specified by the user when starting the automation.

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

      • target

        AutomationExecutionMetadata.Builder target​(String target)

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

        Parameters:
        target - 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.

      • alarmConfiguration

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

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

        Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

        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 during a runbook workflow in Change Manager.

        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

        AutomationExecutionMetadata.Builder runbooks​(Runbook... runbooks)

        Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

        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 during a runbook workflow in Change Manager.

        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

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

        Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

        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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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

        AutomationExecutionMetadata.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.