Official `aws-lite` plugin for CloudWatch Logs
npm install @aws-lite/cloudwatch-logs@aws-lite/cloudwatch-logs> Official aws-lite plugin for CloudWatch Logs
> Maintained by: @architect
``sh`
npm i @aws-lite/cloudwatch-logs
Optionally install types:
`sh`
npm i -D @aws-lite/cloudwatch-logs-types
Reference documentation with examples at aws-lite.org
Reference documentation with examples at aws-lite.org
Properties:
- logGroupName (string) [required]
- Name of the log group
Properties:
- logGroupName (string) [required]
- Name of the log group
- logStreamName (string) [required]
- Name of the log stream
Properties:
- accountIdentifiers (array)
- List of accounts to search when includeLinkedAccounts is truelogGroupNamePrefix
- (string)logGroupNamePattern
- Prefix to match
- (string)nextToken
- Case-sensitive substring to match
- (string)NextToken
- Pagination cursor token to be used if was returned in a previous responselimit
- (number)includeLinkedAccounts
- Maximum number of items to evaluate and return
- (boolean)accountIdentifiers
- Return log groups in the accounts enumerated by logGroupClass
- (string)STANDARD
- Log group class setting: (supports all CloudWatch Logs features), or INFREQUENT_ACCESS (feature subset with lower costs)paginate
- More details (AWS)
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- descending (boolean)
- Return results in descending order (if true)limit
- (number)logGroupIdentifier
- Maximum number of items to evaluate and return
- (string)logGroupName
- Name or ARN of the log group
- (string)logStreamNamePrefix
- Name of the log group
- (string)nextToken
- Prefix to match
- (string)NextToken
- Pagination cursor token to be used if was returned in a previous responseorderBy
- (string)LogStreamName
- Order results by log stream name () or event time (LastEventTime)paginate
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
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 responsestartFromHead
- (boolean)true
- Return earliest log events first ()startTime
- (number)unmask
- Start of the time range in epoch milliseconds
- (boolean)true
- Display log event fields with all sensitive data unmasked and visible ()paginate
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- queryId (string)
- The ID of the query
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)logGroupNames
- Name of the log group
- (array)StartQuery
- List of log groups to query. requires exactly one of logGroupName, logGroupNames or logGroupIdentifiers.query
- (string)startTime
- The query string to use
- (number)
- Start of the time range in epoch seconds
> Please help out by opening a PR!
- AssociateKmsKey
- CancelExportTask
- CreateDelivery
- CreateExportTask
- CreateLogAnomalyDetector
- CreateLogGroup
- CreateLogStream
- DeleteAccountPolicy
- DeleteDataProtectionPolicy
- DeleteDelivery
- DeleteDeliveryDestination
- DeleteDeliveryDestinationPolicy
- DeleteDeliverySource
- DeleteDestination
- DeleteLogAnomalyDetector
- 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
- More information about the aws-lite plugin API
- Learn about contributing to this and other aws-lite` plugins