software.amazon.awssdk.services.ssm.model

Class RegisterTaskWithMaintenanceWindowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.RegisterTaskWithMaintenanceWindowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterTaskWithMaintenanceWindowRequest
extends SsmRequest
implements ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterTaskWithMaintenanceWindowRequest.Builder

Method Summary

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.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn() The role to assume when running the Maintenance Window task.
List<Target>	targets() The targets (either instances or Maintenance Window targets).
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

windowId

public String 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.

targets

public List<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>

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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>

taskArn

public String taskArn()

The ARN of the task to execute

Returns:

The ARN of the task to execute

serviceRoleArn

public 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.

Returns:

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.

taskType

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().

Returns:

The type of task being registered.

See Also:

MaintenanceWindowTaskType

taskTypeAsString

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().

Returns:

The type of task being registered.

See Also:

MaintenanceWindowTaskType

taskParameters

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

taskInvocationParameters

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.

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

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.

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

public String maxConcurrency()

The maximum number of targets this task can be run for in parallel.

Returns:

The maximum number of targets this task can be run for in parallel.

maxErrors

public String maxErrors()

The maximum number of errors allowed before this task stops being scheduled.

Returns:

The maximum number of errors allowed before this task stops being scheduled.

loggingInfo

public 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.

Returns:

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.

name

public String name()

An optional name for the task.

Returns:

An optional name for the task.

description

public String description()

An optional description for the task.

Returns:

An optional description for the task.

clientToken

public String clientToken()

User-provided idempotency token.

Returns:

User-provided idempotency token.

toBuilder

public RegisterTaskWithMaintenanceWindowRequest.Builder 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 interface ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static RegisterTaskWithMaintenanceWindowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.