Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MaintenanceWindowTask = MaintenanceWindowTask' {
- alarmConfiguration :: Maybe AlarmConfiguration
- cutoffBehavior :: Maybe MaintenanceWindowTaskCutoffBehavior
- description :: Maybe (Sensitive Text)
- loggingInfo :: Maybe LoggingInfo
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- name :: Maybe Text
- priority :: Maybe Natural
- serviceRoleArn :: Maybe Text
- targets :: Maybe [Target]
- taskArn :: Maybe Text
- taskParameters :: Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))
- type' :: Maybe MaintenanceWindowTaskType
- windowId :: Maybe Text
- windowTaskId :: Maybe Text
- newMaintenanceWindowTask :: MaintenanceWindowTask
- maintenanceWindowTask_alarmConfiguration :: Lens' MaintenanceWindowTask (Maybe AlarmConfiguration)
- maintenanceWindowTask_cutoffBehavior :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskCutoffBehavior)
- maintenanceWindowTask_description :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_loggingInfo :: Lens' MaintenanceWindowTask (Maybe LoggingInfo)
- maintenanceWindowTask_maxConcurrency :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_maxErrors :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_name :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_priority :: Lens' MaintenanceWindowTask (Maybe Natural)
- maintenanceWindowTask_serviceRoleArn :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_targets :: Lens' MaintenanceWindowTask (Maybe [Target])
- maintenanceWindowTask_taskArn :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_taskParameters :: Lens' MaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- maintenanceWindowTask_type :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskType)
- maintenanceWindowTask_windowId :: Lens' MaintenanceWindowTask (Maybe Text)
- maintenanceWindowTask_windowTaskId :: Lens' MaintenanceWindowTask (Maybe Text)
Documentation
data MaintenanceWindowTask Source #
Information about a task defined for a maintenance window.
See: newMaintenanceWindowTask
smart constructor.
MaintenanceWindowTask' | |
|
Instances
newMaintenanceWindowTask :: MaintenanceWindowTask Source #
Create a value of MaintenanceWindowTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmConfiguration:MaintenanceWindowTask'
, maintenanceWindowTask_alarmConfiguration
- The details for the CloudWatch alarm applied to your maintenance window
task.
$sel:cutoffBehavior:MaintenanceWindowTask'
, maintenanceWindowTask_cutoffBehavior
- The specification for whether tasks should continue to run after the
cutoff time specified in the maintenance windows is reached.
$sel:description:MaintenanceWindowTask'
, maintenanceWindowTask_description
- A description of the task.
$sel:loggingInfo:MaintenanceWindowTask'
, maintenanceWindowTask_loggingInfo
- Information about an S3 bucket to write task-level logs to.
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.
$sel:maxConcurrency:MaintenanceWindowTask'
, maintenanceWindowTask_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.
$sel:maxErrors:MaintenanceWindowTask'
, maintenanceWindowTask_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.
$sel:name:MaintenanceWindowTask'
, maintenanceWindowTask_name
- The task name.
$sel:priority:MaintenanceWindowTask'
, maintenanceWindowTask_priority
- The priority of the task in the maintenance window. The lower the
number, the higher the priority. Tasks that have the same priority are
scheduled in parallel.
$sel:serviceRoleArn:MaintenanceWindowTask'
, maintenanceWindowTask_serviceRoleArn
- The Amazon Resource Name (ARN) of the Identity and Access Management
(IAM) service role to use to publish Amazon Simple Notification Service
(Amazon SNS) notifications for maintenance window Run Command tasks.
$sel:targets:MaintenanceWindowTask'
, maintenanceWindowTask_targets
- The targets (either managed nodes or tags). Managed nodes are specified
using Key=instanceids,Values=<instanceid1>,<instanceid2>
. Tags are
specified using Key=<tag name>,Values=<tag value>
.
$sel:taskArn:MaintenanceWindowTask'
, maintenanceWindowTask_taskArn
- The resource that the task uses during execution. For RUN_COMMAND
and
AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems
Manager (SSM document) name or ARN. For LAMBDA
tasks, it's the
function name or ARN. For STEP_FUNCTIONS
tasks, it's the state
machine ARN.
$sel:taskParameters:MaintenanceWindowTask'
, maintenanceWindowTask_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.
$sel:type':MaintenanceWindowTask'
, maintenanceWindowTask_type
- The type of task.
$sel:windowId:MaintenanceWindowTask'
, maintenanceWindowTask_windowId
- The ID of the maintenance window where the task is registered.
$sel:windowTaskId:MaintenanceWindowTask'
, maintenanceWindowTask_windowTaskId
- The task ID.
maintenanceWindowTask_alarmConfiguration :: Lens' MaintenanceWindowTask (Maybe AlarmConfiguration) Source #
The details for the CloudWatch alarm applied to your maintenance window task.
maintenanceWindowTask_cutoffBehavior :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskCutoffBehavior) Source #
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
maintenanceWindowTask_description :: Lens' MaintenanceWindowTask (Maybe Text) Source #
A description of the task.
maintenanceWindowTask_loggingInfo :: Lens' MaintenanceWindowTask (Maybe LoggingInfo) Source #
Information about an S3 bucket to write task-level logs to.
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.
maintenanceWindowTask_maxConcurrency :: Lens' MaintenanceWindowTask (Maybe Text) Source #
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.
maintenanceWindowTask_maxErrors :: Lens' MaintenanceWindowTask (Maybe Text) Source #
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.
maintenanceWindowTask_name :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The task name.
maintenanceWindowTask_priority :: Lens' MaintenanceWindowTask (Maybe Natural) Source #
The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
maintenanceWindowTask_serviceRoleArn :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
maintenanceWindowTask_targets :: Lens' MaintenanceWindowTask (Maybe [Target]) Source #
The targets (either managed nodes or tags). Managed nodes are specified
using Key=instanceids,Values=<instanceid1>,<instanceid2>
. Tags are
specified using Key=<tag name>,Values=<tag value>
.
maintenanceWindowTask_taskArn :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The resource that the task uses during execution. For RUN_COMMAND
and
AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems
Manager (SSM document) name or ARN. For LAMBDA
tasks, it's the
function name or ARN. For STEP_FUNCTIONS
tasks, it's the state
machine ARN.
maintenanceWindowTask_taskParameters :: Lens' MaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
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.
maintenanceWindowTask_type :: Lens' MaintenanceWindowTask (Maybe MaintenanceWindowTaskType) Source #
The type of task.
maintenanceWindowTask_windowId :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The ID of the maintenance window where the task is registered.
maintenanceWindowTask_windowTaskId :: Lens' MaintenanceWindowTask (Maybe Text) Source #
The task ID.