Package software.amazon.awssdk.services.ssm.model

Class UpdateMaintenanceWindowTaskResponse

    • Method Detail

      • windowId

        public final String windowId()

        The ID of the maintenance window that was updated.

        Returns:
        The ID of the maintenance window that was updated.

      • windowTaskId

        public final String windowTaskId()

        The task ID of the maintenance window that was updated.

        Returns:
        The task ID of the maintenance window that was updated.

      • 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 the isEmpty() 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

        public final List<Target> targets()

        The updated target values.

        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 updated target values.

      • taskArn

        public final String taskArn()

        The updated task ARN value.

        Returns:
        The updated task ARN value.

      • serviceRoleArn

        public final String 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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

        However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows 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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

        However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

      • 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 the isEmpty() 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

        public final Map<String,​MaintenanceWindowTaskParameterValueExpression> taskParameters()

        The updated parameter values.

        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.

        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 updated parameter values.

        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.

      • priority

        public final Integer priority()

        The updated priority value.

        Returns:
        The updated priority value.

      • maxConcurrency

        public final String maxConcurrency()

        The updated MaxConcurrency value.

        Returns:
        The updated MaxConcurrency value.

      • maxErrors

        public final String maxErrors()

        The updated MaxErrors value.

        Returns:
        The updated MaxErrors value.

      • loggingInfo

        public final LoggingInfo loggingInfo()

        The updated logging information in Amazon S3.

        LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

        Returns:
        The updated logging information in Amazon S3.

        LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

      • name

        public final String name()

        The updated task name.

        Returns:
        The updated task name.

      • description

        public final String description()

        The updated task description.

        Returns:
        The updated task description.

      • cutoffBehaviorAsString

        public final String cutoffBehaviorAsString()

        The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

        If the service returns an enum value that is not available in the current SDK version, cutoffBehavior will return MaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cutoffBehaviorAsString().

        Returns:
        The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
        See Also:
        MaintenanceWindowTaskCutoffBehavior

      • alarmConfiguration

        public final AlarmConfiguration alarmConfiguration()

        The details for the CloudWatch alarm you applied to your maintenance window task.

        Returns:
        The details for the CloudWatch alarm you applied to your maintenance window task.

      • toString

        public final String 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.
        Overrides:
        toString in class Object