Class RegisterTaskWithMaintenanceWindowRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,
RegisterTaskWithMaintenanceWindowRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal AlarmConfiguration
The CloudWatch alarm you want to apply to your maintenance window task.builder()
final String
User-provided idempotency token.Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.final String
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.final String
An optional description for the task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Targets property.final boolean
For responses, this returns true if the service returned a value for the TaskParameters property.final LoggingInfo
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.final String
The maximum number of targets this task can be run for, in parallel.final String
The maximum number of errors allowed before this task stops being scheduled.final String
name()
An optional name for the task.final Integer
priority()
The priority of the task in the maintenance window, the lower the number the higher the priority.static Class
<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> final String
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task.targets()
The targets (either managed nodes or maintenance window targets).final String
taskArn()
The ARN of the task to run.The parameters that the task should use during execution.The parameters that should be passed to the task when it is run.taskType()
The type of task being registered.final String
The type of task being registered.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
windowId()
The ID of the maintenance window the task should be added to.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
windowId
The ID of the maintenance window the task should be added to.
- Returns:
- The ID of the maintenance window the task should be added to.
-
hasTargets
public final boolean hasTargets()For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
targets
The targets (either managed nodes or maintenance window targets).
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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Specify managed nodes 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>
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTargets()
method.- Returns:
- The targets (either managed nodes or maintenance window targets).
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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Specify managed nodes 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>
-
taskArn
The ARN of the task to run.
- Returns:
- The ARN of the task to run.
-
serviceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Using service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
- Returns:
- The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services 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 Using service-linked roles for Systems Manager in the in the Amazon Web Services Systems Manager User Guide:
-
taskType
The type of task being registered.
If the service returns an enum value that is not available in the current SDK version,
taskType
will returnMaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The type of task being registered.
- See Also:
-
taskTypeAsString
The type of task being registered.
If the service returns an enum value that is not available in the current SDK version,
taskType
will returnMaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The type of task being registered.
- See Also:
-
hasTaskParameters
public final boolean hasTaskParameters()For responses, this returns true if the service returned a value for the TaskParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
taskParameters
The parameters that should be passed to the task when it is run.
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTaskParameters()
method.- Returns:
- The parameters that should be passed to the task when it is run.
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.
-
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.
- Returns:
- The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
-
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.
- Returns:
- 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.
-
maxConcurrency
The maximum number of targets this task can be run for, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.- Returns:
- The maximum number of targets this task can be run for, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.
-
maxErrors
The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.- Returns:
- The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.
-
loggingInfo
A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
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:
- A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write
managed node-level logs to.
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.
-
name
An optional name for the task.
- Returns:
- An optional name for the task.
-
description
An optional description for the task.
- Returns:
- An optional description for the task.
-
clientToken
User-provided idempotency token.
- Returns:
- User-provided idempotency token.
-
cutoffBehavior
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
-
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is
TIMED_OUT
. -
If the service returns an enum value that is not available in the current SDK version,
cutoffBehavior
will returnMaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcutoffBehaviorAsString()
.- Returns:
- Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows
is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
-
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is
TIMED_OUT
. -
-
- See Also:
-
-
cutoffBehaviorAsString
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
-
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is
TIMED_OUT
. -
If the service returns an enum value that is not available in the current SDK version,
cutoffBehavior
will returnMaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcutoffBehaviorAsString()
.- Returns:
- Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows
is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
-
For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is
TIMED_OUT
. -
-
- See Also:
-
-
alarmConfiguration
The CloudWatch alarm you want to apply to your maintenance window task.
- Returns:
- The CloudWatch alarm you want to apply to your maintenance window task.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,
RegisterTaskWithMaintenanceWindowRequest> - Specified by:
toBuilder
in classSsmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-