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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.828Z")
 @Stability(value=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.fromString("max-age=31536000,public,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.fromString("max-age=0,no-cache,no-store,must-revalidate")))
         .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 and Description
protected	CacheControl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CacheControl(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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	maxAge(Duration t) Sets 'max-age='.
static CacheControl	mustRevalidate() Sets 'must-revalidate'.
static CacheControl	noCache() Sets 'no-cache'.
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='.

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 Detail

CacheControl

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

CacheControl

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

Method Detail

fromString

@Stability(value=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.

maxAge

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

Sets 'max-age='.

Parameters:

t - This parameter is required.

mustRevalidate

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

Sets 'must-revalidate'.

noCache

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

Sets 'no-cache'.

noTransform

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

Sets 'no-transform'.

proxyRevalidate

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

Sets 'proxy-revalidate'.

setPrivate

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

Sets 'private'.

setPublic

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

Sets 'public'.

sMaxAge

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

Sets 's-maxage='.

Parameters:

t - This parameter is required.

getValue

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

The raw cache control setting.