feat(pipelines): Add logging options to codeBuildDefaults property

packages/@aws-cdk/pipelines/lib/codepipeline/codebuild-step.ts

@@ -197,6 +197,15 @@ export class CodeBuildStep extends ShellStep {
    */
   readonly timeout?: Duration;
 
+  /**
+   * Information about logs for the build project.
+   *
+   * A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
+   *
+   * @default - no log configuration is set
+   */
+  readonly logging?: codebuild.LoggingOptions;
+
   private _project?: codebuild.IProject;
   private _partialBuildSpec?: codebuild.BuildSpec;
   private readonly exportedVariables = new Set<string>();

packages/@aws-cdk/pipelines/lib/codepipeline/codepipeline.ts

@@ -305,6 +305,15 @@ export interface CodeBuildOptions {
    * @default Duration.hours(1)
    */
   readonly timeout?: Duration;
+
+  /**
+   * Information about logs for the build project.
+   *
+   * A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
+   *
+   * @default - no log configuration is set
+   */
+  readonly logging?: cb.LoggingOptions;
 }
 
 
@@ -807,6 +816,11 @@ export class CodePipeline extends PipelineBase {
         buildImage: cb.LinuxBuildImage.STANDARD_5_0,
         computeType: cb.ComputeType.SMALL,
       },
+      // logging: {
+      //   cloudWatch: {
+      //     enabled: true,
+      //   },
+      // },
     };
 
     const typeBasedCustomizations = {

packages/@aws-cdk/pipelines/lib/codepipeline/private/codebuild-factory.ts

@@ -17,6 +17,7 @@ import { CodeBuildStep } from '../codebuild-step';
 import { CodeBuildOptions } from '../codepipeline';
 import { ICodePipelineActionFactory, ProduceActionOptions, CodePipelineActionFactoryResult } from '../codepipeline-action-factory';
 import { mergeBuildSpecs } from './buildspecs';
+import { mergeLoggings } from './logging';
 
 export interface CodeBuildFactoryProps {
   /**
@@ -162,6 +163,7 @@ export class CodeBuildFactory implements ICodePipelineActionFactory {
         subnetSelection: step.subnetSelection,
         cache: step.cache,
         timeout: step.timeout,
+        logging: step.logging,
       }),
     });
 
@@ -302,6 +304,7 @@ export class CodeBuildFactory implements ICodePipelineActionFactory {
       buildSpec: projectBuildSpec,
       role: this.props.role,
       timeout: projectOptions.timeout,
+      logging: projectOptions.logging,
     });
 
     if (this.props.additionalDependable) {
@@ -429,6 +432,7 @@ export function mergeCodeBuildOptions(...opts: Array<CodeBuildOptions | undefine
       vpc: b.vpc ?? a.vpc,
       subnetSelection: b.subnetSelection ?? a.subnetSelection,
       timeout: b.timeout ?? a.timeout,
+      logging: mergeLoggings(a.logging, b.logging),
       cache: b.cache ?? a.cache,
     };
   }

packages/@aws-cdk/pipelines/lib/codepipeline/private/logging.ts

@@ -0,0 +1,18 @@
+import * as codebuild from '@aws-cdk/aws-codebuild';
+
+export function mergeLoggings(a: codebuild.LoggingOptions, b?: codebuild.LoggingOptions): codebuild.LoggingOptions | undefined;
+export function mergeLoggings(a: codebuild.LoggingOptions | undefined, b: codebuild.LoggingOptions): codebuild.LoggingOptions | undefined;
+export function mergeLoggings(a?: codebuild.LoggingOptions, b?: codebuild.LoggingOptions): codebuild.LoggingOptions | undefined;
+export function mergeLoggings(a?: codebuild.LoggingOptions, b?: codebuild.LoggingOptions) {
+  const cloudWatch = b?.cloudWatch ?? a?.cloudWatch;
+  const s3 = b?.s3 ?? a?.s3;
+
+  if (!cloudWatch && !s3) {
+    return undefined;
+  }
+
+  return {
+    cloudWatch: (cloudWatch?.enabled && !cloudWatch?.logGroup) ? undefined : cloudWatch,
+    s3: s3,
+  };
+}

packages/@aws-cdk/pipelines/package.json

@@ -63,6 +63,7 @@
     "@aws-cdk/aws-events": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-lambda": "0.0.0",
+    "@aws-cdk/aws-logs": "0.0.0",
     "@aws-cdk/aws-s3": "0.0.0",
     "@aws-cdk/aws-s3-assets": "0.0.0",
     "@aws-cdk/aws-secretsmanager": "0.0.0",
@@ -82,6 +83,7 @@
     "@aws-cdk/aws-events": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
     "@aws-cdk/aws-lambda": "0.0.0",
+    "@aws-cdk/aws-logs": "0.0.0",
     "@aws-cdk/aws-s3": "0.0.0",
     "@aws-cdk/aws-s3-assets": "0.0.0",
     "@aws-cdk/aws-secretsmanager": "0.0.0",

packages/@aws-cdk/pipelines/test/codepipeline/codepipeline.test.ts

@@ -2,6 +2,8 @@ import { Template, Annotations, Match } from '@aws-cdk/assertions';
 import * as ccommit from '@aws-cdk/aws-codecommit';
 import { Pipeline } from '@aws-cdk/aws-codepipeline';
 import * as iam from '@aws-cdk/aws-iam';
+import { LogGroup } from '@aws-cdk/aws-logs';
+import { Bucket } from '@aws-cdk/aws-s3';
 import * as sqs from '@aws-cdk/aws-sqs';
 import * as cdk from '@aws-cdk/core';
 import { Stack } from '@aws-cdk/core';
@@ -392,6 +394,47 @@ test('action name is calculated properly if it has cross-stack dependencies', ()
   });
 });
 
+test('Support logging setting from codeBuildDefaults', () => {
+  // GIVEN
+  const pipelineStack = new cdk.Stack(app, 'PipelineStack', { env: PIPELINE_ENV });
+  const bucket = new Bucket(pipelineStack, 'MyLogsBucket');
+  const logGroup = new LogGroup(pipelineStack, 'LogGroup', {
+    logGroupName: 'TestLogGroup',
+  });
+  new ModernTestGitHubNpmPipeline(pipelineStack, 'Cdk', {
+    codeBuildDefaults: {
+      logging: {
+        cloudWatch: {
+          logGroup: logGroup,
+          prefix: 'prefix',
+          enabled: true,
+        },
+        s3: {
+          encrypted: true,
+          bucket: bucket,
+          prefix: 'test',
+          enabled: true,
+        },
+      },
+    },
+  });
+
+  // THEN
+  const template = Template.fromStack(pipelineStack);
+  template.hasResourceProperties('AWS::CodeBuild::Project', {
+    LogsConfig: Match.objectLike({
+      CloudWatchLogs: Match.objectLike({
+        Status: 'ENABLED',
+        StreamName: 'prefix',
+      }),
+      S3Logs: Match.objectLike({
+        EncryptionDisabled: true,
+        Status: 'ENABLED',
+      }),
+    }),
+  });
+});
+
 interface ReuseCodePipelineStackProps extends cdk.StackProps {
   reuseCrossRegionSupportStacks?: boolean;
 }

packages/@aws-cdk/pipelines/test/integ.pipeline-with-logging.js.snapshot/LoggingPipelineStack.assets.json

@@ -0,0 +1,19 @@
+{
+  "version": "29.0.0",
+  "files": {
+    "d99681b07ca842e41d76f0e1de1c36e98184be62476be52ea702af467851166d": {
+      "source": {
+        "path": "LoggingPipelineStack.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "d99681b07ca842e41d76f0e1de1c36e98184be62476be52ea702af467851166d.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}