software.amazon.awscdk.services.cloudfront

Interface S3OriginConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3OriginConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.320Z")
 @Stability(value=Stable)
public interface S3OriginConfig
extends software.amazon.jsii.JsiiSerializable

S3 origin configuration for CloudFront.

Example:

 // Adding restrictions to a Cloudfront Web Distribution.
 Bucket sourceBucket;
 CloudFrontWebDistribution.Builder.create(this, "MyDistribution")
         .originConfigs(List.of(SourceConfiguration.builder()
                 .s3OriginSource(S3OriginConfig.builder()
                         .s3BucketSource(sourceBucket)
                         .build())
                 .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                 .build()))
         .geoRestriction(GeoRestriction.whitelist("US", "UK"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static S3OriginConfig.Builder	builder()
default IOriginAccessIdentity	getOriginAccessIdentity() The optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.
default Map<String,String>	getOriginHeaders() Any additional headers to pass to the origin.
default String	getOriginPath() The relative path to the origin root to use for sources.
default String	getOriginShieldRegion() When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
IBucket	getS3BucketSource() The source bucket to serve content from.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOriginAccessIdentity

@Stability(value=Stable)
 @Nullable
default IOriginAccessIdentity getOriginAccessIdentity()

The optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.

Default: No Origin Access Identity which requires the S3 bucket to be public accessible

getOriginHeaders

@Stability(value=Stable)
 @Nullable
default Map<String,String> getOriginHeaders()

Any additional headers to pass to the origin.

Default: - No additional headers are passed.

getOriginPath

@Stability(value=Stable)
 @Nullable
default String getOriginPath()

The relative path to the origin root to use for sources.

Default: /

getOriginShieldRegion

@Stability(value=Stable)
 @Nullable
default String getOriginShieldRegion()

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

Default: - origin shield not enabled

getS3BucketSource

@Stability(value=Stable)
 @NotNull
IBucket getS3BucketSource()

The source bucket to serve content from.

builder

@Stability(value=Stable)
static S3OriginConfig.Builder builder()

Returns:

a S3OriginConfig.Builder of S3OriginConfig