Interface CreateAlertRequest.Builder

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

  • Method Details

    • spaceId

      CreateAlertRequest.Builder spaceId(String spaceId)

      The unique ID of the space to create the alert in.

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

    • profileId

      CreateAlertRequest.Builder profileId(String profileId)

      The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.

      Parameters:
      profileId - The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateAlertRequest.Builder name(String name)

      Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the

      invalid reference 
      AlertId
      , so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.

      Parameters:
      name - Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the
      invalid reference 
      AlertId
      , so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateAlertRequest.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.

    • rule

      CreateAlertRequest.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 CreateAlertRequest.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:

    • notificationsEnabled

      CreateAlertRequest.Builder notificationsEnabled(Boolean notificationsEnabled)

      Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.

      Parameters:
      notificationsEnabled - Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAlertRequest.Builder tags(Map<String,String> tags)

      The tags to associate with the alert.

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

    • notificationRules

      CreateAlertRequest.Builder notificationRules(Collection<NotificationRule> notificationRules)

      The notification rules that determine when and where notifications are sent.

      Parameters:
      notificationRules - The notification rules that determine when and where notifications are sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

      CreateAlertRequest.Builder notificationRules(NotificationRule... notificationRules)

      The notification rules that determine when and where notifications are sent.

      Parameters:
      notificationRules - The notification rules that determine when and where notifications are sent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationRules

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

      The notification rules that determine when and where notifications are sent.

      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:

    • clientToken

      CreateAlertRequest.Builder clientToken(String clientToken)

      Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.

      Parameters:
      clientToken - Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateAlertRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAlertRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.