Interface Alert.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Alert.Builder,Alert>, SdkBuilder<Alert.Builder,Alert>, SdkPojo
Enclosing class:
Alert
@Mutable @NotThreadSafe public static interface Alert.Builder extends SdkPojo, CopyableBuilder<Alert.Builder,Alert>

  • Method Details

    • name

      Alert.Builder name(String name)

      The name of the alert.

      Parameters:
      name - The name of the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alertId

      Alert.Builder alertId(String alertId)

      The stable alert identifier (see

      invalid reference 
      AlertId
      ), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

      Parameters:
      alertId - The stable alert identifier (see
      invalid reference 
      AlertId
      ), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Alert.Builder description(String description)

      An optional description of the alert.

      Parameters:
      description - An optional description of the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountId

      Alert.Builder accountId(String accountId)

      The AWS account ID that owns the alert.

      Parameters:
      accountId - The AWS account ID that owns the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spaceId

      Alert.Builder spaceId(String spaceId)

      The ID of the space the alert belongs to.

      Parameters:
      spaceId - The ID of the space the alert belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profileId

      Alert.Builder profileId(String profileId)

      The ID of the access profile associated with the alert.

      Parameters:
      profileId - The ID of the access profile associated with the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rule

      Alert.Builder rule(Rule rule)

      The rule that defines how the alert is evaluated.

      Parameters:
      rule - The rule that defines how the alert is evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rule

      default Alert.Builder rule(Consumer<Rule.Builder> rule)

      The rule that defines how the alert is evaluated.

      This is a convenience method that creates an instance of the Rule.Builder avoiding the need to create one manually via Rule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rule(Rule).

      Parameters:
      rule - a consumer that will call methods on Rule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationStatus

      Alert.Builder notificationStatus(String notificationStatus)

      Whether notifications are enabled.

      Parameters:
      notificationStatus - Whether notifications are enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationStatus

      Alert.Builder notificationStatus(NotificationStatus notificationStatus)

      Whether notifications are enabled.

      Parameters:
      notificationStatus - Whether notifications are enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Alert.Builder state(AlertStateInfo state)

      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.

      Parameters:
      state - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      default Alert.Builder state(Consumer<AlertStateInfo.Builder> state)

      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.

      This is a convenience method that creates an instance of the AlertStateInfo.Builder avoiding the need to create one manually via AlertStateInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(AlertStateInfo).

      Parameters:
      state - a consumer that will call methods on AlertStateInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationRules

      Alert.Builder notificationRules(Collection<NotificationRule> notificationRules)

      The notification rules for the alert.

      Parameters:
      notificationRules - The notification rules for the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      Alert.Builder notificationRules(NotificationRule... notificationRules)

      The notification rules for the alert.

      Parameters:
      notificationRules - The notification rules for the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      Alert.Builder notificationRules(Consumer<NotificationRule.Builder>... notificationRules)

      The notification rules for the alert.

      This is a convenience method that creates an instance of the NotificationRule.Builder avoiding the need to create one manually via NotificationRule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationRules(List<NotificationRule>).

      Parameters:
      notificationRules - a consumer that will call methods on NotificationRule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Alert.Builder createdAt(Instant createdAt)

      The timestamp when the alert was created.

      Parameters:
      createdAt - The timestamp when the alert was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Alert.Builder updatedAt(Instant updatedAt)

      The timestamp when the alert was last updated.

      Parameters:
      updatedAt - The timestamp when the alert was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alertArn

      Alert.Builder alertArn(String alertArn)

      The Amazon Resource Name (ARN) of the alert.

      Parameters:
      alertArn - The Amazon Resource Name (ARN) of the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.