ArtifactsBucketLocation

class aws_cdk.aws_synthetics.ArtifactsBucketLocation(*, bucket, prefix=None)

Bases: object

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.

Parameters:

bucket (IBucket) – The s3 location that stores the data of each run.
prefix (Optional[str]) – The S3 bucket prefix. Specify this if you want a more specific path within the artifacts bucket. Default: - no prefix

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3
from aws_cdk import aws_synthetics as synthetics

# bucket: s3.Bucket

artifacts_bucket_location = synthetics.ArtifactsBucketLocation(
    bucket=bucket,

    # the properties below are optional
    prefix="prefix"
)

Attributes

bucket: The s3 location that stores the data of each run.

prefix

The S3 bucket prefix.

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

Default:

no prefix