@aws-cdk_aws-synthetics-alpha.ArtifactsBucketLocation

interface ArtifactsBucketLocation ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Synthetics.Alpha.ArtifactsBucketLocation
Gogithub.com/aws/aws-cdk-go/awscdksyntheticsalpha/v2#ArtifactsBucketLocation
Javasoftware.amazon.awscdk.services.synthetics.alpha.ArtifactsBucketLocation
Pythonaws_cdk.aws_synthetics_alpha.ArtifactsBucketLocation
TypeScript (source)@aws-cdk/aws-synthetics-alpha ยป 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 * as synthetics_alpha from '@aws-cdk/aws-synthetics-alpha';
import { aws_s3 as s3 } from 'aws-cdk-lib';

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

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

Properties

NameTypeDescription
bucket๐Ÿ”นIBucketThe s3 location that stores the data of each run.
prefix?๐Ÿ”นstringThe 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.