class
Amazonite::CloudWatchLogs::CreateScheduledQueryRequest
- Amazonite::CloudWatchLogs::CreateScheduledQueryRequest
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
cloudwatch_logs/create_scheduled_query_request.crConstructors
- .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)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#description : String | Nil
An optional description for the scheduled query to help identify its purpose and functionality.
-
#description=(description : String | Nil)
An optional description for the scheduled query to help identify its purpose and functionality.
-
#destination_configuration : DestinationConfiguration | Nil
Configuration for where to deliver query results.
-
#destination_configuration=(destination_configuration : DestinationConfiguration | Nil)
Configuration for where to deliver query results.
-
#end_time_offset : Int64 | Nil
The time offset in seconds that defines the end of the lookback period for the query.
-
#end_time_offset=(end_time_offset : Int64 | Nil)
The time offset in seconds that defines the end of the lookback period for the query.
-
#execution_role_arn : String
The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination.
-
#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.
-
#hash(hasher)
See
Object#hash(hasher) -
#log_group_identifiers : Array(String) | Nil
An array of log group names or ARNs to query.
-
#log_group_identifiers=(log_group_identifiers : Array(String) | Nil)
An array of log group names or ARNs to query.
-
#name : String
The name of the scheduled query.
-
#name=(name : String)
The name of the scheduled query.
-
#query_language : QueryLanguage
The query language to use for the scheduled query.
-
#query_language=(query_language : QueryLanguage)
The query language to use for the scheduled query.
-
#query_string : String
The query string to execute.
-
#query_string=(query_string : String)
The query string to execute.
-
#schedule_end_time : Int64 | Nil
The end time for the scheduled query in Unix epoch format.
-
#schedule_end_time=(schedule_end_time : Int64 | Nil)
The end time for the scheduled query in Unix epoch format.
-
#schedule_expression : String
A cron expression that defines when the scheduled query runs.
-
#schedule_expression=(schedule_expression : String)
A cron expression that defines when the scheduled query runs.
-
#schedule_start_time : Int64 | Nil
The start time for the scheduled query in Unix epoch format.
-
#schedule_start_time=(schedule_start_time : Int64 | Nil)
The start time for the scheduled query in Unix epoch format.
-
#start_time_offset : Int64 | Nil
The time offset in seconds that defines the lookback period for the query.
-
#start_time_offset=(start_time_offset : Int64 | Nil)
The time offset in seconds that defines the lookback period for the query.
-
#state : ScheduledQueryState | Nil
The initial state of the scheduled query.
-
#state=(state : ScheduledQueryState | Nil)
The initial state of the scheduled query.
-
#tags : Hash(String, String) | Nil
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
-
#tags=(tags : Hash(String, String) | Nil)
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
-
#timezone : String | Nil
The timezone for evaluating the schedule expression.
-
#timezone=(timezone : String | Nil)
The timezone for evaluating the schedule expression.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
An optional description for the scheduled query to help identify its purpose and functionality.
An optional description for the scheduled query to help identify its purpose and functionality.
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.
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.
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.
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.
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.
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.
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.
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.
The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters.
The name of the scheduled query. The name must be unique within your account and region. Length must be between 1 and 300 characters.
The query language to use for the scheduled query. Valid values are CWLI, PPL, and SQL.
The query language to use for the scheduled query. Valid values are CWLI, PPL, and SQL.
The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
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.
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.
The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
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.
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.
The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is
ENABLED.
The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is
ENABLED.
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.