Interface GetMaintenanceWindowTaskResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,
,GetMaintenanceWindowTaskResponse> SdkBuilder<GetMaintenanceWindowTaskResponse.Builder,
,GetMaintenanceWindowTaskResponse> SdkPojo
,SdkResponse.Builder
,SsmResponse.Builder
- Enclosing class:
GetMaintenanceWindowTaskResponse
-
Method Summary
Modifier and TypeMethodDescriptionalarmConfiguration
(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The details for the CloudWatch alarm you applied to your maintenance window task.alarmConfiguration
(AlarmConfiguration alarmConfiguration) The details for the CloudWatch alarm you applied to your maintenance window task.cutoffBehavior
(String cutoffBehavior) The action to take on tasks when the maintenance window cutoff time is reached.cutoffBehavior
(MaintenanceWindowTaskCutoffBehavior cutoffBehavior) The action to take on tasks when the maintenance window cutoff time is reached.description
(String description) The retrieved task description.loggingInfo
(Consumer<LoggingInfo.Builder> loggingInfo) The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.loggingInfo
(LoggingInfo loggingInfo) The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.maxConcurrency
(String maxConcurrency) The maximum number of targets allowed to run this task in parallel.The maximum number of errors allowed before the task stops being scheduled.The retrieved task name.The priority of the task when it runs.serviceRoleArn
(String serviceRoleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.targets
(Collection<Target> targets) The targets where the task should run.targets
(Consumer<Target.Builder>... targets) The targets where the task should run.The targets where the task should run.The resource that the task used during execution.taskInvocationParameters
(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters) The parameters to pass to the task when it runs.taskInvocationParameters
(MaintenanceWindowTaskInvocationParameters taskInvocationParameters) The parameters to pass to the task when it runs.taskParameters
(Map<String, MaintenanceWindowTaskParameterValueExpression> taskParameters) The parameters to pass to the task when it runs.The type of task to run.taskType
(MaintenanceWindowTaskType taskType) The type of task to run.The retrieved maintenance window ID.windowTaskId
(String windowTaskId) The retrieved maintenance window task ID.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
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmResponse.Builder
build, responseMetadata, responseMetadata
-
Method Details
-
windowId
The retrieved maintenance window ID.
- Parameters:
windowId
- The retrieved maintenance window ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
windowTaskId
The retrieved maintenance window task ID.
- Parameters:
windowTaskId
- The retrieved maintenance window task ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets where the task should run.
- Parameters:
targets
- The targets where the task should run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets where the task should run.
- Parameters:
targets
- The targets where the task should run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targets
The targets where the task should run.
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:
-
taskArn
The resource that the task used during execution. For
RUN_COMMAND
andAUTOMATION
task types, the value ofTaskArn
is the SSM document name/ARN. ForLAMBDA
tasks, the value is the function name/ARN. ForSTEP_FUNCTIONS
tasks, the value is the state machine ARN.- Parameters:
taskArn
- The resource that the task used during execution. ForRUN_COMMAND
andAUTOMATION
task types, the value ofTaskArn
is the SSM document name/ARN. ForLAMBDA
tasks, the value is the function name/ARN. ForSTEP_FUNCTIONS
tasks, the value is the state machine ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
- Parameters:
serviceRoleArn
- The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskType
The type of task to run.
- Parameters:
taskType
- The type of task to run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskType
The type of task to run.
- Parameters:
taskType
- The type of task to run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskParameters
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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.- Parameters:
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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskInvocationParameters
GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters) The parameters to pass to the task when it runs.
- Parameters:
taskInvocationParameters
- The parameters to pass to the task when it runs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskInvocationParameters
default GetMaintenanceWindowTaskResponse.Builder taskInvocationParameters(Consumer<MaintenanceWindowTaskInvocationParameters.Builder> taskInvocationParameters) The parameters to pass to the task when it runs.
This is a convenience method that creates an instance of theMaintenanceWindowTaskInvocationParameters.Builder
avoiding the need to create one manually viaMaintenanceWindowTaskInvocationParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaskInvocationParameters(MaintenanceWindowTaskInvocationParameters)
.- Parameters:
taskInvocationParameters
- a consumer that will call methods onMaintenanceWindowTaskInvocationParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxConcurrency
The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't 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 doesn't affect the running of your task and can be ignored.- Parameters:
maxConcurrency
- The maximum number of targets allowed to run this task in parallel.For maintenance window tasks without a target specified, you can't 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 doesn't affect the running of your task and can be ignored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxErrors
The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't 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 doesn't affect the running of your task and can be ignored.- Parameters:
maxErrors
- The maximum number of errors allowed before the task stops being scheduled.For maintenance window tasks without a target specified, you can't 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 doesn't affect the running of your task and can be ignored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loggingInfo
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.- Parameters:
loggingInfo
- The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loggingInfo
default GetMaintenanceWindowTaskResponse.Builder loggingInfo(Consumer<LoggingInfo.Builder> loggingInfo) The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.LoggingInfo.Builder
avoiding the need to create one manually viaLoggingInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologgingInfo(LoggingInfo)
.- Parameters:
loggingInfo
- a consumer that will call methods onLoggingInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The retrieved task name.
- Parameters:
name
- The retrieved task name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The retrieved task description.
- Parameters:
description
- The retrieved task description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cutoffBehavior
The action to take on tasks when the maintenance window cutoff time is reached.
CONTINUE_TASK
means that tasks continue to run. For Automation, Lambda, Step Functions tasks,CANCEL_TASK
means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks,CANCEL_TASK
means the system attempts to stop the task by sending aCancelCommand
operation.- Parameters:
cutoffBehavior
- The action to take on tasks when the maintenance window cutoff time is reached.CONTINUE_TASK
means that tasks continue to run. For Automation, Lambda, Step Functions tasks,CANCEL_TASK
means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks,CANCEL_TASK
means the system attempts to stop the task by sending aCancelCommand
operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cutoffBehavior
GetMaintenanceWindowTaskResponse.Builder cutoffBehavior(MaintenanceWindowTaskCutoffBehavior cutoffBehavior) The action to take on tasks when the maintenance window cutoff time is reached.
CONTINUE_TASK
means that tasks continue to run. For Automation, Lambda, Step Functions tasks,CANCEL_TASK
means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks,CANCEL_TASK
means the system attempts to stop the task by sending aCancelCommand
operation.- Parameters:
cutoffBehavior
- The action to take on tasks when the maintenance window cutoff time is reached.CONTINUE_TASK
means that tasks continue to run. For Automation, Lambda, Step Functions tasks,CANCEL_TASK
means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks,CANCEL_TASK
means the system attempts to stop the task by sending aCancelCommand
operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.
- Parameters:
alarmConfiguration
- The details for the CloudWatch alarm you applied to your maintenance window task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmConfiguration
default GetMaintenanceWindowTaskResponse.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The details for the CloudWatch alarm you applied to your maintenance window task.
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:
-