@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegisterTaskWithMaintenanceWindowRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
RegisterTaskWithMaintenanceWindowRequest() |
| Modifier and Type | Method and Description |
|---|---|
RegisterTaskWithMaintenanceWindowRequest |
addTaskParametersEntry(String key,
MaintenanceWindowTaskParameterValueExpression value)
Add a single TaskParameters entry
|
RegisterTaskWithMaintenanceWindowRequest |
clearTaskParametersEntries()
Removes all the entries added into TaskParameters.
|
RegisterTaskWithMaintenanceWindowRequest |
clone() |
boolean |
equals(Object obj) |
String |
getClientToken()
User-provided idempotency token.
|
String |
getDescription()
An optional description for the task.
|
LoggingInfo |
getLoggingInfo()
A structure containing information about an S3 bucket to write instance-level logs to.
|
String |
getMaxConcurrency()
The maximum number of targets this task can be run for in parallel.
|
String |
getMaxErrors()
The maximum number of errors allowed before this task stops being scheduled.
|
String |
getName()
An optional name for the task.
|
Integer |
getPriority()
The priority of the task in the maintenance window, the lower the number the higher the priority.
|
String |
getServiceRoleArn()
The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.
|
List<Target> |
getTargets()
The targets (either instances or maintenance window targets).
|
String |
getTaskArn()
The ARN of the task to run.
|
MaintenanceWindowTaskInvocationParameters |
getTaskInvocationParameters()
The parameters that the task should use during execution.
|
Map<String,MaintenanceWindowTaskParameterValueExpression> |
getTaskParameters()
The parameters that should be passed to the task when it is run.
|
String |
getTaskType()
The type of task being registered.
|
String |
getWindowId()
The ID of the maintenance window the task should be added to.
|
int |
hashCode() |
void |
setClientToken(String clientToken)
User-provided idempotency token.
|
void |
setDescription(String description)
An optional description for the task.
|
void |
setLoggingInfo(LoggingInfo loggingInfo)
A structure containing information about an S3 bucket to write instance-level logs to.
|
void |
setMaxConcurrency(String maxConcurrency)
The maximum number of targets this task can be run for in parallel.
|
void |
setMaxErrors(String maxErrors)
The maximum number of errors allowed before this task stops being scheduled.
|
void |
setName(String name)
An optional name for the task.
|
void |
setPriority(Integer priority)
The priority of the task in the maintenance window, the lower the number the higher the priority.
|
void |
setServiceRoleArn(String serviceRoleArn)
The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.
|
void |
setTargets(Collection<Target> targets)
The targets (either instances or maintenance window targets).
|
void |
setTaskArn(String taskArn)
The ARN of the task to run.
|
void |
setTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
The parameters that the task should use during execution.
|
void |
setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters that should be passed to the task when it is run.
|
void |
setTaskType(MaintenanceWindowTaskType taskType)
The type of task being registered.
|
void |
setTaskType(String taskType)
The type of task being registered.
|
void |
setWindowId(String windowId)
The ID of the maintenance window the task should be added to.
|
String |
toString()
Returns a string representation of this object.
|
RegisterTaskWithMaintenanceWindowRequest |
withClientToken(String clientToken)
User-provided idempotency token.
|
RegisterTaskWithMaintenanceWindowRequest |
withDescription(String description)
An optional description for the task.
|
RegisterTaskWithMaintenanceWindowRequest |
withLoggingInfo(LoggingInfo loggingInfo)
A structure containing information about an S3 bucket to write instance-level logs to.
|
RegisterTaskWithMaintenanceWindowRequest |
withMaxConcurrency(String maxConcurrency)
The maximum number of targets this task can be run for in parallel.
|
RegisterTaskWithMaintenanceWindowRequest |
withMaxErrors(String maxErrors)
The maximum number of errors allowed before this task stops being scheduled.
|
RegisterTaskWithMaintenanceWindowRequest |
withName(String name)
An optional name for the task.
|
RegisterTaskWithMaintenanceWindowRequest |
withPriority(Integer priority)
The priority of the task in the maintenance window, the lower the number the higher the priority.
|
RegisterTaskWithMaintenanceWindowRequest |
withServiceRoleArn(String serviceRoleArn)
The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task.
|
RegisterTaskWithMaintenanceWindowRequest |
withTargets(Collection<Target> targets)
The targets (either instances or maintenance window targets).
|
RegisterTaskWithMaintenanceWindowRequest |
withTargets(Target... targets)
The targets (either instances or maintenance window targets).
|
RegisterTaskWithMaintenanceWindowRequest |
withTaskArn(String taskArn)
The ARN of the task to run.
|
RegisterTaskWithMaintenanceWindowRequest |
withTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
The parameters that the task should use during execution.
|
RegisterTaskWithMaintenanceWindowRequest |
withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)
The parameters that should be passed to the task when it is run.
|
RegisterTaskWithMaintenanceWindowRequest |
withTaskType(MaintenanceWindowTaskType taskType)
The type of task being registered.
|
RegisterTaskWithMaintenanceWindowRequest |
withTaskType(String taskType)
The type of task being registered.
|
RegisterTaskWithMaintenanceWindowRequest |
withWindowId(String windowId)
The ID of the maintenance window the task should be added to.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic RegisterTaskWithMaintenanceWindowRequest()
public void setWindowId(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.public String getWindowId()
The ID of the maintenance window the task should be added to.
public RegisterTaskWithMaintenanceWindowRequest withWindowId(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.public List<Target> getTargets()
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>
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>
public void setTargets(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>
public RegisterTaskWithMaintenanceWindowRequest withTargets(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>
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override
the existing values.
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>
public RegisterTaskWithMaintenanceWindowRequest withTargets(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>
public void setTaskArn(String taskArn)
The ARN of the task to run.
taskArn - The ARN of the task to run.public String getTaskArn()
The ARN of the task to run.
public RegisterTaskWithMaintenanceWindowRequest withTaskArn(String taskArn)
The ARN of the task to run.
taskArn - The ARN of the task to run.public void setServiceRoleArn(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:
public String getServiceRoleArn()
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:
RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the AWS Systems Manager User Guide:
public RegisterTaskWithMaintenanceWindowRequest withServiceRoleArn(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:
public void setTaskType(String taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskTypepublic String getTaskType()
The type of task being registered.
MaintenanceWindowTaskTypepublic RegisterTaskWithMaintenanceWindowRequest withTaskType(String taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskTypepublic void setTaskType(MaintenanceWindowTaskType taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskTypepublic RegisterTaskWithMaintenanceWindowRequest withTaskType(MaintenanceWindowTaskType taskType)
The type of task being registered.
taskType - The type of task being registered.MaintenanceWindowTaskTypepublic Map<String,MaintenanceWindowTaskParameterValueExpression> getTaskParameters()
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 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 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.
public void setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> 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 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 run.
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.
public RegisterTaskWithMaintenanceWindowRequest withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> 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 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 run.
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.
public RegisterTaskWithMaintenanceWindowRequest addTaskParametersEntry(String key, MaintenanceWindowTaskParameterValueExpression value)
public RegisterTaskWithMaintenanceWindowRequest clearTaskParametersEntries()
public void setTaskInvocationParameters(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.public MaintenanceWindowTaskInvocationParameters getTaskInvocationParameters()
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 RegisterTaskWithMaintenanceWindowRequest withTaskInvocationParameters(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.public void setPriority(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.public Integer getPriority()
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 RegisterTaskWithMaintenanceWindowRequest withPriority(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.public void setMaxConcurrency(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.public String getMaxConcurrency()
The maximum number of targets this task can be run for in parallel.
public RegisterTaskWithMaintenanceWindowRequest withMaxConcurrency(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.public void setMaxErrors(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.public String getMaxErrors()
The maximum number of errors allowed before this task stops being scheduled.
public RegisterTaskWithMaintenanceWindowRequest withMaxErrors(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.public void setLoggingInfo(LoggingInfo loggingInfo)
A structure containing information about an 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 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.
public LoggingInfo getLoggingInfo()
A structure containing information about an 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 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.
public RegisterTaskWithMaintenanceWindowRequest withLoggingInfo(LoggingInfo loggingInfo)
A structure containing information about an 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 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.
public void setName(String name)
An optional name for the task.
name - An optional name for the task.public String getName()
An optional name for the task.
public RegisterTaskWithMaintenanceWindowRequest withName(String name)
An optional name for the task.
name - An optional name for the task.public void setDescription(String description)
An optional description for the task.
description - An optional description for the task.public String getDescription()
An optional description for the task.
public RegisterTaskWithMaintenanceWindowRequest withDescription(String description)
An optional description for the task.
description - An optional description for the task.public void setClientToken(String clientToken)
User-provided idempotency token.
clientToken - User-provided idempotency token.public String getClientToken()
User-provided idempotency token.
public RegisterTaskWithMaintenanceWindowRequest withClientToken(String clientToken)
User-provided idempotency token.
clientToken - User-provided idempotency token.public String toString()
toString in class ObjectObject.toString()public RegisterTaskWithMaintenanceWindowRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2020. All rights reserved.