software.amazon.awscdk.services.s3.deployment

Class CacheControl

java.lang.Object

software.amazon.jsii.JsiiObject

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:27.376Z")
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

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(java.lang.String s) Constructs a custom cache control key from the literal value.
java.lang.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 java.lang.Object

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

Constructor Detail

CacheControl

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

CacheControl

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

Method Detail

fromString

public static CacheControl fromString(java.lang.String s)

Constructs a custom cache control key from the literal value.

Parameters:

s - This parameter is required.

maxAge

public static CacheControl maxAge(Duration t)

Sets 'max-age='.

Parameters:

t - This parameter is required.

mustRevalidate

public static CacheControl mustRevalidate()

Sets 'must-revalidate'.

noCache

public static CacheControl noCache()

Sets 'no-cache'.

noTransform

public static CacheControl noTransform()

Sets 'no-transform'.

proxyRevalidate

public static CacheControl proxyRevalidate()

Sets 'proxy-revalidate'.

setPrivate

public static CacheControl setPrivate()

Sets 'private'.

setPublic

public static CacheControl setPublic()

Sets 'public'.

sMaxAge

public static CacheControl sMaxAge(Duration t)

Sets 's-maxage='.

Parameters:

t - This parameter is required.

getValue

public java.lang.Object getValue()

The raw cache control setting.