Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters

Description

Synopsis

Documentation

data MaintenanceWindowRunCommandParameters Source #

The parameters for a RUN_COMMAND 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 RUN_COMMAND tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

See: newMaintenanceWindowRunCommandParameters smart constructor.

Constructors

MaintenanceWindowRunCommandParameters'

Fields

cloudWatchOutputConfig :: Maybe CloudWatchOutputConfig
comment :: Maybe Text
Information about the commands to run.
documentHash :: Maybe Text
The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
documentHashType :: Maybe DocumentHashType
SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
documentVersion :: Maybe Text
The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
```
--document-version "\$DEFAULT"
```
```
--document-version "\$LATEST"
```
```
--document-version "3"
```
notificationConfig :: Maybe NotificationConfig
Configurations for sending notifications about command status changes on a per-managed node basis.
outputS3BucketName :: Maybe Text
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
outputS3KeyPrefix :: Maybe Text
The S3 bucket subfolder.
parameters :: Maybe (Sensitive (HashMap Text [Text]))
The parameters for the RUN_COMMAND task execution.
serviceRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
timeoutSeconds :: Maybe Natural
If this time is reached and the command hasn't already started running, it doesn't run.

Instances

Instances details

FromJSON MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods parseJSON :: Value -> Parser MaintenanceWindowRunCommandParameters # parseJSONList :: Value -> Parser [MaintenanceWindowRunCommandParameters] #
ToJSON MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods toJSON :: MaintenanceWindowRunCommandParameters -> Value # toEncoding :: MaintenanceWindowRunCommandParameters -> Encoding # toJSONList :: [MaintenanceWindowRunCommandParameters] -> Value # toEncodingList :: [MaintenanceWindowRunCommandParameters] -> Encoding #
Generic MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Associated Types type Rep MaintenanceWindowRunCommandParameters :: Type -> Type # Methods from :: MaintenanceWindowRunCommandParameters -> Rep MaintenanceWindowRunCommandParameters x # to :: Rep MaintenanceWindowRunCommandParameters x -> MaintenanceWindowRunCommandParameters #
Show MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods showsPrec :: Int -> MaintenanceWindowRunCommandParameters -> ShowS # show :: MaintenanceWindowRunCommandParameters -> String # showList :: [MaintenanceWindowRunCommandParameters] -> ShowS #
NFData MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods rnf :: MaintenanceWindowRunCommandParameters -> () #
Eq MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods (==) :: MaintenanceWindowRunCommandParameters -> MaintenanceWindowRunCommandParameters -> Bool # (/=) :: MaintenanceWindowRunCommandParameters -> MaintenanceWindowRunCommandParameters -> Bool #
Hashable MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters Methods hashWithSalt :: Int -> MaintenanceWindowRunCommandParameters -> Int # hash :: MaintenanceWindowRunCommandParameters -> Int #
type Rep MaintenanceWindowRunCommandParameters Source #
Instance details Defined in Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters type Rep MaintenanceWindowRunCommandParameters = D1 ('MetaData "MaintenanceWindowRunCommandParameters" "Amazonka.SSM.Types.MaintenanceWindowRunCommandParameters" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "MaintenanceWindowRunCommandParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchOutputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchOutputConfig)) :: S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "documentHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentHashType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentHashType)) :: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "notificationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationConfig)) :: (S1 ('MetaSel ('Just "outputS3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "outputS3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text [Text])))) :: (S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))))

newMaintenanceWindowRunCommandParameters :: MaintenanceWindowRunCommandParameters Source #

Create a value of MaintenanceWindowRunCommandParameters 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:cloudWatchOutputConfig:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_cloudWatchOutputConfig - Undocumented member.

$sel:comment:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_comment - Information about the commands to run.

$sel:documentHash:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_documentHash - The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

$sel:documentHashType:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_documentHashType - SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

$sel:documentVersion:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_documentVersion - The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

$sel:notificationConfig:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_notificationConfig - Configurations for sending notifications about command status changes on a per-managed node basis.

$sel:outputS3BucketName:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_outputS3BucketName - The name of the Amazon Simple Storage Service (Amazon S3) bucket.

$sel:outputS3KeyPrefix:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_outputS3KeyPrefix - The S3 bucket subfolder.

$sel:parameters:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_parameters - The parameters for the RUN_COMMAND task execution.

$sel:serviceRoleArn:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_serviceRoleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

$sel:timeoutSeconds:MaintenanceWindowRunCommandParameters', maintenanceWindowRunCommandParameters_timeoutSeconds - If this time is reached and the command hasn't already started running, it doesn't run.

maintenanceWindowRunCommandParameters_cloudWatchOutputConfig :: Lens' MaintenanceWindowRunCommandParameters (Maybe CloudWatchOutputConfig) Source #

Undocumented member.

maintenanceWindowRunCommandParameters_comment :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

Information about the commands to run.

maintenanceWindowRunCommandParameters_documentHash :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

maintenanceWindowRunCommandParameters_documentHashType :: Lens' MaintenanceWindowRunCommandParameters (Maybe DocumentHashType) Source #

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

maintenanceWindowRunCommandParameters_documentVersion :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Amazon Web Services CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

maintenanceWindowRunCommandParameters_notificationConfig :: Lens' MaintenanceWindowRunCommandParameters (Maybe NotificationConfig) Source #

Configurations for sending notifications about command status changes on a per-managed node basis.

maintenanceWindowRunCommandParameters_outputS3BucketName :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

maintenanceWindowRunCommandParameters_outputS3KeyPrefix :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The S3 bucket subfolder.

maintenanceWindowRunCommandParameters_parameters :: Lens' MaintenanceWindowRunCommandParameters (Maybe (HashMap Text [Text])) Source #

The parameters for the RUN_COMMAND task execution.

maintenanceWindowRunCommandParameters_serviceRoleArn :: Lens' MaintenanceWindowRunCommandParameters (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

maintenanceWindowRunCommandParameters_timeoutSeconds :: Lens' MaintenanceWindowRunCommandParameters (Maybe Natural) Source #

If this time is reached and the command hasn't already started running, it doesn't run.