AWS CDK Reference

Appearance

v2.274.0

S3ArtifactsProps Struct ​

Construction properties for S3Artifacts.

Source
aws-codebuild/lib/artifacts.ts

Example ​

ts
declare const bucket: s3.Bucket;

const project = new codebuild.Project(this, 'MyProject', {
  buildSpec: codebuild.BuildSpec.fromObject({
    version: '0.2',
  }),
  artifacts: codebuild.Artifacts.s3({
      bucket,
      includeBuildId: false,
      packageZip: true,
      path: 'another/path',
      identifier: 'AddArtifact1',
    }),
});

Properties ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucketrequired#
The name of the output bucket.
encryptionoptionalbooleanencryptionoptionalboolencryptionoptionalBooleanEncryptionoptionalboolEncryptionoptional*bool#
If this is false, build output will not be encrypted.

Default: true - output will be encrypted

This is useful if the artifact to publish a static website or sharing content with others

identifieroptionalstringidentifieroptionalstridentifieroptionalStringIdentifieroptionalstringIdentifieroptional*string#
The artifact identifier.

This property is required on secondary artifacts.

includeBuildIdoptionalbooleaninclude_build_idoptionalboolincludeBuildIdoptionalBooleanIncludeBuildIdoptionalboolIncludeBuildIdoptional*bool= true#
Indicates if the build ID should be included in the path.

If this is set to true, then the build artifact will be stored in "<path>/<build-id>/<name>".

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the build output ZIP file or folder inside the bucket.

Default: undefined, and use the name from the buildspec

The full S3 object key will be "<path>/<build-id>/<name>" or "<path>/<name>" depending on whether includeBuildId is set to true.

If not set, overrideArtifactName will be set and the name from the buildspec will be used instead.

packageZipoptionalbooleanpackage_zipoptionalboolpackageZipoptionalBooleanPackageZipoptionalboolPackageZipoptional*bool#
If this is true, all build output will be packaged into a single .zip file. Otherwise, all files will be uploaded to <path>/<name>.

Default: true - files will be archived

pathoptionalstringpathoptionalstrpathoptionalStringPathoptionalstringPathoptional*string#
The path inside of the bucket for the build output .zip file or folder. If a value is not specified, then build output will be stored at the root of the bucket (or under the <build-id> directory if `includeBuildId` is set to true).

Default: the root of the bucket