Class NotificationSetting

java.lang.Object
software.amazon.awssdk.services.rolesanywhere.model.NotificationSetting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotificationSetting.Builder,NotificationSetting>
@Generated("software.amazon.awssdk:codegen") public final class NotificationSetting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotificationSetting.Builder,NotificationSetting>

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 Health Dashboard.

See Also:

  • Method Details

    • channel

      public final NotificationChannel channel()

      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

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

      If the service returns an enum value that is not available in the current SDK version, channel will return NotificationChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

      Returns:
      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and 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:

    • channelAsString

      public final String channelAsString()

      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

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

      If the service returns an enum value that is not available in the current SDK version, channel will return NotificationChannel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelAsString().

      Returns:
      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and 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:

    • enabled

      public final Boolean enabled()

      Indicates whether the notification setting is enabled.

      Returns:
      Indicates whether the notification setting is enabled.

    • event

      public final NotificationEvent event()

      The event to which this notification setting is applied.

      If the service returns an enum value that is not available in the current SDK version, event will return NotificationEvent.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventAsString().

      Returns:
      The event to which this notification setting is applied.
      See Also:

    • eventAsString

      public final String eventAsString()

      The event to which this notification setting is applied.

      If the service returns an enum value that is not available in the current SDK version, event will return NotificationEvent.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventAsString().

      Returns:
      The event to which this notification setting is applied.
      See Also:

    • threshold

      public final Integer threshold()

      The number of days before a notification event. This value is required for a notification setting that is enabled.

      Returns:
      The number of days before a notification event. This value is required for a notification setting that is enabled.

    • toBuilder

      public NotificationSetting.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NotificationSetting.Builder,NotificationSetting>
      Returns:
      a builder for type T

    • builder

      public static NotificationSetting.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NotificationSetting.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.