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

Interface Runbook.Builder

    • Method Detail

      • documentName

        Runbook.Builder documentName​(String documentName)

        The name of the Automation runbook used in a runbook workflow.

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

      • documentVersion

        Runbook.Builder documentVersion​(String documentVersion)

        The version of the Automation runbook used in a runbook workflow.

        Parameters:
        documentVersion - The version of the Automation runbook used in a runbook workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameters

        Runbook.Builder parameters​(Map<String,​? extends Collection<String>> parameters)

        The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

        Parameters:
        parameters - The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetParameterName

        Runbook.Builder targetParameterName​(String targetParameterName)

        The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

        Parameters:
        targetParameterName - The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

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

        A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

        Parameters:
        targets - A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        Runbook.Builder targets​(Target... targets)

        A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

        Parameters:
        targets - A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        Runbook.Builder targets​(Consumer<Target.Builder>... targets)

        A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

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

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

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

      • targetMaps

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

        A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

        Parameters:
        targetMaps - A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetMaps

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

        A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

        Parameters:
        targetMaps - A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxConcurrency

        Runbook.Builder maxConcurrency​(String maxConcurrency)

        The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

        Parameters:
        maxConcurrency - The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxErrors

        Runbook.Builder maxErrors​(String maxErrors)

        The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

        Parameters:
        maxErrors - The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocations

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

        Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

        Parameters:
        targetLocations - Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocations

        Runbook.Builder targetLocations​(TargetLocation... targetLocations)

        Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

        Parameters:
        targetLocations - Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetLocations

        Runbook.Builder targetLocations​(Consumer<TargetLocation.Builder>... targetLocations)

        Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

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

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

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