0.0.4 • Published 3 months ago

@aws-lite/cloudwatch-logs v0.0.4

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

@aws-lite/cloudwatch-logs

Official aws-lite plugin for CloudWatch Logs

Maintained by: @architect

Install

npm i @aws-lite/cloudwatch-logs

Optionally install types:

npm i -D @aws-lite/cloudwatch-logs-types

Reference

Reference documentation with examples at aws-lite.org

Reference

Reference documentation with examples at aws-lite.org

Methods

DeleteLogGroup

Canonical AWS API doc

Properties:

  • logGroupName (string) required
    • Name of the log group

DescribeLogGroups

Canonical AWS API doc

Properties:

  • accountIdentifiers (array)
    • List of accounts to search when includeLinkedAccounts is true
  • logGroupNamePrefix (string)
    • Prefix to match
  • logGroupNamePattern (string)
    • Case-sensitive substring to match
  • nextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • limit (number)
    • Maximum number of items to evaluate and return
  • includeLinkedAccounts (boolean)
    • Return log groups in the accounts enumerated by accountIdentifiers
  • logGroupClass (string)
    • Log group class setting: STANDARD (supports all CloudWatch Logs features), or INFREQUENT_ACCESS (feature subset with lower costs)
    • More details (AWS)
  • paginate (boolean)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

DescribeLogStreams

Canonical AWS API doc

Properties:

  • descending (boolean)
    • Return results in descending order (if true)
  • limit (number)
    • Maximum number of items to evaluate and return
  • logGroupIdentifier (string)
    • Name or ARN of the log group
  • logGroupName (string)
    • Name of the log group
  • logStreamNamePrefix (string)
    • Prefix to match
  • nextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • orderBy (string)
    • Order results by log stream name (LogStreamName) or event time (LastEventTime)
  • paginate (boolean)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

GetLogEvents

Canonical AWS API doc

Properties:

  • endTime (number)
    • End of the time range in epoch milliseconds
  • limit (number)
    • Maximum number of items to evaluate and return
  • logGroupIdentifier (string)
    • Name or ARN of the log group
  • logGroupName (string)
    • Name of the log group
  • logStreamName (string) required
    • Name of the log stream
  • nextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • startFromHead (boolean)
    • Return earliest log events first (true)
  • startTime (number)
    • Start of the time range in epoch milliseconds
  • unmask (boolean)
    • Display log event fields with all sensitive data unmasked and visible (true)
  • paginate (boolean)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

Methods yet to be implemented

Please help out by opening a PR!

Learn more

0.0.4

3 months ago

0.0.3

4 months ago

0.0.2

4 months ago

0.0.1

5 months ago

0.0.0

5 months ago