AWS CDK Reference

Appearance

v2.274.0

SourceConfig Struct ​

Source information.

Source
aws-s3-deployment/lib/source.ts
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 ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucketrequired#
The source bucket to deploy from.
markersoptional{ [key: string]: any }markersoptionaltyping.Mapping[str, Any]markersoptionalMap<String, Object>MarkersoptionalIDictionary<string, object>Markersoptional*map[string]interface{}#
A set of markers to substitute in the source content.

Default: no markers

markersConfigoptionalMarkersConfigmarkers_configoptionalMarkersConfigmarkersConfigoptionalMarkersConfigMarkersConfigoptionalMarkersConfigMarkersConfigoptionalMarkersConfig#
A configuration for markers substitution strategy.

Default: no configuration

zipObjectKeystringzip_object_keystrzipObjectKeyStringZipObjectKeystringZipObjectKey*stringrequired#
An S3 object key in the source bucket that points to a zip file.