# S3ArtifactsProps

Construction properties for `S3Artifacts`.

Extends: S3ArtifactsProps
Extends: ArtifactsProps

- Source: [`aws-codebuild/lib/artifacts.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-codebuild/lib/artifacts.ts#L80)

## 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

- `bucket`: [IBucket](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html) (required) — The name of the output bucket.

- `encryption`: boolean — 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

- `identifier`: string — The artifact identifier.

  This property is required on secondary artifacts.

- `includeBuildId`: boolean = 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>".

- `name`: 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.

- `packageZip`: boolean — 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

- `path`: 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