Interface AutomationExecutionPreview.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AutomationExecutionPreview.Builder,AutomationExecutionPreview>, SdkBuilder<AutomationExecutionPreview.Builder,AutomationExecutionPreview>, SdkPojo
Enclosing class:
AutomationExecutionPreview
@Mutable @NotThreadSafe public static interface AutomationExecutionPreview.Builder extends SdkPojo, CopyableBuilder<AutomationExecutionPreview.Builder,AutomationExecutionPreview>

  • Method Details

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

    • targetPreviews

      AutomationExecutionPreview.Builder targetPreviews(Consumer<TargetPreview.Builder>... targetPreviews)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetPreviews(List<TargetPreview>).

      Parameters:
      targetPreviews - a consumer that will call methods on TargetPreview.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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