cloudwatchomni/aws.sdk.kotlin.services.cloudwatchomni.model/Alert

Alert

Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the same alert describe it identically except for {@code state}, which only the read paths populate. UpdateAlert returns an empty response.

Types

Builder

class Builder

Companion

object Companion

Properties

accountId

val accountId: String

The AWS account ID that owns the alert.

alertArn

val alertArn: String

The Amazon Resource Name (ARN) of the alert.

alertId

val alertId: String?

The stable alert identifier (see {@link AlertId}), minted on create and immutable across updates. Use it (not {@code name}) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

createdAt

val createdAt: Instant

The timestamp when the alert was created.

description

val description: String?

An optional description of the alert.

name

val name: String

The name of the alert.

notificationRules

val notificationRules: List<NotificationRule>?

The notification rules for the alert.

notificationStatus

val notificationStatus: NotificationStatus?

Whether notifications are enabled.

profileId

val profileId: String?

The ID of the access profile associated with the alert.

rule

val rule: Rule?

The rule that defines how the alert is evaluated.

spaceId

val spaceId: String?

The ID of the space the alert belongs to.

state

val state: AlertStateInfo?

Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required. Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it. contributorSummary is nested inside this member, so it too is absent on CreateAlert.

updatedAt

val updatedAt: Instant

The timestamp when the alert was last updated.

Functions

copy

inline fun copy(block: Alert.Builder.() -> Unit = {}): Alert

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String