From 166f9eab7aaeb3072d7ec8ec0b30a556393471f6 Mon Sep 17 00:00:00 2001 From: wulfmann Date: Thu, 12 Nov 2020 16:11:24 +0000 Subject: [PATCH] update readme --- packages/@aws-cdk/aws-codebuild/README.md | 32 +++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/packages/@aws-cdk/aws-codebuild/README.md b/packages/@aws-cdk/aws-codebuild/README.md index c51b263279e34..2103b28d7ba0f 100644 --- a/packages/@aws-cdk/aws-codebuild/README.md +++ b/packages/@aws-cdk/aws-codebuild/README.md @@ -305,6 +305,38 @@ new codebuild.Project(this, 'Project', { }) ``` +## Logs + +CodeBuild lets you specify an S3 Bucket, CloudWatch Log Group or both to receive logs from your projects. + +By default, logs will go to cloudwatch. + +### CloudWatch Logs Example + +```typescript +new codebuild.Project(this, 'Project', { + logsConfig: { + cloudwatch: { + logGroup: new cloudwatch.LogGroup(this, `MyLogGroup`), + } + }, + ... +}) +``` + +### S3 Logs Example + +```typescript +new codebuild.Project(this, 'Project', { + logsConfig: { + s3: { + bucket: new s3.Bucket(this, `LogBucket`) + } + }, + ... +}) +``` + ## Credentials CodeBuild allows you to store credentials used when communicating with various sources,