Package software.amazon.awscdk.services.s3.deployment

Class CacheControl

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.deployment.CacheControl

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:24.160Z")
@Stability(Stable)
public class CacheControl
extends software.amazon.jsii.JsiiObject

Used for HTTP cache-control header, which influences downstream caches.

Example:

 Bucket destinationBucket;
 BucketDeployment.Builder.create(this, "BucketDeployment")
         .sources(List.of(Source.asset("./website", AssetOptions.builder().exclude(List.of("index.html")).build())))
         .destinationBucket(destinationBucket)
         .cacheControl(List.of(CacheControl.maxAge(Duration.days(365)), CacheControl.immutable()))
         .prune(false)
         .build();
 BucketDeployment.Builder.create(this, "HTMLBucketDeployment")
         .sources(List.of(Source.asset("./website", AssetOptions.builder().exclude(List.of("*", "!index.html")).build())))
         .destinationBucket(destinationBucket)
         .cacheControl(List.of(CacheControl.maxAge(Duration.seconds(0))))
         .prune(false)
         .build();
 

See Also:

• https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CacheControl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CacheControl(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static CacheControl	fromString(String s)	Constructs a custom cache control key from the literal value.
Object	getValue()	The raw cache control setting.
static CacheControl	immutable()	Sets 'immutable'.
static CacheControl	maxAge(Duration t)	Sets 'max-age=invalid input: '<'duration-in-seconds>'.
static CacheControl	mustRevalidate()	Sets 'must-revalidate'.
static CacheControl	mustUnderstand()	Sets 'must-understand'.
static CacheControl	noCache()	Sets 'no-cache'.
static CacheControl	noStore()	Sets 'no-store'.
static CacheControl	noTransform()	Sets 'no-transform'.
static CacheControl	proxyRevalidate()	Sets 'proxy-revalidate'.
static CacheControl	setPrivate()	Sets 'private'.
static CacheControl	setPublic()	Sets 'public'.
static CacheControl	sMaxAge(Duration t)	Sets 's-maxage=invalid input: '<'duration-in-seconds>'.
static CacheControl	staleIfError(Duration t)	Sets 'stale-if-error=invalid input: '<'duration-in-seconds>'.
static CacheControl	staleWhileRevalidate(Duration t)	Sets 'stale-while-revalidate=invalid input: '<'duration-in-seconds>'.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

CacheControl

protected CacheControl(software.amazon.jsii.JsiiObjectRef objRef)

CacheControl

protected CacheControl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

fromString

@Stability(Stable)
@NotNull
public static CacheControl fromString(@NotNull
 String s)

Constructs a custom cache control key from the literal value.

Parameters:

s - This parameter is required.

immutable

@Stability(Stable)
@NotNull
public static CacheControl immutable()

Sets 'immutable'.

maxAge

@Stability(Stable)
@NotNull
public static CacheControl maxAge(@NotNull
 Duration t)

Sets 'max-age=invalid input: '<'duration-in-seconds>'.

Parameters:

t - This parameter is required.

mustRevalidate

@Stability(Stable)
@NotNull
public static CacheControl mustRevalidate()

Sets 'must-revalidate'.

mustUnderstand

@Stability(Stable)
@NotNull
public static CacheControl mustUnderstand()

Sets 'must-understand'.

noCache

@Stability(Stable)
@NotNull
public static CacheControl noCache()

Sets 'no-cache'.

noStore

@Stability(Stable)
@NotNull
public static CacheControl noStore()

Sets 'no-store'.

noTransform

@Stability(Stable)
@NotNull
public static CacheControl noTransform()

Sets 'no-transform'.

proxyRevalidate

@Stability(Stable)
@NotNull
public static CacheControl proxyRevalidate()

Sets 'proxy-revalidate'.

setPrivate

@Stability(Stable)
@NotNull
public static CacheControl setPrivate()

Sets 'private'.

setPublic

@Stability(Stable)
@NotNull
public static CacheControl setPublic()

Sets 'public'.

sMaxAge

@Stability(Stable)
@NotNull
public static CacheControl sMaxAge(@NotNull
 Duration t)

Sets 's-maxage=invalid input: '<'duration-in-seconds>'.

Parameters:

t - This parameter is required.

staleIfError

@Stability(Stable)
@NotNull
public static CacheControl staleIfError(@NotNull
 Duration t)

Sets 'stale-if-error=invalid input: '<'duration-in-seconds>'.

Parameters:

t - This parameter is required.

staleWhileRevalidate

@Stability(Stable)
@NotNull
public static CacheControl staleWhileRevalidate(@NotNull
 Duration t)

Sets 'stale-while-revalidate=invalid input: '<'duration-in-seconds>'.

Parameters:

t - This parameter is required.

getValue

@Stability(Stable)
@NotNull
public Object getValue()

The raw cache control setting.