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.
| Source | |
|---|---|
| Type last changed |
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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssm as ssm
notification_config_property = ssm.CfnMaintenanceWindowTask.NotificationConfigProperty(
notification_arn="notificationArn",
# the properties below are optional
notification_events=["notificationEvents"],
notification_type="notificationType"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ssm.*;
NotificationConfigProperty notificationConfigProperty = NotificationConfigProperty.builder()
.notificationArn("notificationArn")
// the properties below are optional
.notificationEvents(List.of("notificationEvents"))
.notificationType("notificationType")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var notificationConfigProperty = new NotificationConfigProperty {
NotificationArn = "notificationArn",
// the properties below are optional
NotificationEvents = new [] { "notificationEvents" },
NotificationType = "notificationType"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
notificationConfigProperty := &NotificationConfigProperty{
NotificationArn: jsii.String("notificationArn"),
// the properties below are optional
NotificationEvents: []*string{
jsii.String("notificationEvents"),
},
NotificationType: jsii.String("notificationType"),
}
Properties
notificationArnstringnotification_arnstrnotificationArnStringNotificationArnstringNotificationArn*string required #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.