@aws-lite/cloudwatch-logs

@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, string)
  • 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, string)
  • 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, string)
  • Enable automatic result pagination; use this instead of making your own individual pagination requests

GetQueryResults

Canonical AWS API doc

Properties:

• queryId (string)
  • The ID of the query

StartQuery

Canonical AWS API doc

Properties:

• endTime (number)
  • End of the time range in epoch seconds
• limit (number)
  • Maximum number of items to evaluate and return
• logGroupIdentifiers (array)
  • List of log groups to query. StartQuery requires exactly one of logGroupName, logGroupNames or logGroupIdentifiers.
• logGroupName (string)
  • Name of the log group
• logGroupNames (array)
  • List of log groups to query. StartQuery requires exactly one of logGroupName, logGroupNames or logGroupIdentifiers.
• query (string)
  • The query string to use
• startTime (number)
  • Start of the time range in epoch seconds

Methods yet to be implemented

Please help out by opening a PR!

• AssociateKmsKey
• CancelExportTask
• CreateDelivery
• CreateExportTask
• CreateLogAnomalyDetector
• CreateLogGroup
• CreateLogStream
• DeleteAccountPolicy
• DeleteDataProtectionPolicy
• DeleteDelivery
• DeleteDeliveryDestination
• DeleteDeliveryDestinationPolicy
• DeleteDeliverySource
• DeleteDestination
• DeleteLogAnomalyDetector
• DeleteLogStream
• DeleteMetricFilter
• DeleteQueryDefinition
• DeleteResourcePolicy
• DeleteRetentionPolicy
• DeleteSubscriptionFilter
• DescribeAccountPolicies
• DescribeDeliveries
• DescribeDeliveryDestinations
• DescribeDeliverySources
• DescribeDestinations
• DescribeExportTasks
• DescribeMetricFilters
• DescribeQueries
• DescribeQueryDefinitions
• DescribeResourcePolicies
• DescribeSubscriptionFilters
• DisassociateKmsKey
• FilterLogEvents
• GetDataProtectionPolicy
• GetDelivery
• GetDeliveryDestination
• GetDeliveryDestinationPolicy
• GetDeliverySource
• GetLogAnomalyDetector
• GetLogGroupFields
• GetLogRecord
• ListAnomalies
• ListLogAnomalyDetectors
• ListTagsForResource
• ListTagsLogGroup
• PutAccountPolicy
• PutDataProtectionPolicy
• PutDeliveryDestination
• PutDeliveryDestinationPolicy
• PutDeliverySource
• PutDestination
• PutDestinationPolicy
• PutLogEvents
• PutMetricFilter
• PutQueryDefinition
• PutResourcePolicy
• PutRetentionPolicy
• PutSubscriptionFilter
• StartLiveTail
• StopQuery
• TagLogGroup
• TagResource
• TestMetricFilter
• UntagLogGroup
• UntagResource
• UpdateAnomaly
• UpdateLogAnomalyDetector

Learn more

• More information about the aws-lite plugin API
• Learn about contributing to this and other aws-lite plugins