public static interface AutomationExecutionMetadata.Builder extends SdkPojo, CopyableBuilder<AutomationExecutionMetadata.Builder,AutomationExecutionMetadata>
Modifier and Type | Method and Description |
---|---|
AutomationExecutionMetadata.Builder |
associationId(String associationId)
The ID of a State Manager association used in the Automation operation.
|
AutomationExecutionMetadata.Builder |
automationExecutionId(String automationExecutionId)
The execution ID.
|
AutomationExecutionMetadata.Builder |
automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution.
|
AutomationExecutionMetadata.Builder |
automationExecutionStatus(String automationExecutionStatus)
The status of the execution.
|
AutomationExecutionMetadata.Builder |
automationSubtype(AutomationSubtype automationSubtype)
The subtype of the Automation operation.
|
AutomationExecutionMetadata.Builder |
automationSubtype(String automationSubtype)
The subtype of the Automation operation.
|
AutomationExecutionMetadata.Builder |
automationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions.
|
AutomationExecutionMetadata.Builder |
automationType(String automationType)
Use this filter with DescribeAutomationExecutions.
|
AutomationExecutionMetadata.Builder |
changeRequestName(String changeRequestName)
The name of the Change Manager change request.
|
AutomationExecutionMetadata.Builder |
currentAction(String currentAction)
The action of the step that is currently running.
|
AutomationExecutionMetadata.Builder |
currentStepName(String currentStepName)
The name of the step that is currently running.
|
AutomationExecutionMetadata.Builder |
documentName(String documentName)
The name of the Automation document used during execution.
|
AutomationExecutionMetadata.Builder |
documentVersion(String documentVersion)
The document version used during the execution.
|
AutomationExecutionMetadata.Builder |
executedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
|
AutomationExecutionMetadata.Builder |
executionEndTime(Instant executionEndTime)
The time the execution finished.
|
AutomationExecutionMetadata.Builder |
executionStartTime(Instant executionStartTime)
The time the execution started.
|
AutomationExecutionMetadata.Builder |
failureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata.Builder |
logFile(String logFile)
An S3 bucket where execution information is stored.
|
AutomationExecutionMetadata.Builder |
maxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
|
AutomationExecutionMetadata.Builder |
maxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
|
AutomationExecutionMetadata.Builder |
mode(ExecutionMode mode)
The Automation execution mode.
|
AutomationExecutionMetadata.Builder |
mode(String mode)
The Automation execution mode.
|
AutomationExecutionMetadata.Builder |
opsItemId(String opsItemId)
The ID of an OpsItem that is created to represent a Change Manager change request.
|
AutomationExecutionMetadata.Builder |
outputs(Map<String,? extends Collection<String>> outputs)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata.Builder |
parentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
|
default AutomationExecutionMetadata.Builder |
resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets)
A list of targets that resolved during the execution.
|
AutomationExecutionMetadata.Builder |
resolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
|
AutomationExecutionMetadata.Builder |
runbooks(Collection<Runbook> runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in
Change Manager.
|
AutomationExecutionMetadata.Builder |
runbooks(Consumer<Runbook.Builder>... runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in
Change Manager.
|
AutomationExecutionMetadata.Builder |
runbooks(Runbook... runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in
Change Manager.
|
AutomationExecutionMetadata.Builder |
scheduledTime(Instant scheduledTime)
The date and time the Automation operation is scheduled to start.
|
AutomationExecutionMetadata.Builder |
target(String target)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata.Builder |
targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecutionMetadata.Builder |
targetMaps(Map<String,? extends Collection<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecutionMetadata.Builder |
targetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata.Builder |
targets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
|
AutomationExecutionMetadata.Builder |
targets(Consumer<Target.Builder>... targets)
The targets defined by the user when starting the Automation.
|
AutomationExecutionMetadata.Builder |
targets(Target... targets)
The targets defined by the user when starting the Automation.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
AutomationExecutionMetadata.Builder automationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.AutomationExecutionMetadata.Builder documentName(String documentName)
The name of the Automation document used during execution.
documentName
- The name of the Automation document used during execution.AutomationExecutionMetadata.Builder documentVersion(String documentVersion)
The document version used during the execution.
documentVersion
- The document version used during the execution.AutomationExecutionMetadata.Builder automationExecutionStatus(String automationExecutionStatus)
The status of the execution.
automationExecutionStatus
- The status of the execution.AutomationExecutionStatus
,
AutomationExecutionStatus
AutomationExecutionMetadata.Builder automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution.
automationExecutionStatus
- The status of the execution.AutomationExecutionStatus
,
AutomationExecutionStatus
AutomationExecutionMetadata.Builder executionStartTime(Instant executionStartTime)
The time the execution started.
executionStartTime
- The time the execution started.AutomationExecutionMetadata.Builder executionEndTime(Instant executionEndTime)
The time the execution finished. This is not populated if the execution is still in progress.
executionEndTime
- The time the execution finished. This is not populated if the execution is still in progress.AutomationExecutionMetadata.Builder executedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
executedBy
- The IAM role ARN of the user who ran the Automation.AutomationExecutionMetadata.Builder logFile(String logFile)
An S3 bucket where execution information is stored.
logFile
- An S3 bucket where execution information is stored.AutomationExecutionMetadata.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.AutomationExecutionMetadata.Builder mode(String mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
,
ExecutionMode
AutomationExecutionMetadata.Builder mode(ExecutionMode mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
,
ExecutionMode
AutomationExecutionMetadata.Builder parentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
parentAutomationExecutionId
- The ExecutionId of the parent Automation.AutomationExecutionMetadata.Builder currentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.AutomationExecutionMetadata.Builder currentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.AutomationExecutionMetadata.Builder failureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
failureMessage
- The list of execution outputs as defined in the Automation document.AutomationExecutionMetadata.Builder targetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
targetParameterName
- The list of execution outputs as defined in the Automation document.AutomationExecutionMetadata.Builder targets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
targets
- The targets defined by the user when starting the Automation.AutomationExecutionMetadata.Builder targets(Target... targets)
The targets defined by the user when starting the Automation.
targets
- The targets defined by the user when starting the Automation.AutomationExecutionMetadata.Builder targets(Consumer<Target.Builder>... targets)
The targets defined by the user when starting 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 #targets(List)
.targets
- a consumer that will call methods on List.Builder
#targets(List)
AutomationExecutionMetadata.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.AutomationExecutionMetadata.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.AutomationExecutionMetadata.Builder resolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
resolvedTargets
- A list of targets that resolved during the execution.default AutomationExecutionMetadata.Builder resolvedTargets(Consumer<ResolvedTargets.Builder> resolvedTargets)
A list of targets that resolved during the 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)
AutomationExecutionMetadata.Builder maxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
maxConcurrency
- The MaxConcurrency value specified by the user when starting the Automation.AutomationExecutionMetadata.Builder maxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
maxErrors
- The MaxErrors value specified by the user when starting the Automation.AutomationExecutionMetadata.Builder target(String target)
The list of execution outputs as defined in the Automation document.
target
- The list of execution outputs as defined in the Automation document.AutomationExecutionMetadata.Builder automationType(String automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information,
see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager
User Guide.AutomationType
,
AutomationType
AutomationExecutionMetadata.Builder automationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information,
see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager
User Guide.AutomationType
,
AutomationType
AutomationExecutionMetadata.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
AutomationExecutionMetadata.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
AutomationExecutionMetadata.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.AutomationExecutionMetadata.Builder runbooks(Collection<Runbook> runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in Change Manager.
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 during a runbook
workflow in Change Manager. The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
AutomationExecutionMetadata.Builder runbooks(Runbook... runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in Change Manager.
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 during a runbook
workflow in Change Manager. The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
AutomationExecutionMetadata.Builder runbooks(Consumer<Runbook.Builder>... runbooks)
Information about the Automation runbooks (Automation documents) that are run during a runbook workflow in Change Manager.
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)
AutomationExecutionMetadata.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.AutomationExecutionMetadata.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.AutomationExecutionMetadata.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.