aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTask.NotificationConfigProperty

interface NotificationConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnMaintenanceWindowTask.NotificationConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnMaintenanceWindowTask_NotificationConfigProperty
Javasoftware.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.NotificationConfigProperty
Pythonaws_cdk.aws_ssm.CfnMaintenanceWindowTask.NotificationConfigProperty
TypeScript aws-cdk-lib » aws_ssm » CfnMaintenanceWindowTask » NotificationConfigProperty

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

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

NameTypeDescription
notificationArnstringAn Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.
notificationEvents?string[]The different events that you can receive notifications for.
notificationType?stringThe notification type.

notificationArn

Type: string

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.


notificationEvents?

Type: string[] (optional)

The different events that you can receive notifications for.

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 .


notificationType?

Type: string (optional)

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.