Paws::SSM::RegisterTaskWithMaintenanceWindow - Arguments for method RegisterTaskWithMaintenanceWindow on Paws::SSM
This class represents the parameters used for calling the method RegisterTaskWithMaintenanceWindow on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method RegisterTaskWithMaintenanceWindow.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterTaskWithMaintenanceWindow.
my $ssm = Paws->service('SSM'); my $RegisterTaskWithMaintenanceWindowResult = $ssm->RegisterTaskWithMaintenanceWindow( TaskArn => 'MyMaintenanceWindowTaskArn', TaskType => 'RUN_COMMAND', WindowId => 'MyMaintenanceWindowId', ClientToken => 'MyClientToken', # OPTIONAL Description => 'MyMaintenanceWindowDescription', # OPTIONAL LoggingInfo => { S3BucketName => 'MyS3BucketName', # min: 3, max: 63 S3Region => 'MyS3Region', # min: 3, max: 20 S3KeyPrefix => 'MyS3KeyPrefix', # max: 500; OPTIONAL }, # OPTIONAL MaxConcurrency => 'MyMaxConcurrency', # OPTIONAL MaxErrors => 'MyMaxErrors', # OPTIONAL Name => 'MyMaintenanceWindowName', # OPTIONAL Priority => 1, # OPTIONAL ServiceRoleArn => 'MyServiceRole', # OPTIONAL Targets => [ { Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL }, ... ], # OPTIONAL TaskInvocationParameters => { Automation => { DocumentVersion => 'MyDocumentVersion', # OPTIONAL Parameters => { 'MyAutomationParameterKey' => [ 'MyAutomationParameterValue', ... # min: 1, max: 512 ], # key: min: 1, max: 50, value: max: 50 }, # min: 1, max: 200; OPTIONAL }, # OPTIONAL Lambda => { ClientContext => 'MyMaintenanceWindowLambdaClientContext' , # min: 1, max: 8000; OPTIONAL Payload => 'BlobMaintenanceWindowLambdaPayload', # max: 4096; OPTIONAL Qualifier => 'MyMaintenanceWindowLambdaQualifier', # min: 1, max: 128; OPTIONAL }, # OPTIONAL RunCommand => { CloudWatchOutputConfig => { CloudWatchLogGroupName => 'MyCloudWatchLogGroupName', # min: 1, max: 512; OPTIONAL CloudWatchOutputEnabled => 1, # OPTIONAL }, # OPTIONAL Comment => 'MyComment', # max: 100; OPTIONAL DocumentHash => 'MyDocumentHash', # max: 256; OPTIONAL DocumentHashType => 'Sha256', # values: Sha256, Sha1; OPTIONAL DocumentVersion => 'MyDocumentVersion', # OPTIONAL NotificationConfig => { NotificationArn => 'MyNotificationArn', # OPTIONAL NotificationEvents => [ 'All', ... # values: All, InProgress, Success, TimedOut, Cancelled, Failed ], # OPTIONAL NotificationType => 'Command', # values: Command, Invocation; OPTIONAL }, # OPTIONAL OutputS3BucketName => 'MyS3BucketName', # min: 3, max: 63 OutputS3KeyPrefix => 'MyS3KeyPrefix', # max: 500; OPTIONAL Parameters => { 'MyParameterName' => [ 'MyParameterValue', ... ], } , # OPTIONAL ServiceRoleArn => 'MyServiceRole', TimeoutSeconds => 1, # min: 30, max: 2592000; OPTIONAL }, # OPTIONAL StepFunctions => { Input => 'MyMaintenanceWindowStepFunctionsInput', # max: 4096; OPTIONAL Name => 'MyMaintenanceWindowStepFunctionsName', # min: 1, max: 80; OPTIONAL }, # OPTIONAL }, # OPTIONAL TaskParameters => { 'MyMaintenanceWindowTaskParameterName' => { Values => [ 'MyMaintenanceWindowTaskParameterValue', ... # min: 1, max: 255 ], # OPTIONAL }, # key: min: 1, max: 255 }, # OPTIONAL ); # Results: my $WindowTaskId = $RegisterTaskWithMaintenanceWindowResult->WindowTaskId; # Returns a L<Paws::SSM::RegisterTaskWithMaintenanceWindowResult> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/RegisterTaskWithMaintenanceWindow
User-provided idempotency token.
An optional description for the task.
A structure containing information about an 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.
LoggingInfo
OutputS3BucketName
OutputS3KeyPrefix
TaskInvocationParameters
The maximum number of targets this task can be run for in parallel.
For maintenance window tasks without a target specified, you cannot supply a value for this option. Instead, the system inserts a placeholder value of 1. This value does not affect the running of your task.
1
The maximum number of errors allowed before this task stops being scheduled.
An optional name for the task.
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.
The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
RegisterTaskWithMaintenanceWindow
For more information, see the following topics in the in the AWS Systems Manager User Guide:
Using service-linked roles for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions)
Should I use a service-linked role or a custom service role to run maintenance window tasks? (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
The targets (either instances or maintenance window targets).
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the AWS Systems Manager User Guide.
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>
The ARN of the task to run.
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
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.
TaskParameters
Parameters
The type of task being registered.
Valid values are: "RUN_COMMAND", "AUTOMATION", "STEP_FUNCTIONS", "LAMBDA"
"RUN_COMMAND"
"AUTOMATION"
"STEP_FUNCTIONS"
"LAMBDA"
The ID of the maintenance window the task should be added to.
This class forms part of Paws, documenting arguments for method RegisterTaskWithMaintenanceWindow in Paws::SSM
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws
CPAN shell
perl -MCPAN -e shell install Paws
For more information on module installation, please visit the detailed CPAN module installation guide.