Interface AutomationExecutionPreview.Builder

    • Method Detail

      • stepPreviewsWithStrings

        AutomationExecutionPreview.Builder stepPreviewsWithStrings​(Map<String,​Integer> stepPreviews)

        Information about the type of impact a runbook step would have on a resource.

        • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

        • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

        • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

        Parameters:
        stepPreviews - Information about the type of impact a runbook step would have on a resource.

        • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

        • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

        • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

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

        AutomationExecutionPreview.Builder stepPreviews​(Map<ImpactType,​Integer> stepPreviews)

        Information about the type of impact a runbook step would have on a resource.

        • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

        • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

        • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

        Parameters:
        stepPreviews - Information about the type of impact a runbook step would have on a resource.

        • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

        • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

        • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

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

        AutomationExecutionPreview.Builder regions​(Collection<String> regions)

        Information about the Amazon Web Services Regions targeted by the execution preview.

        Parameters:
        regions - Information about the Amazon Web Services Regions targeted by the execution preview.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • regions

        AutomationExecutionPreview.Builder regions​(String... regions)

        Information about the Amazon Web Services Regions targeted by the execution preview.

        Parameters:
        regions - Information about the Amazon Web Services Regions targeted by the execution preview.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • targetPreviews

        AutomationExecutionPreview.Builder targetPreviews​(Collection<TargetPreview> targetPreviews)

        Information that provides a preview of what the impact of running the specified Automation runbook would be.

        Parameters:
        targetPreviews - Information that provides a preview of what the impact of running the specified Automation runbook would be.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • targetPreviews

        AutomationExecutionPreview.Builder targetPreviews​(TargetPreview... targetPreviews)

        Information that provides a preview of what the impact of running the specified Automation runbook would be.

        Parameters:
        targetPreviews - Information that provides a preview of what the impact of running the specified Automation runbook would be.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • totalAccounts

        AutomationExecutionPreview.Builder totalAccounts​(Integer totalAccounts)

        Information about the Amazon Web Services accounts that were included in the execution preview.

        Parameters:
        totalAccounts - Information about the Amazon Web Services accounts that were included in the execution preview.
        Returns:
        Returns a reference to this object so that method calls can be chained together.