Skip to content
v2.275.0

NotificationConfigProperty Struct ​

The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .

NotificationConfig is a property of the MaintenanceWindowRunCommandParameters property type.

Example ​

ts
// 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';
const notificationConfigProperty: ssm.CfnMaintenanceWindowTask.NotificationConfigProperty = {
  notificationArn: 'notificationArn',

  // the properties below are optional
  notificationEvents: ['notificationEvents'],
  notificationType: 'notificationType',
};

Properties ​

notificationArnstringnotification_arnstrnotificationArnStringNotificationArnstringNotificationArn*stringrequired#
An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.

Run Command pushes notifications about command status changes to this topic.

notificationEventsoptionalstring[]notification_eventsoptionaltyping.List[str]notificationEventsoptionalList<String>NotificationEventsoptionalstring[]NotificationEventsoptional*[]*string#
The different events that you can receive notifications for.
notes

These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .

notificationTypeoptionalstringnotification_typeoptionalstrnotificationTypeoptionalStringNotificationTypeoptionalstringNotificationTypeoptional*string#
The notification type.
  • Command : Receive notification when the status of a command changes.
  • Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.