public static interface UpdateMaintenanceWindowTaskRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateMaintenanceWindowTaskRequest.Builder,UpdateMaintenanceWindowTaskRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateMaintenanceWindowTaskRequest.Builder windowId(String windowId)
The maintenance window ID that contains the task to modify.
windowId - The maintenance window ID that contains the task to modify.UpdateMaintenanceWindowTaskRequest.Builder windowTaskId(String windowTaskId)
The task ID to modify.
windowTaskId - The task ID to modify.UpdateMaintenanceWindowTaskRequest.Builder targets(Collection<Target> targets)
The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
targets - The targets (either instances or tags) to modify. Instances are specified using
Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using
Key=tag_name,Values=tag_value. One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
UpdateMaintenanceWindowTaskRequest.Builder targets(Target... targets)
The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
targets - The targets (either instances or tags) to modify. Instances are specified using
Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using
Key=tag_name,Values=tag_value. One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
UpdateMaintenanceWindowTaskRequest.Builder targets(Consumer<Target.Builder>... targets)
The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS Systems Manager User Guide.
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 #targets(List) .targets - a consumer that will call methods on List.Builder #targets(List) UpdateMaintenanceWindowTaskRequest.Builder taskArn(String taskArn)
The task ARN to modify.
taskArn - The task ARN to modify.UpdateMaintenanceWindowTaskRequest.Builder serviceRoleArn(String serviceRoleArn)
The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you
do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no
service-linked role for Systems Manager exists in your account, it is created when you run
RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the AWS Systems Manager User Guide:
serviceRoleArn - The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.
If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If
no service-linked role for Systems Manager exists in your account, it is created when you run
RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the AWS Systems Manager User Guide:
UpdateMaintenanceWindowTaskRequest.Builder taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters to modify.
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.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
taskParameters - The parameters to modify.
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.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
UpdateMaintenanceWindowTaskRequest.Builder taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters values that you want to retain. The
values you do not specify again are removed. For example, suppose that when you registered a Run Command
task, you specified TaskInvocationParameters values for Comment,
NotificationConfig, and OutputS3BucketName. If you update the maintenance window
task and specify only a different OutputS3BucketName value, the values for Comment
and NotificationConfig are removed.
taskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task
type. All other fields should be empty.
When you update a maintenance window task that has options specified in
TaskInvocationParameters, you must provide again all the
TaskInvocationParameters values that you want to retain. The values you do not specify
again are removed. For example, suppose that when you registered a Run Command task, you specified
TaskInvocationParameters values for Comment, NotificationConfig
, and OutputS3BucketName. If you update the maintenance window task and specify only a
different OutputS3BucketName value, the values for Comment and
NotificationConfig are removed.
default UpdateMaintenanceWindowTaskRequest.Builder taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters)
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters values that you want to retain. The
values you do not specify again are removed. For example, suppose that when you registered a Run Command
task, you specified TaskInvocationParameters values for Comment,
NotificationConfig, and OutputS3BucketName. If you update the maintenance window
task and specify only a different OutputS3BucketName value, the values for Comment
and NotificationConfig are removed.
MaintenanceWindowTaskInvocationParameters.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.BuildertaskInvocationParameters(MaintenanceWindowTaskInvocationParameters)UpdateMaintenanceWindowTaskRequest.Builder priority(Integer priority)
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
priority - The new task priority to specify. The lower the number, the higher the priority. Tasks that have the
same priority are scheduled in parallel.UpdateMaintenanceWindowTaskRequest.Builder maxConcurrency(String maxConcurrency)
The new MaxConcurrency value you want to specify. MaxConcurrency is the number of
targets that are 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 new MaxConcurrency value you want to specify. MaxConcurrency is the
number of targets that are 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.
UpdateMaintenanceWindowTaskRequest.Builder maxErrors(String maxErrors)
The new MaxErrors value to specify. MaxErrors is the maximum number of errors that
are 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 new MaxErrors value to specify. MaxErrors is the maximum number of
errors that are 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.
UpdateMaintenanceWindowTaskRequest.Builder loggingInfo(LoggingInfo loggingInfo)
The new logging location in Amazon S3 to specify.
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 new logging location in Amazon S3 to specify.
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 UpdateMaintenanceWindowTaskRequest.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
The new logging location in Amazon S3 to specify.
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.BuilderloggingInfo(LoggingInfo)UpdateMaintenanceWindowTaskRequest.Builder name(String name)
The new task name to specify.
name - The new task name to specify.UpdateMaintenanceWindowTaskRequest.Builder description(String description)
The new task description to specify.
description - The new task description to specify.UpdateMaintenanceWindowTaskRequest.Builder replace(Boolean replace)
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.
replace - If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow action are also
required for this API request. Optional fields that are not specified are set to null.UpdateMaintenanceWindowTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateMaintenanceWindowTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.