Interface ICfnMaintenanceWindowTaskProps
Properties for defining a CfnMaintenanceWindowTask.
public interface ICfnMaintenanceWindowTaskPropsExamples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var parameters;
var taskParameters;
var cfnMaintenanceWindowTaskProps = new CfnMaintenanceWindowTaskProps {
Priority = 123,
TaskArn = "taskArn",
TaskType = "taskType",
WindowId = "windowId",
// the properties below are optional
CutoffBehavior = "cutoffBehavior",
Description = "description",
LoggingInfo = new LoggingInfoProperty {
Region = "region",
S3Bucket = "s3Bucket",
// the properties below are optional
S3Prefix = "s3Prefix"
},
MaxConcurrency = "maxConcurrency",
MaxErrors = "maxErrors",
Name = "name",
ServiceRoleArn = "serviceRoleArn",
Targets = new [] { new TargetProperty {
Key = "key",
Values = new [] { "values" }
} },
TaskInvocationParameters = new TaskInvocationParametersProperty {
MaintenanceWindowAutomationParameters = new MaintenanceWindowAutomationParametersProperty {
DocumentVersion = "documentVersion",
Parameters = parameters
},
MaintenanceWindowLambdaParameters = new MaintenanceWindowLambdaParametersProperty {
ClientContext = "clientContext",
Payload = "payload",
Qualifier = "qualifier"
},
MaintenanceWindowRunCommandParameters = new MaintenanceWindowRunCommandParametersProperty {
CloudWatchOutputConfig = new CloudWatchOutputConfigProperty {
CloudWatchLogGroupName = "cloudWatchLogGroupName",
CloudWatchOutputEnabled = false
},
Comment = "comment",
DocumentHash = "documentHash",
DocumentHashType = "documentHashType",
DocumentVersion = "documentVersion",
NotificationConfig = new NotificationConfigProperty {
NotificationArn = "notificationArn",
// the properties below are optional
NotificationEvents = new [] { "notificationEvents" },
NotificationType = "notificationType"
},
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
Parameters = parameters,
ServiceRoleArn = "serviceRoleArn",
TimeoutSeconds = 123
},
MaintenanceWindowStepFunctionsParameters = new MaintenanceWindowStepFunctionsParametersProperty {
Input = "input",
Name = "name"
}
},
TaskParameters = taskParameters
};Remarks
ExampleMetadata: fixture=_generated
Properties
CutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
string? CutoffBehavior { get; }Property Value
Remarks
Description
A description of the task.
string? Description { get; }Property Value
Remarks
LoggingInfo
Information about an Amazon S3 bucket to write Run Command task-level logs to.
object? LoggingInfo { get; }Property Value
Remarks
<code>LoggingInfo</code> has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html">AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters</a> .
MaxConcurrency
The maximum number of targets this task can be run for, in parallel.
string? MaxConcurrency { get; }Property Value
Remarks
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> 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.
MaxErrors
The maximum number of errors allowed before this task stops being scheduled.
string? MaxErrors { get; }Property Value
Remarks
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> 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.
Name
The task name.
string? Name { get; }Property Value
Remarks
Priority
The priority of the task in the maintenance window.
double Priority { get; }Property Value
Remarks
The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
ServiceRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
string? ServiceRoleArn { get; }Property Value
Remarks
Targets
The targets, either instances or window target IDs.
object? Targets { get; }Property Value
Remarks
TaskArn
The resource that the task uses during execution.
string TaskArn { get; }Property Value
Remarks
For RUN_COMMAND and AUTOMATION 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.
TaskInvocationParameters
The parameters to pass to the task when it runs.
object? TaskInvocationParameters { get; }Property Value
Remarks
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 <code>TaskInvocationParameters</code> , you must provide again all the <code>TaskInvocationParameters</code> 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 specified <code>TaskInvocationParameters</code> values for <code>Comment</code> , <code>NotificationConfig</code> , and <code>OutputS3BucketName</code> . If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.
TaskParameters
The parameters to pass to the task when it runs.
object? TaskParameters { get; }Property Value
Remarks
<code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html">MaintenanceWindowTaskInvocationParameters</a> .
TaskType
The type of task.
string TaskType { get; }Property Value
Remarks
Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .
WindowId
The ID of the maintenance window where the task is registered.
string WindowId { get; }