public static interface RegisterTaskWithMaintenanceWindowRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
buildoverrideConfigurationcopyapplyMutation, buildRegisterTaskWithMaintenanceWindowRequest.Builder windowId(String windowId)
The ID of the Maintenance Window the task should be added to.
windowId - The ID of the Maintenance Window the task should be added to.RegisterTaskWithMaintenanceWindowRequest.Builder targets(Collection<Target> targets)
The targets (either instances or Maintenance Window targets).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify Maintenance Window targets using the following format:
Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>
targets - The targets (either instances or Maintenance Window targets).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify Maintenance Window targets using the following format:
Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>
RegisterTaskWithMaintenanceWindowRequest.Builder targets(Target... targets)
The targets (either instances or Maintenance Window targets).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify Maintenance Window targets using the following format:
Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>
targets - The targets (either instances or Maintenance Window targets).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify Maintenance Window targets using the following format:
Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>
RegisterTaskWithMaintenanceWindowRequest.Builder targets(Consumer<Target.Builder>... targets)
The targets (either instances or Maintenance Window targets).
Specify instances using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify Maintenance Window targets using the following format:
Key=<WindowTargetIds>,Values=<window-target-id-1>,<window-target-id-2>
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) RegisterTaskWithMaintenanceWindowRequest.Builder taskArn(String taskArn)
The ARN of the task to execute
taskArn - The ARN of the task to executeRegisterTaskWithMaintenanceWindowRequest.Builder serviceRoleArn(String serviceRoleArn)
The role to assume when running the Maintenance Window task.
If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for
Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be
created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.
For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
serviceRoleArn - The role to assume when running the Maintenance Window task.
If you do not specify a service role ARN, Systems Manager will use your account's service-linked role
for Systems Manager by default. If no service-linked role for Systems Manager exists in your account,
it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a
service role ARN.
For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.
RegisterTaskWithMaintenanceWindowRequest.Builder taskType(String taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskType,
MaintenanceWindowTaskTypeRegisterTaskWithMaintenanceWindowRequest.Builder taskType(MaintenanceWindowTaskType taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskType,
MaintenanceWindowTaskTypeRegisterTaskWithMaintenanceWindowRequest.Builder taskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters that should be passed to the task when it is executed.
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 that should be passed to the task when it is executed.
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.
RegisterTaskWithMaintenanceWindowRequest.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.
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.default RegisterTaskWithMaintenanceWindowRequest.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.
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.BuildertaskInvocationParameters(MaintenanceWindowTaskInvocationParameters)RegisterTaskWithMaintenanceWindowRequest.Builder priority(Integer priority)
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
priority - The priority of the task in the Maintenance Window, the lower the number the higher the priority.
Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority
scheduled in parallel.RegisterTaskWithMaintenanceWindowRequest.Builder maxConcurrency(String maxConcurrency)
The maximum number of targets this task can be run for in parallel.
maxConcurrency - The maximum number of targets this task can be run for in parallel.RegisterTaskWithMaintenanceWindowRequest.Builder maxErrors(String maxErrors)
The maximum number of errors allowed before this task stops being scheduled.
maxErrors - The maximum number of errors allowed before this task stops being scheduled.RegisterTaskWithMaintenanceWindowRequest.Builder loggingInfo(LoggingInfo loggingInfo)
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
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 - A structure containing information about an Amazon S3 bucket to write instance-level logs to.
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 RegisterTaskWithMaintenanceWindowRequest.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo)
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
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)RegisterTaskWithMaintenanceWindowRequest.Builder name(String name)
An optional name for the task.
name - An optional name for the task.RegisterTaskWithMaintenanceWindowRequest.Builder description(String description)
An optional description for the task.
description - An optional description for the task.RegisterTaskWithMaintenanceWindowRequest.Builder clientToken(String clientToken)
User-provided idempotency token.
clientToken - User-provided idempotency token.RegisterTaskWithMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.RegisterTaskWithMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.