You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudWatchLogs::Types::PutQueryDefinitionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchLogs::Types::PutQueryDefinitionRequest
- Defined in:
- (unknown)
Overview
When passing PutQueryDefinitionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "QueryDefinitionName", # required
query_definition_id: "QueryId",
log_group_names: ["LogGroupName"],
query_string: "QueryDefinitionString", # required
}
Instance Attribute Summary collapse
-
#log_group_names ⇒ Array<String>
Use this parameter to include specific log groups as part of your query definition.
-
#name ⇒ String
A name for the query definition.
-
#query_definition_id ⇒ String
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
-
#query_string ⇒ String
The query string to use for this definition.
Instance Attribute Details
#log_group_names ⇒ Array<String>
Use this parameter to include specific log groups as part of your query definition.
If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.
#name ⇒ String
A name for the query definition. If you are saving a lot of query
definitions, we recommend that you name them so that you can easily find
the ones you want by using the first part of the name as a filter in the
queryDefinitionNamePrefix
parameter of DescribeQueryDefinitions.
#query_definition_id ⇒ String
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
#query_string ⇒ String
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.