class Amazonite::CloudWatchLogs::CreateScheduledQueryRequest

Included Modules

Defined in:

cloudwatch_logs/create_scheduled_query_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(name : String, query_language : QueryLanguage, query_string : String, schedule_expression : String, execution_role_arn : String, description : String | Nil = nil, log_group_identifiers : Array(String) | Nil = nil, timezone : String | Nil = nil, start_time_offset : Int64 | Nil = nil, end_time_offset : Int64 | Nil = nil, destination_configuration : DestinationConfiguration | Nil = nil, schedule_start_time : Int64 | Nil = nil, schedule_end_time : Int64 | Nil = nil, state : ScheduledQueryState | Nil = nil, tags : Hash(String, String) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def description : String | Nil #

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


[View source]
def description=(description : String | Nil) #

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


[View source]
def destination_configuration : DestinationConfiguration | Nil #

Configuration for where to deliver query results. Supports Amazon S3 destinations for storing query output and lookup table destinations for automatically refreshing lookup tables with query results. You can configure one or both destination types.


[View source]
def destination_configuration=(destination_configuration : DestinationConfiguration | Nil) #

Configuration for where to deliver query results. Supports Amazon S3 destinations for storing query output and lookup table destinations for automatically refreshing lookup tables with query results. You can configure one or both destination types.


[View source]
def end_time_offset : Int64 | Nil #

The time offset in seconds that defines the end of the lookback period for the query. Together with startTimeOffset, this determines the time window relative to the execution time over which the query runs.


[View source]
def end_time_offset=(end_time_offset : Int64 | Nil) #

The time offset in seconds that defines the end of the lookback period for the query. Together with startTimeOffset, this determines the time window relative to the execution time over which the query runs.


[View source]
def execution_role_arn : String #

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.


[View source]
def execution_role_arn=(execution_role_arn : String) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def log_group_identifiers : Array(String) | Nil #

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.


[View source]
def log_group_identifiers=(log_group_identifiers : Array(String) | Nil) #

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.


[View source]
def name : String #

The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters.


[View source]
def name=(name : String) #

The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters.


[View source]
def query_language : QueryLanguage #

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


[View source]
def query_language=(query_language : QueryLanguage) #

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


[View source]
def query_string : String #

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


[View source]
def query_string=(query_string : String) #

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


[View source]
def schedule_end_time : Int64 | Nil #

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


[View source]
def schedule_end_time=(schedule_end_time : Int64 | Nil) #

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


[View source]
def schedule_expression : String #

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.


[View source]
def schedule_expression=(schedule_expression : String) #

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.


[View source]
def schedule_start_time : Int64 | Nil #

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


[View source]
def schedule_start_time=(schedule_start_time : Int64 | Nil) #

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


[View source]
def start_time_offset : Int64 | Nil #

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.


[View source]
def start_time_offset=(start_time_offset : Int64 | Nil) #

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.


[View source]
def state : ScheduledQueryState | Nil #

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


[View source]
def state=(state : ScheduledQueryState | Nil) #

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


[View source]
def tags : Hash(String, String) | Nil #

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


[View source]
def tags=(tags : Hash(String, String) | Nil) #

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


[View source]
def timezone : String | Nil #

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


[View source]
def timezone=(timezone : String | Nil) #

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


[View source]
def validate! : Nil #

[View source]