@aws-lite/cloudwatch-logs

Official `aws-lite` plugin for CloudWatch Logs

0.0.0
Source
npm

Version published: last year

Weekly downloads: 1.5K; increased by31.02%

Maintainers: 3

Weekly downloads

Created: last year

Source

`@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) [required]
- 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

FAQs

What is @aws-lite/cloudwatch-logs?

Is @aws-lite/cloudwatch-logs popular?

Is @aws-lite/cloudwatch-logs well maintained?

Package last updated on 24 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install