Interface DescribeLogGroupsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<DescribeLogGroupsRequest.Builder,DescribeLogGroupsRequest>, SdkBuilder<DescribeLogGroupsRequest.Builder,DescribeLogGroupsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeLogGroupsRequest
@Mutable @NotThreadSafe public static interface DescribeLogGroupsRequest.Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<DescribeLogGroupsRequest.Builder,DescribeLogGroupsRequest>

  • Method Details

    • accountIdentifiers

      DescribeLogGroupsRequest.Builder accountIdentifiers(Collection<String> accountIdentifiers)

      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.

      Parameters:
      accountIdentifiers - 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:
      Returns a reference to this object so that method calls can be chained together.

    • accountIdentifiers

      DescribeLogGroupsRequest.Builder accountIdentifiers(String... accountIdentifiers)

      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.

      Parameters:
      accountIdentifiers - 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:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupNamePrefix

      DescribeLogGroupsRequest.Builder logGroupNamePrefix(String logGroupNamePrefix)

      The prefix to match.

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

      Parameters:
      logGroupNamePrefix - The prefix to match.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupNamePattern

      DescribeLogGroupsRequest.Builder logGroupNamePattern(String logGroupNamePattern)

      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 DataLogs, log groups named DataLogs, aws/DataLogs, and GroupDataLogs would match, but datalogs, Data/log/s and Groupdata 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.

      Parameters:
      logGroupNamePattern - 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 DataLogs, log groups named DataLogs, aws/DataLogs, and GroupDataLogs would match, but datalogs, Data/log/s and Groupdata 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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeLogGroupsRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - The token for the next set of items to return. (You received this token from a previous call.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      DescribeLogGroupsRequest.Builder limit(Integer limit)

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

      Parameters:
      limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeLinkedAccounts

      DescribeLogGroupsRequest.Builder includeLinkedAccounts(Boolean includeLinkedAccounts)

      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.

      Parameters:
      includeLinkedAccounts - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupClass

      DescribeLogGroupsRequest.Builder logGroupClass(String logGroupClass)

      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.

      Specifies the log group class for this log group. There are three 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.

      • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

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

      Parameters:
      logGroupClass - 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.

      Specifies the log group class for this log group. There are three 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.

      • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logGroupClass

      DescribeLogGroupsRequest.Builder logGroupClass(LogGroupClass logGroupClass)

      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.

      Specifies the log group class for this log group. There are three 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.

      • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

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

      Parameters:
      logGroupClass - 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.

      Specifies the log group class for this log group. There are three 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.

      • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logGroupIdentifiers

      DescribeLogGroupsRequest.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

      If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

      Parameters:
      logGroupIdentifiers - Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

      If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      DescribeLogGroupsRequest.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

      If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

      Parameters:
      logGroupIdentifiers - Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

      If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeLogGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeLogGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.