Package software.amazon.awscdk.services.rolesanywhere

Interface CfnTrustAnchor.NotificationSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrustAnchor.NotificationSettingProperty.Jsii$Proxy

Enclosing class:

CfnTrustAnchor

@Stability(Stable)
public static interface CfnTrustAnchor.NotificationSettingProperty
extends software.amazon.jsii.JsiiSerializable

Customizable notification settings that will be applied to notification events.

IAM Roles Anywhere consumes these settings while notifying across multiple channels - CloudWatch metrics, EventBridge, and AWS Health Dashboard .

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.rolesanywhere.*;
 NotificationSettingProperty notificationSettingProperty = NotificationSettingProperty.builder()
         .enabled(false)
         .event("event")
         // the properties below are optional
         .channel("channel")
         .threshold(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrustAnchor.NotificationSettingProperty.Builder	builder()
default String	getChannel()	The specified channel of notification.
Object	getEnabled()	Indicates whether the notification setting is enabled.
String	getEvent()	The event to which this notification setting is applied.
default Number	getThreshold()	The number of days before a notification event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

Indicates whether the notification setting is enabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-enabled

getEvent

@Stability(Stable)
@NotNull
String getEvent()

The event to which this notification setting is applied.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-event

getChannel

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

The specified channel of notification.

IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and AWS Health Dashboard to notify for an event.

In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-channel

getThreshold

@Stability(Stable)
@Nullable
default Number getThreshold()

The number of days before a notification event.

This value is required for a notification setting that is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-notificationsetting.html#cfn-rolesanywhere-trustanchor-notificationsetting-threshold

builder

@Stability(Stable)
static CfnTrustAnchor.NotificationSettingProperty.Builder builder()

Returns:

a CfnTrustAnchor.NotificationSettingProperty.Builder of CfnTrustAnchor.NotificationSettingProperty