# SourceConfig

Source information.

- Source: [`aws-s3-deployment/lib/source.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-s3-deployment/lib/source.ts#L17)
- Type last changed: v2.190.0 · 17 Apr 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
import { aws_s3_deployment as s3_deployment } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
declare const markers: any;
const sourceConfig: s3_deployment.SourceConfig = {
  bucket: bucket,
  zipObjectKey: 'zipObjectKey',

  // the properties below are optional
  markers: {
    markersKey: markers,
  },
  markersConfig: {
    jsonEscape: false,
  },
};
```

## Properties

- `bucket`: [IBucket](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html) (required) — The source bucket to deploy from.

- `markers`: { [key: string]: any } — A set of markers to substitute in the source content.

  **Default:** no markers

- `markersConfig`: [MarkersConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_s3_deployment.MarkersConfig.html) — A configuration for markers substitution strategy.

  **Default:** no configuration

- `zipObjectKey`: string (required) — An S3 object key in the source bucket that points to a zip file.