Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface CreateScheduledQueryRequest.Builder

    • Method Detail

      • name

        CreateScheduledQueryRequest.Builder name​(String name)

        The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.

        Parameters:
        name - The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateScheduledQueryRequest.Builder description​(String description)

        An optional description for the scheduled query to help identify its purpose and functionality.

        Parameters:
        description - An optional description for the scheduled query to help identify its purpose and functionality.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryLanguage

        CreateScheduledQueryRequest.Builder queryLanguage​(String queryLanguage)

        The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.

        Parameters:
        queryLanguage - The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryLanguage, QueryLanguage

      • queryLanguage

        CreateScheduledQueryRequest.Builder queryLanguage​(QueryLanguage queryLanguage)

        The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.

        Parameters:
        queryLanguage - The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryLanguage, QueryLanguage

      • queryString

        CreateScheduledQueryRequest.Builder queryString​(String queryString)

        The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.

        Parameters:
        queryString - The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logGroupIdentifiers

        CreateScheduledQueryRequest.Builder logGroupIdentifiers​(Collection<String> logGroupIdentifiers)

        An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.

        Parameters:
        logGroupIdentifiers - An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logGroupIdentifiers

        CreateScheduledQueryRequest.Builder logGroupIdentifiers​(String... logGroupIdentifiers)

        An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.

        Parameters:
        logGroupIdentifiers - An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleExpression

        CreateScheduledQueryRequest.Builder scheduleExpression​(String scheduleExpression)

        A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.

        Parameters:
        scheduleExpression - A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timezone

        CreateScheduledQueryRequest.Builder timezone​(String timezone)

        The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.

        Parameters:
        timezone - The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTimeOffset

        CreateScheduledQueryRequest.Builder startTimeOffset​(Long startTimeOffset)

        The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.

        Parameters:
        startTimeOffset - The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationConfiguration

        CreateScheduledQueryRequest.Builder destinationConfiguration​(DestinationConfiguration destinationConfiguration)

        Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.

        Parameters:
        destinationConfiguration - Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleStartTime

        CreateScheduledQueryRequest.Builder scheduleStartTime​(Long scheduleStartTime)

        The start time for the scheduled query in Unix epoch format. The query will not execute before this time.

        Parameters:
        scheduleStartTime - The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleEndTime

        CreateScheduledQueryRequest.Builder scheduleEndTime​(Long scheduleEndTime)

        The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.

        Parameters:
        scheduleEndTime - The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionRoleArn

        CreateScheduledQueryRequest.Builder executionRoleArn​(String executionRoleArn)

        The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.

        Parameters:
        executionRoleArn - The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        CreateScheduledQueryRequest.Builder state​(String state)

        The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.

        Parameters:
        state - The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ScheduledQueryState, ScheduledQueryState

      • tags

        CreateScheduledQueryRequest.Builder tags​(Map<String,​String> tags)

        Key-value pairs to associate with the scheduled query for resource management and cost allocation.

        Parameters:
        tags - Key-value pairs to associate with the scheduled query for resource management and cost allocation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.