class
Amazonite::CloudWatchLogs::ListLogGroupsRequest
- Amazonite::CloudWatchLogs::ListLogGroupsRequest
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
cloudwatch_logs/list_log_groups_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(log_group_name_pattern : String | Nil = nil, log_group_class : LogGroupClass | Nil = nil, include_linked_accounts : Bool | Nil = nil, account_identifiers : Array(String) | Nil = nil, next_token : String | Nil = nil, limit : Int32 | Nil = nil, data_sources : Array(DataSourceFilter) | Nil = nil, field_index_names : Array(String) | Nil = nil, log_group_tags : Array(TagFilter) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#account_identifiers : Array(String) | Nil
When
includeLinkedAccountsis set totrue, use this parameter to specify the list of accounts to search. -
#account_identifiers=(account_identifiers : Array(String) | Nil)
When
includeLinkedAccountsis set totrue, use this parameter to specify the list of accounts to search. -
#data_sources : Array(DataSourceFilter) | Nil
An array of data source filters to filter log groups by their associated data sources.
-
#data_sources=(data_sources : Array(DataSourceFilter) | Nil)
An array of data source filters to filter log groups by their associated data sources.
-
#field_index_names : Array(String) | Nil
An array of field index names to filter log groups that have specific field indexes.
-
#field_index_names=(field_index_names : Array(String) | Nil)
An array of field index names to filter log groups that have specific field indexes.
-
#hash(hasher)
See
Object#hash(hasher) -
#include_linked_accounts : Bool | Nil
If you are using a monitoring account, set this to
trueto have the operation return log groups in the accounts listed inaccountIdentifiers. -
#include_linked_accounts=(include_linked_accounts : Bool | Nil)
If you are using a monitoring account, set this to
trueto have the operation return log groups in the accounts listed inaccountIdentifiers. -
#limit : Int32 | Nil
The maximum number of log groups to return.
-
#limit=(limit : Int32 | Nil)
The maximum number of log groups to return.
-
#log_group_class : LogGroupClass | Nil
Use this parameter to limit the results to only those log groups in the specified log group class.
-
#log_group_class=(log_group_class : LogGroupClass | Nil)
Use this parameter to limit the results to only those log groups in the specified log group class.
-
#log_group_name_pattern : String | Nil
Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify.
-
#log_group_name_pattern=(log_group_name_pattern : String | Nil)
Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify.
-
#log_group_tags : Array(TagFilter) | Nil
An array of tag filters to return only log groups that have specific tags.
-
#log_group_tags=(log_group_tags : Array(TagFilter) | Nil)
An array of tag filters to return only log groups that have specific tags.
- #next_token : String | Nil
- #next_token=(next_token : String | Nil)
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
When includeLinkedAccounts is set to true, use this parameter to specify the list of
accounts to search. You can specify as many as 20 account IDs in the array.
When includeLinkedAccounts is set to true, use this parameter to specify the list of
accounts to search. You can specify as many as 20 account IDs in the array.
An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.
An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.
An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.
An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.
If you are using a monitoring account, set this to true to have the operation return log
groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation
returns all log groups in the monitoring account and all log groups in all source accounts that
are linked to the monitoring account.
The default for this parameter is false.
If you are using a monitoring account, set this to true to have the operation return log
groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation
returns all log groups in the monitoring account and all log groups in all source accounts that
are linked to the monitoring account.
The default for this parameter is false.
The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.
The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.
Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.
-
Use
^to match log group names by prefix. -
For a substring match, specify the string to match. All matches are case sensitive
-
To match multiple patterns, separate them with a
|as in the example^/aws/lambda|discovery
You can specify as many as five different regular expression patterns in this field, each of
which must be between 3 and 24 characters. You can include the ^ symbol as many as five times,
and include the | symbol as many as four times.
Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.
-
Use
^to match log group names by prefix. -
For a substring match, specify the string to match. All matches are case sensitive
-
To match multiple patterns, separate them with a
|as in the example^/aws/lambda|discovery
You can specify as many as five different regular expression patterns in this field, each of
which must be between 3 and 24 characters. You can include the ^ symbol as many as five times,
and include the | symbol as many as four times.
An array of tag filters to return only log groups that have specific tags. Multiple filters are combined with AND logic.
An array of tag filters to return only log groups that have specific tags. Multiple filters are combined with AND logic.