@Generated(value="software.amazon.awssdk:codegen") public final class RegisterTaskWithMaintenanceWindowRequest extends SsmRequest implements ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RegisterTaskWithMaintenanceWindowRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static RegisterTaskWithMaintenanceWindowRequest.Builder |
builder() |
String |
clientToken()
User-provided idempotency token.
|
String |
description()
An optional description for the task.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
LoggingInfo |
loggingInfo()
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
|
String |
maxConcurrency()
The maximum number of targets this task can be run for in parallel.
|
String |
maxErrors()
The maximum number of errors allowed before this task stops being scheduled.
|
String |
name()
An optional name for the task.
|
Integer |
priority()
The priority of the task in the Maintenance Window, the lower the number the higher the priority.
|
static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> |
serializableBuilderClass() |
String |
serviceRoleArn()
The role that should be assumed when executing the task.
|
List<Target> |
targets()
The targets (either instances or tags).
|
String |
taskArn()
The ARN of the task to execute
|
MaintenanceWindowTaskInvocationParameters |
taskInvocationParameters()
The parameters that the task should use during execution.
|
Map<String,MaintenanceWindowTaskParameterValueExpression> |
taskParameters()
The parameters that should be passed to the task when it is executed.
|
MaintenanceWindowTaskType |
taskType()
The type of task being registered.
|
String |
taskTypeAsString()
The type of task being registered.
|
RegisterTaskWithMaintenanceWindowRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
windowId()
The id of the Maintenance Window the task should be added to.
|
overrideConfiguration
copy
public String windowId()
The id of the Maintenance Window the task should be added to.
public List<Target> targets()
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String taskArn()
The ARN of the task to execute
public String serviceRoleArn()
The role that should be assumed when executing the task.
public MaintenanceWindowTaskType 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
return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from taskTypeAsString()
.
MaintenanceWindowTaskType
public String 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
return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from taskTypeAsString()
.
MaintenanceWindowTaskType
public Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()
The parameters that should be passed to the task when it is executed.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
public 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.
public String maxConcurrency()
The maximum number of targets this task can be run for in parallel.
public String maxErrors()
The maximum number of errors allowed before this task stops being scheduled.
public LoggingInfo loggingInfo()
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
public String name()
An optional name for the task.
public String description()
An optional description for the task.
public String clientToken()
User-provided idempotency token.
public RegisterTaskWithMaintenanceWindowRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
toBuilder
in class SsmRequest
public static RegisterTaskWithMaintenanceWindowRequest.Builder builder()
public static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.