Interface AutomationExecution.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AutomationExecution.Builder,
,AutomationExecution> SdkBuilder<AutomationExecution.Builder,
,AutomationExecution> SdkPojo
- Enclosing class:
AutomationExecution
-
Method Summary
Modifier and TypeMethodDescriptiondefault AutomationExecution.Builder
alarmConfiguration
(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The details for the CloudWatch alarm applied to your automation.alarmConfiguration
(AlarmConfiguration alarmConfiguration) The details for the CloudWatch alarm applied to your automation.associationId
(String associationId) The ID of a State Manager association used in the Automation operation.automationExecutionId
(String automationExecutionId) The execution ID.automationExecutionStatus
(String automationExecutionStatus) The execution status of the Automation.automationExecutionStatus
(AutomationExecutionStatus automationExecutionStatus) The execution status of the Automation.automationSubtype
(String automationSubtype) The subtype of the Automation operation.automationSubtype
(AutomationSubtype automationSubtype) The subtype of the Automation operation.changeRequestName
(String changeRequestName) The name of the Change Manager change request.currentAction
(String currentAction) The action of the step that is currently running.currentStepName
(String currentStepName) The name of the step that is currently running.documentName
(String documentName) The name of the Automation runbook used during the execution.documentVersion
(String documentVersion) The version of the document to use during execution.executedBy
(String executedBy) The Amazon Resource Name (ARN) of the user who ran the automation.executionEndTime
(Instant executionEndTime) The time the execution finished.executionStartTime
(Instant executionStartTime) The time the execution started.failureMessage
(String failureMessage) A message describing why an execution has failed, if the status is set to Failed.maxConcurrency
(String maxConcurrency) TheMaxConcurrency
value specified by the user when the execution started.The MaxErrors value specified by the user when the execution started.The automation execution mode.mode
(ExecutionMode mode) The automation execution mode.The ID of an OpsItem that is created to represent a Change Manager change request.outputs
(Map<String, ? extends Collection<String>> outputs) The list of execution outputs as defined in the Automation runbook.parameters
(Map<String, ? extends Collection<String>> parameters) The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.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 Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.progressCounters
(ProgressCounters progressCounters) An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager 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.resolvedTargets
(ResolvedTargets resolvedTargets) A list of resolved targets in the rate control execution.runbooks
(Collection<Runbook> runbooks) Information about the Automation runbooks that are run as part of a runbook workflow.runbooks
(Consumer<Runbook.Builder>... runbooks) Information about the Automation runbooks that are run as part of a runbook workflow.Information about the Automation runbooks that are run as part of a runbook workflow.scheduledTime
(Instant scheduledTime) The date and time the Automation operation is scheduled to start.stepExecutions
(Collection<StepExecution> stepExecutions) A list of details about the current state of all steps that comprise an execution.stepExecutions
(Consumer<StepExecution.Builder>... stepExecutions) A list of details about the current state of all steps that comprise an execution.stepExecutions
(StepExecution... stepExecutions) A list of details about the current state of all steps that comprise an execution.stepExecutionsTruncated
(Boolean stepExecutionsTruncated) A boolean value that indicates if the response contains the full list of the Automation step executions.The target of the execution.targetLocations
(Collection<TargetLocation> targetLocations) The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.targetLocations
(Consumer<TargetLocation.Builder>... targetLocations) The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.targetLocations
(TargetLocation... targetLocations) The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.targetMaps
(Collection<? extends Map<String, ? extends Collection<String>>> targetMaps) The specified key-value mapping of document parameters to target resources.targetMaps
(Map<String, ? extends Collection<String>>... targetMaps) The specified key-value mapping of document parameters to target resources.targetParameterName
(String targetParameterName) The parameter name.targets
(Collection<Target> targets) The specified targets.targets
(Consumer<Target.Builder>... targets) The specified targets.The specified targets.triggeredAlarms
(Collection<AlarmStateInformation> triggeredAlarms) The CloudWatch alarm that was invoked by the automation.triggeredAlarms
(Consumer<AlarmStateInformation.Builder>... triggeredAlarms) The CloudWatch alarm that was invoked by the automation.triggeredAlarms
(AlarmStateInformation... triggeredAlarms) The CloudWatch alarm that was invoked by the automation.variables
(Map<String, ? extends Collection<String>> variables) Variables defined for the automation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The name of the Automation runbook used during the execution.
- Parameters:
documentName
- The name of the Automation runbook used during the execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentVersion
The version of the document to use during execution.
- Parameters:
documentVersion
- The version of the document to use during execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The time the execution finished.
- Parameters:
executionEndTime
- The time the execution finished.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
automationExecutionStatus
The execution status of the Automation.
- Parameters:
automationExecutionStatus
- The execution status of the Automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
automationExecutionStatus
AutomationExecution.Builder automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus) The execution status of the Automation.
- Parameters:
automationExecutionStatus
- The execution status of the Automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stepExecutions
A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
- Parameters:
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stepExecutions
A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
- Parameters:
stepExecutions
- A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stepExecutions
A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.
This is a convenience method that creates an instance of theStepExecution.Builder
avoiding the need to create one manually viaStepExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostepExecutions(List<StepExecution>)
.- Parameters:
stepExecutions
- a consumer that will call methods onStepExecution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stepExecutionsTruncated
A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.
- Parameters:
stepExecutionsTruncated
- A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
- Parameters:
parameters
- The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
failureMessage
A message describing why an execution has failed, if the status is set to Failed.
- Parameters:
failureMessage
- A message describing why an execution has failed, if the status is set to Failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mode
The automation execution mode.
- Parameters:
mode
- The automation execution mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mode
The automation execution mode.
- Parameters:
mode
- The automation execution mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parentAutomationExecutionId
The AutomationExecutionId of the parent automation.
- Parameters:
parentAutomationExecutionId
- The AutomationExecutionId of the parent automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executedBy
The Amazon Resource Name (ARN) of the user who ran the automation.
- Parameters:
executedBy
- The Amazon Resource Name (ARN) of the user who ran the automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
-
targetParameterName
The parameter name.
- Parameters:
targetParameterName
- The parameter name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The specified targets.
- Parameters:
targets
- The specified targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The specified targets.
- Parameters:
targets
- The specified targets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The specified targets.
This is a convenience method that creates an instance of theTarget.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargets(List<Target>)
.- Parameters:
targets
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
targetMaps
AutomationExecution.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
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
A list of resolved targets in the rate control execution.
- Parameters:
resolvedTargets
- A list of resolved targets in the rate control execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resolvedTargets
default AutomationExecution.Builder resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets) A list of resolved targets in the rate control execution.
This is a convenience method that creates an instance of theResolvedTargets.Builder
avoiding the need to create one manually viaResolvedTargets.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresolvedTargets(ResolvedTargets)
.- Parameters:
resolvedTargets
- a consumer that will call methods onResolvedTargets.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxConcurrency
The
MaxConcurrency
value specified by the user when the execution started.- Parameters:
maxConcurrency
- TheMaxConcurrency
value specified by the user when the execution started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxErrors
The MaxErrors value specified by the user when the execution started.
- Parameters:
maxErrors
- The MaxErrors value specified by the user when the execution started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
target
The target of the execution.
- Parameters:
target
- The target of the execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
- Parameters:
targetLocations
- The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
- Parameters:
targetLocations
- The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetLocations
The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
This is a convenience method that creates an instance of theTargetLocation.Builder
avoiding the need to create one manually viaTargetLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetLocations(List<TargetLocation>)
.- Parameters:
targetLocations
- a consumer that will call methods onTargetLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
progressCounters
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
- Parameters:
progressCounters
- An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
progressCounters
default AutomationExecution.Builder progressCounters(Consumer<ProgressCounters.Builder> progressCounters) An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
This is a convenience method that creates an instance of theProgressCounters.Builder
avoiding the need to create one manually viaProgressCounters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprogressCounters(ProgressCounters)
.- Parameters:
progressCounters
- a consumer that will call methods onProgressCounters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
alarmConfiguration
default AutomationExecution.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The details for the CloudWatch alarm applied to your automation.
This is a convenience method that creates an instance of theAlarmConfiguration.Builder
avoiding the need to create one manually viaAlarmConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmConfiguration(AlarmConfiguration)
.- Parameters:
alarmConfiguration
- a consumer that will call methods onAlarmConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
AutomationExecution.Builder triggeredAlarms(Consumer<AlarmStateInformation.Builder>... triggeredAlarms) The CloudWatch alarm that was invoked by the automation.
This is a convenience method that creates an instance of theAlarmStateInformation.Builder
avoiding the need to create one manually viaAlarmStateInformation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totriggeredAlarms(List<AlarmStateInformation>)
.- Parameters:
triggeredAlarms
- a consumer that will call methods onAlarmStateInformation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isChangeRequest
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isChangeRequest
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Information about the Automation runbooks 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.
- Parameters:
runbooks
- Information about the Automation runbooks 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runbooks
Information about the Automation runbooks 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.
- Parameters:
runbooks
- Information about the Automation runbooks 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runbooks
Information about the Automation runbooks 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.
Runbook.Builder
avoiding the need to create one manually viaRunbook.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torunbooks(List<Runbook>)
.- Parameters:
runbooks
- a consumer that will call methods onRunbook.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-
variables
Variables defined for the automation.
- Parameters:
variables
- Variables defined for the automation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-