Class: Aws::CloudWatchLogs::Types::DescribeLogGroupsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::DescribeLogGroupsRequest

Defined in:

gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_identifiers ⇒ Array<String>

  When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search.

• #include_linked_accounts ⇒ Boolean

  If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

• #limit ⇒ Integer

  The maximum number of items returned.

• #log_group_class ⇒ String

  Specifies the log group class for this log group.

• #log_group_name_pattern ⇒ String

  If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search.

• #log_group_name_prefix ⇒ String

  The prefix to match.

• #next_token ⇒ String

  The token for the next set of items to return.

Instance Attribute Details

#account_identifiers ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#include_linked_accounts ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_class ⇒ String

Specifies the log group class for this log group. There are two classes:

• The Standard log class supports all CloudWatch Logs features.

• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name_pattern ⇒ String

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name_prefix ⇒ String

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1446

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class)
  SENSITIVE = []
  include Aws::Structure
end