Package software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowTask.NotificationConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowTask.NotificationConfigProperty.Jsii$Proxy

Enclosing class:

CfnMaintenanceWindowTask

@Stability(Stable)
public static interface CfnMaintenanceWindowTask.NotificationConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ssm.*;
 NotificationConfigProperty notificationConfigProperty = NotificationConfigProperty.builder()
         .notificationArn("notificationArn")
         // the properties below are optional
         .notificationEvents(List.of("notificationEvents"))
         .notificationType("notificationType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMaintenanceWindowTask.NotificationConfigProperty.Builder	A builder for CfnMaintenanceWindowTask.NotificationConfigProperty
static final class	CfnMaintenanceWindowTask.NotificationConfigProperty.Jsii$Proxy	An implementation for CfnMaintenanceWindowTask.NotificationConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnMaintenanceWindowTask.NotificationConfigProperty.Builder	builder()
String	getNotificationArn()	An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.
default List<String>	getNotificationEvents()	The different events that you can receive notifications for.
default String	getNotificationType()	The notification type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNotificationArn

@Stability(Stable)
@NotNull
String getNotificationArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn

getNotificationEvents

@Stability(Stable)
@Nullable
default List<String> getNotificationEvents()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents

getNotificationType

@Stability(Stable)
@Nullable
default String getNotificationType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype

builder

@Stability(Stable)
static CfnMaintenanceWindowTask.NotificationConfigProperty.Builder builder()

Returns:

a CfnMaintenanceWindowTask.NotificationConfigProperty.Builder of CfnMaintenanceWindowTask.NotificationConfigProperty