You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::MaintenanceWindowLambdaParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass MaintenanceWindowLambdaParameters data as a hash:

{
  client_context: "MaintenanceWindowLambdaClientContext",
  qualifier: "MaintenanceWindowLambdaQualifier",
  payload: "data",
}

The parameters for a LAMBDA task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

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.

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.

For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

Instance Attribute Summary collapse

Instance Attribute Details

#client_contextString

Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

Returns:

  • (String)


8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8121

class MaintenanceWindowLambdaParameters < Struct.new(
  :client_context,
  :qualifier,
  :payload)
  include Aws::Structure
end

#payloadString

JSON to provide to your Lambda function as input.

Returns:

  • (String)


8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8121

class MaintenanceWindowLambdaParameters < Struct.new(
  :client_context,
  :qualifier,
  :payload)
  include Aws::Structure
end

#qualifierString

(Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.

Returns:

  • (String)


8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8121

class MaintenanceWindowLambdaParameters < Struct.new(
  :client_context,
  :qualifier,
  :payload)
  include Aws::Structure
end