class Aws::CloudWatchLogs::Types::PutQueryDefinitionRequest
@note When making an API call, you may pass PutQueryDefinitionRequest
data as a hash: { name: "QueryDefinitionName", # required query_definition_id: "QueryId", log_group_names: ["LogGroupName"], query_string: "QueryDefinitionString", # required }
@!attribute [rw] name
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][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html @return [String]
@!attribute [rw] query_definition_id
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][1] 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. [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html @return [String]
@!attribute [rw] log_group_names
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. @return [Array<String>]
@!attribute [rw] query_string
The query string to use for this definition. For more information, see [CloudWatch Logs Insights Query Syntax][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinitionRequest AWS API Documentation
Constants
- SENSITIVE