1.204.0

interface MaintenanceWindowRunCommandParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty
Javasoftware.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty
Pythonaws_cdk.aws_ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty
TypeScript @aws-cdk/aws-ssm » CfnMaintenanceWindowTask » MaintenanceWindowRunCommandParametersProperty

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.

Example

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

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

NameTypeDescription
cloudWatchOutputConfig?IResolvable | CloudWatchOutputConfigPropertyConfiguration options for sending command output to Amazon CloudWatch Logs.
comment?stringInformation about the command or commands to run.
documentHash?stringThe SHA-256 or SHA-1 hash created by the system when the document was created.
documentHashType?stringThe SHA-256 or SHA-1 hash type.
documentVersion?stringThe AWS Systems Manager document (SSM document) version to use in the request.
notificationConfig?IResolvable | NotificationConfigPropertyConfigurations for sending notifications about command status changes on a per-managed node basis.
outputS3BucketName?stringThe name of the Amazon Simple Storage Service (Amazon S3) bucket.
outputS3KeyPrefix?stringThe S3 bucket subfolder.
parameters?anyThe parameters for the RUN_COMMAND task execution.
serviceRoleArn?stringThe Amazon Resource Name (ARN) of the AWS 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?numberIf this time is reached and the command hasn't already started running, it doesn't run.

cloudWatchOutputConfig?

Type: IResolvable | CloudWatchOutputConfigProperty (optional)

Configuration options for sending command output to Amazon CloudWatch Logs.

comment?

Type: string (optional)

Information about the command or commands to run.

documentHash?

Type: string (optional)

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

SHA-1 hashes have been deprecated.

documentHashType?

Type: string (optional)

The SHA-256 or SHA-1 hash type.

SHA-1 hashes are deprecated.

documentVersion?

Type: string (optional)

The AWS 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 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?

Type: IResolvable | NotificationConfigProperty (optional)

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

outputS3BucketName?

Type: string (optional)

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

outputS3KeyPrefix?

Type: string (optional)

The S3 bucket subfolder.

parameters?

Type: any (optional)

The parameters for the RUN_COMMAND task execution.

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?

Type: string (optional)

The Amazon Resource Name (ARN) of the AWS 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?

Type: number (optional)

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

← PreviousNext →