interface ArtifactsBucketLocation

Language	Type name
.NET	Amazon.CDK.AWS.Synthetics.ArtifactsBucketLocation
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#ArtifactsBucketLocation
Java	software.amazon.awscdk.services.synthetics.ArtifactsBucketLocation
Python	aws_cdk.aws_synthetics.ArtifactsBucketLocation
TypeScript (source)	aws-cdk-lib » aws_synthetics » ArtifactsBucketLocation

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

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

Name	Type	Description
bucket	IBucket	The s3 location that stores the data of each run.
prefix?	string	The S3 bucket prefix.

---

bucket

Type: IBucket

The s3 location that stores the data of each run.

---

prefix?

Type: string (optional, default: no prefix)

The S3 bucket prefix.

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