Interface ScheduledQueryConfiguration.Builder

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

  • Method Details

    • queryString

      ScheduledQueryConfiguration.Builder queryString(String queryString)

      The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.

      Parameters:
      queryString - The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      ScheduledQueryConfiguration.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.

      Parameters:
      logGroupIdentifiers - The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      ScheduledQueryConfiguration.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.

      Parameters:
      logGroupIdentifiers - The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryARN

      ScheduledQueryConfiguration.Builder queryARN(String queryARN)

      The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.

      Parameters:
      queryARN - The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledQueryRoleARN

      ScheduledQueryConfiguration.Builder scheduledQueryRoleARN(String scheduledQueryRoleARN)

      The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.

      Parameters:
      scheduledQueryRoleARN - The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfiguration

      ScheduledQueryConfiguration.Builder scheduleConfiguration(ScheduleConfiguration scheduleConfiguration)

      The schedule and time-range offset configuration for the underlying scheduled query.

      Parameters:
      scheduleConfiguration - The schedule and time-range offset configuration for the underlying scheduled query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleConfiguration

      default ScheduledQueryConfiguration.Builder scheduleConfiguration(Consumer<ScheduleConfiguration.Builder> scheduleConfiguration)

      The schedule and time-range offset configuration for the underlying scheduled query.

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

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

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

    • aggregationExpression

      ScheduledQueryConfiguration.Builder aggregationExpression(String aggregationExpression)

      The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.

      Parameters:
      aggregationExpression - The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ScheduledQueryConfiguration.Builder tags(Collection<Tag> tags)

      A list of key-value pairs to associate with the underlying scheduled query resource.

      Parameters:
      tags - A list of key-value pairs to associate with the underlying scheduled query resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ScheduledQueryConfiguration.Builder tags(Tag... tags)

      A list of key-value pairs to associate with the underlying scheduled query resource.

      Parameters:
      tags - A list of key-value pairs to associate with the underlying scheduled query resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ScheduledQueryConfiguration.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs to associate with the underlying scheduled query resource.

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

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

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