class
Amazonite::CloudWatchLogs::PutQueryDefinitionRequest
- Amazonite::CloudWatchLogs::PutQueryDefinitionRequest
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
cloudwatch_logs/put_query_definition_request.crConstructors
- .new(name : String, query_string : String, query_language : QueryLanguage | Nil = nil, query_definition_id : String | Nil = nil, log_group_names : Array(String) | Nil = nil, client_token : String | Nil = nil, parameters : Array(QueryParameter) | Nil = nil)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#client_token : String | Nil
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
-
#client_token=(client_token : String | Nil)
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
-
#hash(hasher)
See
Object#hash(hasher) -
#log_group_names : Array(String) | Nil
Use this parameter to include specific log groups as part of your query definition.
-
#log_group_names=(log_group_names : Array(String) | Nil)
Use this parameter to include specific log groups as part of your query definition.
-
#name : String
A name for the query definition.
-
#name=(name : String)
A name for the query definition.
-
#parameters : Array(QueryParameter) | Nil
Use this parameter to include specific query parameters as part of your query definition.
-
#parameters=(parameters : Array(QueryParameter) | Nil)
Use this parameter to include specific query parameters as part of your query definition.
-
#query_definition_id : String | Nil
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
-
#query_definition_id=(query_definition_id : String | Nil)
If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update.
-
#query_language : QueryLanguage | Nil
Specify the query language to use for this query.
-
#query_language=(query_language : QueryLanguage | Nil)
Specify the query language to use for this query.
-
#query_string : String
The query string to use for this definition.
-
#query_string=(query_string : String)
The query string to use for this definition.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.
Use this parameter to include specific log groups as part of your query definition. If your
query uses the OpenSearch Service query language, you specify the log group names inside the
querystring instead of here.
If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.
Use this parameter to include specific log groups as part of your query definition. If your
query uses the OpenSearch Service query language, you specify the log group names inside the
querystring instead of here.
If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated definition will contain no log groups.
A name for the query definition. If you are saving numerous query definitions, we recommend that
you name them. This way, you can find the ones you want by using the first part of the name as a
filter in the queryDefinitionNamePrefix parameter of
DescribeQueryDefinitions.
A name for the query definition. If you are saving numerous query definitions, we recommend that
you name them. This way, you can find the ones you want by using the first part of the name as a
filter in the queryDefinitionNamePrefix parameter of
DescribeQueryDefinitions.
Use this parameter to include specific query parameters as part of your query definition. Query
parameters are supported only for Logs Insights QL queries. Query parameters allow you to use
placeholder variables in your query string that are substituted with values at execution time.
Use the {{parameterName}} syntax in your query string to reference a parameter.
Use this parameter to include specific query parameters as part of your query definition. Query
parameters are supported only for Logs Insights QL queries. Query parameters allow you to use
placeholder variables in your query string that are substituted with values at execution time.
Use the {{parameterName}} syntax in your query string to reference a parameter.
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.
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.
Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.