-
Notifications
You must be signed in to change notification settings - Fork 0
New PodeAwsLoggingMethod
external help file: Pode-help.xml Module Name: Pode online version: PodeType: LoggingMethod schema: 2.0.0
Configures logging to AWS CloudWatch Logs.
New-PodeAwsLoggingMethod -BaseUrl <String> -Region <String> -LogGroupName <String> -LogStreamName <String>
-AuthorizationHeader <String> [-FailureAction <String>] [-SkipCertificateCheck] [-AsUTC]
[-DefaultTag <String>] [-DataFormat <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-PodeAwsLoggingMethod -BaseUrl <String> -Region <String> -LogGroupName <String> -LogStreamName <String>
-AuthorizationHeader <String> [-FailureAction <String>] [-SkipCertificateCheck] [-AsUTC]
[-DefaultTag <String>] [-ISO8601] [-ProgressAction <ActionPreference>] [<CommonParameters>]
The `New-PodeAwsLoggingMethod` function configures a logging method for AWS CloudWatch Logs. It initializes a logging queue and sends log events to AWS CloudWatch using the specified log group and stream names.
New-PodeAwsLoggingMethod -BaseUrl 'https://logs.us-east-1.amazonaws.com' -Region 'us-east-1' -LogGroupName 'MyLogGroup' -LogStreamName 'MyLogStream' -AuthorizationHeader 'AWS4-HMAC-SHA256 ...'
Configures AWS CloudWatch logging with specified log group, log stream, and AWS authorization details.
If present, converts timestamps to UTC.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe AWS authorization header, generated using AWS Signature Version 4.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe base URL for the AWS CloudWatch Logs API, typically `https://logs.\<region>.amazonaws.com`.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe custom date format for log entries. Mutually exclusive with ISO8601.
Type: String
Parameter Sets: DataFormat
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSets a default tag for log entries. Defaults to `-`.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: -
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the action to take if the logging request fails. Valid values are `Ignore`, `Report`, and `Halt`. The default is `Ignore`.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Ignore
Accept pipeline input: False
Accept wildcard characters: FalseIf set, uses the ISO 8601 date format for log entries. Mutually exclusive with DataFormat.
Type: SwitchParameter
Parameter Sets: ISO8601
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the AWS CloudWatch Log Group to send logs to.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the AWS CloudWatch Log Stream within the log group.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe AWS region where the CloudWatch Log Group resides, such as `us-east-1`.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf present, skips SSL certificate validation when sending logs.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
This function sends logs to AWS CloudWatch in batches, using a `ConcurrentQueue` to manage queued logs.
sss
x