Skip to content
v2.273.0

ArtifactsBucketLocation Struct ​

Options for specifying the s3 location that stores the data of each canary run.

The artifacts bucket location cannot be updated once the canary is created.

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_synthetics as synthetics } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
const artifactsBucketLocation: synthetics.ArtifactsBucketLocation = {
  bucket: bucket,

  // the properties below are optional
  prefix: 'prefix',
};

Properties ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucketrequired#
The s3 location that stores the data of each run.
prefixstringprefixstrprefixStringPrefixstringPrefix*string= no prefix#
The S3 bucket prefix.

Specify this if you want a more specific path within the artifacts bucket.