Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
msambol committed Nov 3, 2024
1 parent 7fa8735 commit f0e0064
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions packages/@aws-cdk/aws-pipes-alpha/lib/logs.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import { IDeliveryStream } from '@aws-cdk/aws-kinesisfirehose-alpha';
import { IRole } from 'aws-cdk-lib/aws-iam';
import { ILogGroup } from 'aws-cdk-lib/aws-logs';
Expand Down Expand Up @@ -47,15 +46,16 @@ export enum LogLevel {
*/
export enum S3OutputFormat {
/**
* PLAIN
* Plain text
*/
PLAIN = 'plain',
/**
* JSON
*/
JSON = 'json',
/**
* W3C
* W3C extended log File format
* @see https://www.w3.org/TR/WD-logfile
*/
W3C = 'w3c',
}
Expand All @@ -65,7 +65,10 @@ export enum S3OutputFormat {
*/
export interface S3LogDestinationProps {
/**
* The name of the S3 bucket to deliver the log records for the pipe.
* The S3 bucket to deliver the log records for the pipe.
*
* The bucket can be in the same or a different AWS Account. If the bucket is in
* a different acccount, the bucket policy must allow access to the Pipes role.
*
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-bucketname
*/
Expand Down

0 comments on commit f0e0064

Please sign in to comment.