public static interface AutomationExecution.Builder extends SdkPojo, CopyableBuilder<AutomationExecution.Builder,AutomationExecution>
Modifier and Type | Method and Description |
---|---|
AutomationExecution.Builder |
associationId(String associationId)
The ID of a State Manager association used in the Automation operation.
|
AutomationExecution.Builder |
automationExecutionId(String automationExecutionId)
The execution ID.
|
AutomationExecution.Builder |
automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
|
AutomationExecution.Builder |
automationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
|
AutomationExecution.Builder |
automationSubtype(AutomationSubtype automationSubtype)
The subtype of the Automation operation.
|
AutomationExecution.Builder |
automationSubtype(String automationSubtype)
The subtype of the Automation operation.
|
AutomationExecution.Builder |
changeRequestName(String changeRequestName)
The name of the Change Manager change request.
|
AutomationExecution.Builder |
currentAction(String currentAction)
The action of the step that is currently running.
|
AutomationExecution.Builder |
currentStepName(String currentStepName)
The name of the step that is currently running.
|
AutomationExecution.Builder |
documentName(String documentName)
The name of the Automation document used during the execution.
|
AutomationExecution.Builder |
documentVersion(String documentVersion)
The version of the document to use during execution.
|
AutomationExecution.Builder |
executedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
|
AutomationExecution.Builder |
executionEndTime(Instant executionEndTime)
The time the execution finished.
|
AutomationExecution.Builder |
executionStartTime(Instant executionStartTime)
The time the execution started.
|
AutomationExecution.Builder |
failureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
|
AutomationExecution.Builder |
maxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
|
AutomationExecution.Builder |
maxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
|
AutomationExecution.Builder |
mode(ExecutionMode mode)
The automation execution mode.
|
AutomationExecution.Builder |
mode(String mode)
The automation execution mode.
|
AutomationExecution.Builder |
opsItemId(String opsItemId)
The ID of an OpsItem that is created to represent a Change Manager change request.
|
AutomationExecution.Builder |
outputs(Map<String,? extends Collection<String>> outputs)
The list of execution outputs as defined in the automation document.
|
AutomationExecution.Builder |
parameters(Map<String,? extends Collection<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
|
AutomationExecution.Builder |
parentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
|
default AutomationExecution.Builder |
progressCounters(Consumer<ProgressCounters.Builder> progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.
|
AutomationExecution.Builder |
progressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account
Automation execution.
|
default AutomationExecution.Builder |
resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets)
A list of resolved targets in the rate control execution.
|
AutomationExecution.Builder |
resolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
|
AutomationExecution.Builder |
runbooks(Collection<Runbook> runbooks)
Information about the Automation runbooks (Automation documents) that are run as part of a runbook workflow.
|
AutomationExecution.Builder |
runbooks(Consumer<Runbook.Builder>... runbooks)
Information about the Automation runbooks (Automation documents) that are run as part of a runbook workflow.
|
AutomationExecution.Builder |
runbooks(Runbook... runbooks)
Information about the Automation runbooks (Automation documents) that are run as part of a runbook workflow.
|
AutomationExecution.Builder |
scheduledTime(Instant scheduledTime)
The date and time the Automation operation is scheduled to start.
|
AutomationExecution.Builder |
stepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
AutomationExecution.Builder |
stepExecutions(Consumer<StepExecution.Builder>... stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
AutomationExecution.Builder |
stepExecutions(StepExecution... stepExecutions)
A list of details about the current state of all steps that comprise an execution.
|
AutomationExecution.Builder |
stepExecutionsTruncated(Boolean stepExecutionsTruncated)
A boolean value that indicates if the response contains the full list of the Automation step executions.
|
AutomationExecution.Builder |
target(String target)
The target of the execution.
|
AutomationExecution.Builder |
targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
AutomationExecution.Builder |
targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
AutomationExecution.Builder |
targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
|
AutomationExecution.Builder |
targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecution.Builder |
targetMaps(Map<String,? extends Collection<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecution.Builder |
targetParameterName(String targetParameterName)
The parameter name.
|
AutomationExecution.Builder |
targets(Collection<Target> targets)
The specified targets.
|
AutomationExecution.Builder |
targets(Consumer<Target.Builder>... targets)
The specified targets.
|
AutomationExecution.Builder |
targets(Target... targets)
The specified targets.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
AutomationExecution.Builder automationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.AutomationExecution.Builder documentName(String documentName)
The name of the Automation document used during the execution.
documentName
- The name of the Automation document used during the execution.AutomationExecution.Builder documentVersion(String documentVersion)
The version of the document to use during execution.
documentVersion
- The version of the document to use during execution.AutomationExecution.Builder executionStartTime(Instant executionStartTime)
The time the execution started.
executionStartTime
- The time the execution started.AutomationExecution.Builder executionEndTime(Instant executionEndTime)
The time the execution finished.
executionEndTime
- The time the execution finished.AutomationExecution.Builder automationExecutionStatus(String automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
,
AutomationExecutionStatus
AutomationExecution.Builder automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The execution status of the Automation.
automationExecutionStatus
- The execution status of the Automation.AutomationExecutionStatus
,
AutomationExecutionStatus
AutomationExecution.Builder stepExecutions(Collection<StepExecution> stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation
document contains a list of steps that are run in order.AutomationExecution.Builder stepExecutions(StepExecution... stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation
document contains a list of steps that are run in order.AutomationExecution.Builder stepExecutions(Consumer<StepExecution.Builder>... stepExecutions)
A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #stepExecutions(List)
.stepExecutions
- a consumer that will call methods on List.Builder
#stepExecutions(List)
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 action to get the full list of step executions.
stepExecutionsTruncated
- A boolean value that indicates if the response contains the full list of the Automation step
executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step
executions.AutomationExecution.Builder parameters(Map<String,? extends Collection<String>> parameters)
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
parameters
- The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.AutomationExecution.Builder outputs(Map<String,? extends Collection<String>> outputs)
The list of execution outputs as defined in the automation document.
outputs
- The list of execution outputs as defined in the automation document.AutomationExecution.Builder failureMessage(String failureMessage)
A message describing why an execution has failed, if the status is set to Failed.
failureMessage
- A message describing why an execution has failed, if the status is set to Failed.AutomationExecution.Builder mode(String mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
,
ExecutionMode
AutomationExecution.Builder mode(ExecutionMode mode)
The automation execution mode.
mode
- The automation execution mode.ExecutionMode
,
ExecutionMode
AutomationExecution.Builder parentAutomationExecutionId(String parentAutomationExecutionId)
The AutomationExecutionId of the parent automation.
parentAutomationExecutionId
- The AutomationExecutionId of the parent automation.AutomationExecution.Builder executedBy(String executedBy)
The Amazon Resource Name (ARN) of the user who ran the automation.
executedBy
- The Amazon Resource Name (ARN) of the user who ran the automation.AutomationExecution.Builder currentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.AutomationExecution.Builder currentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.AutomationExecution.Builder targetParameterName(String targetParameterName)
The parameter name.
targetParameterName
- The parameter name.AutomationExecution.Builder targets(Collection<Target> targets)
The specified targets.
targets
- The specified targets.AutomationExecution.Builder targets(Target... targets)
The specified targets.
targets
- The specified targets.AutomationExecution.Builder targets(Consumer<Target.Builder>... targets)
The specified targets.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #targets(List)
.targets
- a consumer that will call methods on List.Builder
#targets(List)
AutomationExecution.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.AutomationExecution.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.AutomationExecution.Builder resolvedTargets(ResolvedTargets resolvedTargets)
A list of resolved targets in the rate control execution.
resolvedTargets
- A list of resolved targets in the rate control execution.default AutomationExecution.Builder resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets)
A list of resolved targets in the rate control execution.
This is a convenience that creates an instance of theResolvedTargets.Builder
avoiding the need to
create one manually via ResolvedTargets.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to resolvedTargets(ResolvedTargets)
.resolvedTargets
- a consumer that will call methods on ResolvedTargets.Builder
resolvedTargets(ResolvedTargets)
AutomationExecution.Builder maxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when the execution started.
maxConcurrency
- The MaxConcurrency value specified by the user when the execution started.AutomationExecution.Builder maxErrors(String maxErrors)
The MaxErrors value specified by the user when the execution started.
maxErrors
- The MaxErrors value specified by the user when the execution started.AutomationExecution.Builder target(String target)
The target of the execution.
target
- The target of the execution.AutomationExecution.Builder targetLocations(Collection<TargetLocation> targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
targetLocations
- The combination of AWS Regions and/or AWS accounts where you want to run the Automation.AutomationExecution.Builder targetLocations(TargetLocation... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
targetLocations
- The combination of AWS Regions and/or AWS accounts where you want to run the Automation.AutomationExecution.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)
The combination of AWS Regions and/or AWS accounts where you want to run the Automation.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #targetLocations(List)
.targetLocations
- a consumer that will call methods on List.Builder
#targetLocations(List)
AutomationExecution.Builder progressCounters(ProgressCounters progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
progressCounters
- An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and
multi-account Automation execution.default AutomationExecution.Builder progressCounters(Consumer<ProgressCounters.Builder> progressCounters)
An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.
This is a convenience that creates an instance of theProgressCounters.Builder
avoiding the need to
create one manually via ProgressCounters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to progressCounters(ProgressCounters)
.progressCounters
- a consumer that will call methods on ProgressCounters.Builder
progressCounters(ProgressCounters)
AutomationExecution.Builder automationSubtype(String automationSubtype)
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest
.
automationSubtype
- The subtype of the Automation operation. Currently, the only supported value is
ChangeRequest
.AutomationSubtype
,
AutomationSubtype
AutomationExecution.Builder automationSubtype(AutomationSubtype automationSubtype)
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest
.
automationSubtype
- The subtype of the Automation operation. Currently, the only supported value is
ChangeRequest
.AutomationSubtype
,
AutomationSubtype
AutomationExecution.Builder scheduledTime(Instant scheduledTime)
The date and time the Automation operation is scheduled to start.
scheduledTime
- The date and time the Automation operation is scheduled to start.AutomationExecution.Builder runbooks(Collection<Runbook> runbooks)
Information about the Automation runbooks (Automation documents) 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.
runbooks
- Information about the Automation runbooks (Automation documents) 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.
AutomationExecution.Builder runbooks(Runbook... runbooks)
Information about the Automation runbooks (Automation documents) 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.
runbooks
- Information about the Automation runbooks (Automation documents) 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.
AutomationExecution.Builder runbooks(Consumer<Runbook.Builder>... runbooks)
Information about the Automation runbooks (Automation documents) 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.
List.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #runbooks(List)
.runbooks
- a consumer that will call methods on List.Builder
#runbooks(List)
AutomationExecution.Builder opsItemId(String opsItemId)
The ID of an OpsItem that is created to represent a Change Manager change request.
opsItemId
- The ID of an OpsItem that is created to represent a Change Manager change request.AutomationExecution.Builder associationId(String associationId)
The ID of a State Manager association used in the Automation operation.
associationId
- The ID of a State Manager association used in the Automation operation.AutomationExecution.Builder changeRequestName(String changeRequestName)
The name of the Change Manager change request.
changeRequestName
- The name of the Change Manager change request.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.