public static interface GetMaintenanceWindowTaskResponse.Builder extends SsmResponse.Builder, SdkPojo, CopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>
Modifier and Type | Method and Description |
---|---|
GetMaintenanceWindowTaskResponse.Builder |
description(String description)
The retrieved task description.
|
default GetMaintenanceWindowTaskResponse.Builder |
loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
The location in Amazon S3 where the task results are logged.
|
GetMaintenanceWindowTaskResponse.Builder |
loggingInfo(LoggingInfo loggingInfo)
The location in Amazon S3 where the task results are logged.
|
GetMaintenanceWindowTaskResponse.Builder |
maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run this task in parallel.
|
GetMaintenanceWindowTaskResponse.Builder |
maxErrors(String maxErrors)
The maximum number of errors allowed before the task stops being scheduled.
|
GetMaintenanceWindowTaskResponse.Builder |
name(String name)
The retrieved task name.
|
GetMaintenanceWindowTaskResponse.Builder |
priority(Integer priority)
The priority of the task when it runs.
|
GetMaintenanceWindowTaskResponse.Builder |
serviceRoleArn(String serviceRoleArn)
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS)
notifications for maintenance window Run Command tasks.
|
GetMaintenanceWindowTaskResponse.Builder |
targets(Collection<Target> targets)
The targets where the task should run.
|
GetMaintenanceWindowTaskResponse.Builder |
targets(Consumer<Target.Builder>... targets)
The targets where the task should run.
|
GetMaintenanceWindowTaskResponse.Builder |
targets(Target... targets)
The targets where the task should run.
|
GetMaintenanceWindowTaskResponse.Builder |
taskArn(String taskArn)
The resource that the task used during execution.
|
default GetMaintenanceWindowTaskResponse.Builder |
taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)
The parameters to pass to the task when it runs.
|
GetMaintenanceWindowTaskResponse.Builder |
taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
The parameters to pass to the task when it runs.
|
GetMaintenanceWindowTaskResponse.Builder |
taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters to pass to the task when it runs.
|
GetMaintenanceWindowTaskResponse.Builder |
taskType(MaintenanceWindowTaskType taskType)
The type of task to run.
|
GetMaintenanceWindowTaskResponse.Builder |
taskType(String taskType)
The type of task to run.
|
GetMaintenanceWindowTaskResponse.Builder |
windowId(String windowId)
The retrieved maintenance window ID.
|
GetMaintenanceWindowTaskResponse.Builder |
windowTaskId(String windowTaskId)
The retrieved maintenance window task ID.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetMaintenanceWindowTaskResponse.Builder windowId(String windowId)
The retrieved maintenance window ID.
windowId
- The retrieved maintenance window ID.GetMaintenanceWindowTaskResponse.Builder windowTaskId(String windowTaskId)
The retrieved maintenance window task ID.
windowTaskId
- The retrieved maintenance window task ID.GetMaintenanceWindowTaskResponse.Builder targets(Collection<Target> targets)
The targets where the task should run.
targets
- The targets where the task should run.GetMaintenanceWindowTaskResponse.Builder targets(Target... targets)
The targets where the task should run.
targets
- The targets where the task should run.GetMaintenanceWindowTaskResponse.Builder targets(Consumer<Target.Builder>... targets)
The targets where the task should run.
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)
GetMaintenanceWindowTaskResponse.Builder taskArn(String taskArn)
The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
taskArn
- The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the
TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function
name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.GetMaintenanceWindowTaskResponse.Builder serviceRoleArn(String serviceRoleArn)
The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
serviceRoleArn
- The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS)
notifications for maintenance window Run Command tasks.GetMaintenanceWindowTaskResponse.Builder taskType(String taskType)
The type of task to run.
taskType
- The type of task to run.MaintenanceWindowTaskType
,
MaintenanceWindowTaskType
GetMaintenanceWindowTaskResponse.Builder taskType(MaintenanceWindowTaskType taskType)
The type of task to run.
taskType
- The type of task to run.MaintenanceWindowTaskType
,
MaintenanceWindowTaskType
GetMaintenanceWindowTaskResponse.Builder taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters to pass to the task when it runs.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs,
instead use the Parameters
option in the TaskInvocationParameters
structure. For
information about how Systems Manager handles these options for the supported maintenance window task types,
see MaintenanceWindowTaskInvocationParameters.
taskParameters
- The parameters to pass to the task when it runs.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs,
instead use the Parameters
option in the TaskInvocationParameters
structure.
For information about how Systems Manager handles these options for the supported maintenance window
task types, see MaintenanceWindowTaskInvocationParameters.
GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
The parameters to pass to the task when it runs.
taskInvocationParameters
- The parameters to pass to the task when it runs.default GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)
The parameters to pass to the task when it runs.
This is a convenience that creates an instance of theMaintenanceWindowTaskInvocationParameters.Builder
avoiding the need to create one manually via
MaintenanceWindowTaskInvocationParameters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is
called immediately and its result is passed to
taskInvocationParameters(MaintenanceWindowTaskInvocationParameters)
.taskInvocationParameters
- a consumer that will call methods on MaintenanceWindowTaskInvocationParameters.Builder
taskInvocationParameters(MaintenanceWindowTaskInvocationParameters)
GetMaintenanceWindowTaskResponse.Builder priority(Integer priority)
The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
priority
- The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have
the same priority are scheduled in parallel.GetMaintenanceWindowTaskResponse.Builder maxConcurrency(String maxConcurrency)
The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead,
the system inserts a placeholder value of 1
, which may be reported in the response to this
command. This value does not affect the running of your task and can be ignored.
maxConcurrency
- The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option.
Instead, the system inserts a placeholder value of 1
, which may be reported in the
response to this command. This value does not affect the running of your task and can be ignored.
GetMaintenanceWindowTaskResponse.Builder maxErrors(String maxErrors)
The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead,
the system inserts a placeholder value of 1
, which may be reported in the response to this
command. This value does not affect the running of your task and can be ignored.
maxErrors
- The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you cannot supply a value for this option.
Instead, the system inserts a placeholder value of 1
, which may be reported in the
response to this command. This value does not affect the running of your task and can be ignored.
GetMaintenanceWindowTaskResponse.Builder loggingInfo(LoggingInfo loggingInfo)
The location in Amazon S3 where the task results are logged.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Systems Manager handles these
options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
loggingInfo
- The location in Amazon S3 where the task results are logged.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Systems Manager handles
these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
default GetMaintenanceWindowTaskResponse.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
The location in Amazon S3 where the task results are logged.
LoggingInfo
has been deprecated. To specify an S3 bucket to contain logs, instead use the
OutputS3BucketName
and OutputS3KeyPrefix
options in the
TaskInvocationParameters
structure. For information about how Systems Manager handles these
options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
LoggingInfo.Builder
avoiding the need
to create one manually via LoggingInfo.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to loggingInfo(LoggingInfo)
.loggingInfo
- a consumer that will call methods on LoggingInfo.Builder
loggingInfo(LoggingInfo)
GetMaintenanceWindowTaskResponse.Builder name(String name)
The retrieved task name.
name
- The retrieved task name.GetMaintenanceWindowTaskResponse.Builder description(String description)
The retrieved task description.
description
- The retrieved task description.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.