Class CfnMaintenanceWindowTask.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMaintenanceWindowTask>
- Enclosing class:
CfnMaintenanceWindowTask
CfnMaintenanceWindowTask
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
cutoffBehavior
(String cutoffBehavior) The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.description
(String description) A description of the task.loggingInfo
(IResolvable loggingInfo) Information about an Amazon S3 bucket to write Run Command task-level logs to.loggingInfo
(CfnMaintenanceWindowTask.LoggingInfoProperty loggingInfo) Information about an Amazon S3 bucket to write Run Command task-level logs to.maxConcurrency
(String maxConcurrency) The maximum number of targets this task can be run for, in parallel.The maximum number of errors allowed before this task stops being scheduled.The task name.The priority of the task in the maintenance window.serviceRoleArn
(String serviceRoleArn) The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.The targets, either instances or window target IDs.targets
(IResolvable targets) The targets, either instances or window target IDs.The resource that the task uses during execution.taskInvocationParameters
(IResolvable taskInvocationParameters) The parameters to pass to the task when it runs.taskInvocationParameters
(CfnMaintenanceWindowTask.TaskInvocationParametersProperty taskInvocationParameters) The parameters to pass to the task when it runs.taskParameters
(Object taskParameters) The parameters to pass to the task when it runs.The type of task.The ID of the maintenance window where the task is registered.
-
Method Details
-
create
@Stability(Stable) public static CfnMaintenanceWindowTask.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnMaintenanceWindowTask.Builder
.
-
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.
- Parameters:
priority
- The priority of the task in the maintenance window. This parameter is required.- Returns:
this
- See Also:
-
taskArn
The resource that the task uses during execution.For
RUN_COMMAND
andAUTOMATION
task types,TaskArn
is the SSM document name or Amazon Resource Name (ARN).For
LAMBDA
tasks,TaskArn
is the function name or ARN.For
STEP_FUNCTIONS
tasks,TaskArn
is the state machine ARN.- Parameters:
taskArn
- The resource that the task uses during execution. This parameter is required.- Returns:
this
- See Also:
-
taskType
The type of task.Valid values:
RUN_COMMAND
,AUTOMATION
,LAMBDA
,STEP_FUNCTIONS
.- Parameters:
taskType
- The type of task. This parameter is required.- Returns:
this
- See Also:
-
windowId
The ID of the maintenance window where the task is registered.- Parameters:
windowId
- The ID of the maintenance window where the task is registered. This parameter is required.- Returns:
this
- See Also:
-
cutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.- Parameters:
cutoffBehavior
- The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. This parameter is required.- Returns:
this
- See Also:
-
description
A description of the task.- Parameters:
description
- A description of the task. This parameter is required.- Returns:
this
- See Also:
-
loggingInfo
Information about an Amazon S3 bucket to write Run Command task-level logs to.LoggingInfo
has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .- Parameters:
loggingInfo
- Information about an Amazon S3 bucket to write Run Command task-level logs to. This parameter is required.- Returns:
this
- See Also:
-
loggingInfo
@Stability(Stable) public CfnMaintenanceWindowTask.Builder loggingInfo(CfnMaintenanceWindowTask.LoggingInfoProperty loggingInfo) Information about an Amazon S3 bucket to write Run Command task-level logs to.LoggingInfo
has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .- Parameters:
loggingInfo
- Information about an Amazon S3 bucket to write Run Command task-level logs to. This parameter is required.- Returns:
this
- See Also:
-
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.- Parameters:
maxConcurrency
- The maximum number of targets this task can be run for, in parallel. This parameter is required.- Returns:
this
- See Also:
-
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.- Parameters:
maxErrors
- The maximum number of errors allowed before this task stops being scheduled. This parameter is required.- Returns:
this
- See Also:
-
name
The task name.- Parameters:
name
- The task name. This parameter is required.- Returns:
this
- See Also:
-
serviceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for AWS 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 AWS Systems Manager User Guide .
- Parameters:
serviceRoleArn
- The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. This parameter is required.- Returns:
this
- See Also:
-
targets
The targets, either instances or window target IDs.- Specify instances using
Key=InstanceIds,Values= *instanceid1* , *instanceid2*
. - Specify window target IDs using
Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*
.
- Parameters:
targets
- The targets, either instances or window target IDs. This parameter is required.- Returns:
this
- See Also:
- Specify instances using
-
targets
The targets, either instances or window target IDs.- Specify instances using
Key=InstanceIds,Values= *instanceid1* , *instanceid2*
. - Specify window target IDs using
Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*
.
- Parameters:
targets
- The targets, either instances or window target IDs. This parameter is required.- Returns:
this
- See Also:
- Specify instances using
-
taskInvocationParameters
@Stability(Stable) public CfnMaintenanceWindowTask.Builder taskInvocationParameters(IResolvable taskInvocationParameters) The parameters to pass to the task when it runs.Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in
TaskInvocationParameters
, you must provide again all theTaskInvocationParameters
values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.- Parameters:
taskInvocationParameters
- The parameters to pass to the task when it runs. This parameter is required.- Returns:
this
- See Also:
-
taskInvocationParameters
@Stability(Stable) public CfnMaintenanceWindowTask.Builder taskInvocationParameters(CfnMaintenanceWindowTask.TaskInvocationParametersProperty taskInvocationParameters) The parameters to pass to the task when it runs.Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in
TaskInvocationParameters
, you must provide again all theTaskInvocationParameters
values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.- Parameters:
taskInvocationParameters
- The parameters to pass to the task when it runs. This parameter is required.- Returns:
this
- See Also:
-
taskParameters
The parameters to pass to the task when it runs.TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .- Parameters:
taskParameters
- The parameters to pass to the task when it runs. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnMaintenanceWindowTask>
- Returns:
- a newly built instance of
CfnMaintenanceWindowTask
.
-