aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

MaintenanceWindowRunCommandParametersProperty Struct

The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager .

This means that these parameters are the same as those for the SendCommand API call. For more information about SendCommand parameters, see SendCommand in the AWS Systems Manager API Reference .

For information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see Viewing SSM command document content in the AWS Systems Manager User Guide .

MaintenanceWindowRunCommandParameters is a property of the TaskInvocationParameters property type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';

declare const parameters: any;
const maintenanceWindowRunCommandParametersProperty: ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty = {
  cloudWatchOutputConfig: {
    cloudWatchLogGroupName: 'cloudWatchLogGroupName',
    cloudWatchOutputEnabled: false,
  },
  comment: 'comment',
  documentHash: 'documentHash',
  documentHashType: 'documentHashType',
  documentVersion: 'documentVersion',
  notificationConfig: {
    notificationArn: 'notificationArn',

    // the properties below are optional
    notificationEvents: ['notificationEvents'],
    notificationType: 'notificationType',
  },
  outputS3BucketName: 'outputS3BucketName',
  outputS3KeyPrefix: 'outputS3KeyPrefix',
  parameters: parameters,
  serviceRoleArn: 'serviceRoleArn',
  timeoutSeconds: 123,
};

Properties

cloudWatchOutputConfig?optionalIResolvable | CfnMaintenanceWindowTask.CloudWatchOutputConfigPropertycloud_watch_output_config?optionaltyping.Union[IResolvable, CloudWatchOutputConfigProperty]cloudWatchOutputConfig?optionalIResolvableCloudWatchOutputConfig?optionalIResolvableCloudWatchOutputConfig?optionalinterface{}#

Configuration options for sending command output to Amazon CloudWatch Logs.

comment?optionalstringcomment?optionalstrcomment?optionalStringComment?optionalstringComment?optional*string#

Information about the command or commands to run.

documentHash?optionalstringdocument_hash?optionalstrdocumentHash?optionalStringDocumentHash?optionalstringDocumentHash?optional*string#

The SHA-256 or SHA-1 hash created by the system when the document was created.

SHA-1 hashes have been deprecated.

documentHashType?optionalstringdocument_hash_type?optionalstrdocumentHashType?optionalStringDocumentHashType?optionalstringDocumentHashType?optional*string#

The SHA-256 or SHA-1 hash type.

SHA-1 hashes are deprecated.

documentVersion?optionalstringdocument_version?optionalstrdocumentVersion?optionalStringDocumentVersion?optionalstringDocumentVersion?optional*string#

The AWS Systems Manager document (SSM document) version to use in the request.

notes

You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS 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?optionalIResolvable | CfnMaintenanceWindowTask.NotificationConfigPropertynotification_config?optionaltyping.Union[IResolvable, NotificationConfigProperty]notificationConfig?optionalIResolvableNotificationConfig?optionalIResolvableNotificationConfig?optionalinterface{}#

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

outputS3BucketName?optionalstringoutput_s3_bucket_name?optionalstroutputS3BucketName?optionalStringOutputS3BucketName?optionalstringOutputS3BucketName?optional*string#

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

outputS3KeyPrefix?optionalstringoutput_s3_key_prefix?optionalstroutputS3KeyPrefix?optionalStringOutputS3KeyPrefix?optionalstringOutputS3KeyPrefix?optional*string#

The S3 bucket subfolder.

parameters?optionalanyparameters?optionalAnyparameters?optionalObjectParameters?optionalobjectParameters?optionalinterface{}#

The parameters for the `RUN_COMMAND` task execution.

notes

The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

serviceRoleArn?optionalstringservice_role_arn?optionalstrserviceRoleArn?optionalStringServiceRoleArn?optionalstringServiceRoleArn?optional*string#

The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.

notes

If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

timeoutSeconds?optionalnumbertimeout_seconds?optionalint | floattimeoutSeconds?optionalNumberTimeoutSeconds?optionaldoubleTimeoutSeconds?optional*float64#

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