amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

Description

 
Synopsis

Documentation

data MaintenanceWindowLambdaParameters Source #

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 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.

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.

See: newMaintenanceWindowLambdaParameters smart constructor.

Constructors

MaintenanceWindowLambdaParameters' 

Fields

  • clientContext :: Maybe Text

    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.

  • payload :: Maybe (Sensitive Base64)

    JSON to provide to your Lambda function as input.

  • qualifier :: Maybe Text

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

Instances

Instances details
FromJSON MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

ToJSON MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

Generic MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

Associated Types

type Rep MaintenanceWindowLambdaParameters :: Type -> Type #

Show MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

NFData MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

Eq MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

Hashable MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

type Rep MaintenanceWindowLambdaParameters Source # 
Instance details

Defined in Amazonka.SSM.Types.MaintenanceWindowLambdaParameters

type Rep MaintenanceWindowLambdaParameters = D1 ('MetaData "MaintenanceWindowLambdaParameters" "Amazonka.SSM.Types.MaintenanceWindowLambdaParameters" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "MaintenanceWindowLambdaParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 ('MetaSel ('Just "qualifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMaintenanceWindowLambdaParameters :: MaintenanceWindowLambdaParameters Source #

Create a value of MaintenanceWindowLambdaParameters 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:clientContext:MaintenanceWindowLambdaParameters', maintenanceWindowLambdaParameters_clientContext - 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.

$sel:payload:MaintenanceWindowLambdaParameters', maintenanceWindowLambdaParameters_payload - JSON to provide to your Lambda function as input.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:qualifier:MaintenanceWindowLambdaParameters', maintenanceWindowLambdaParameters_qualifier - (Optional) Specify an Lambda function version or alias name. If you specify a function version, the operation uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the operation uses the alias ARN to invoke the Lambda function version to which the alias points.

maintenanceWindowLambdaParameters_clientContext :: Lens' MaintenanceWindowLambdaParameters (Maybe Text) Source #

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.

maintenanceWindowLambdaParameters_payload :: Lens' MaintenanceWindowLambdaParameters (Maybe ByteString) Source #

JSON to provide to your Lambda function as input.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

maintenanceWindowLambdaParameters_qualifier :: Lens' MaintenanceWindowLambdaParameters (Maybe Text) Source #

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