AWS

The AWS Log Method allows you to send logs to AWS CloudWatch. This Log Method uses the general New-PodeLogApiMethod under-the-hood.

Creation

To create a new AWS Log Method use New-PodeLogAwsMethod, and supply the -LogGroupName, -LogStreamName, and -Region parameters. You'll also need to supply a Bearer -Token for authentication.

If you wish to ignore any certificate checks, you may supply -SkipCertificateCheck.

Source Type

The default source type sent by Pode is empty, allowing AWS to automatically select the best fit. However, if you wish to supply an explicit source type you can do so via the -SourceType parameter.

Source

The default source for your logs sent by Pode is the Server's App Name. If you wish to supply an explicit source different from the server's, then you can do so via the -Source parameter.

Index

The default index supplied by Pode is empty, which usually equates to the main index in AWS. However, if you wish to supply an explicit index you can do so via the -Index parameter.

Override

You can use New-PodeLogAwsOverride to override certain properties of the AWS Log Method, when calling either Write-PodeErrorLog or Write-PodeLog.

You can override the -Source, -SourceType, and -Index, as well as specify -Ignore, which allows you to specify that certain log items will not be logged to AWS.

If you don't specify an -Id then the override will apply to all AWS Log Methods configured for a Log Type.

# override the Index when logging to AWS
$_ | Write-PodeErrorLog -Override @(
    New-PodeLogAwsOverride -Index 'custom_index'
)

# if you have an error log method configured with AWS and terminal logging,
# the below will only log the error to the terminal and ignore logging to AWS
$_ | Write-PodeErrorLog -Override @(
    New-PodeLogAwsOverride -Ignore
)

Examples

Send Request Logs

The following example will send Request logs to AWS CloudWatch.

$method = New-PodeLogAwsMethod `
    -LogGroupName 'my-log-group' `
    -LogStreamName 'my-log-stream' `
    -Region 'us-east-1' `
    -Token '<token>'

$method | Enable-PodeLogRequestType

Send Error Logs

The following example will send JSON serialised Error logs to Aws CloudWatch.

$method = New-PodeLogAwsMethod `
    -LogGroupName 'my-log-group' `
    -LogStreamName 'my-log-stream' `
    -Region 'us-east-1' `
    -Token '<token>'

$method | Enable-PodeLogErrorType -SerialiseFormat Json