software.amazon.awscdk.services.synthetics.alpha

Interface ArtifactsBucketLocation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ArtifactsBucketLocation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-09T02:01:26.351Z")
 @Stability(value=Experimental)
public interface ArtifactsBucketLocation
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 software.amazon.awscdk.services.synthetics.alpha.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 ArtifactsBucketLocation artifactsBucketLocation = ArtifactsBucketLocation.builder()
         .bucket(bucket)
         // the properties below are optional
         .prefix("prefix")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArtifactsBucketLocation.Builder A builder for ArtifactsBucketLocation
static class	ArtifactsBucketLocation.Jsii$Proxy An implementation for ArtifactsBucketLocation

Method Summary

Modifier and Type	Method and Description
static ArtifactsBucketLocation.Builder	builder()
IBucket	getBucket() (experimental) The s3 location that stores the data of each run.
default String	getPrefix() (experimental) The S3 bucket prefix.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucket

@Stability(value=Experimental)
 @NotNull
IBucket getBucket()

(experimental) The s3 location that stores the data of each run.

getPrefix

@Stability(value=Experimental)
 @Nullable
default String getPrefix()

(experimental) The S3 bucket prefix.

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

Default: - no prefix

builder

@Stability(value=Experimental)
static ArtifactsBucketLocation.Builder builder()

Returns:

a ArtifactsBucketLocation.Builder of ArtifactsBucketLocation