software.amazon.awscdk.services.cloudfront

Interface S3OriginConfig

All Known Implementing Classes:

S3OriginConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.153Z")
public interface S3OriginConfig

S3 origin configuration for CloudFront.

Example:

 Bucket sourceBucket;
 ViewerCertificate viewerCertificate = ViewerCertificate.fromIamCertificate("MYIAMROLEIDENTIFIER", ViewerCertificateOptions.builder()
         .aliases(List.of("MYALIAS"))
         .build());
 CloudFrontWebDistribution.Builder.create(this, "MyCfWebDistribution")
         .originConfigs(List.of(SourceConfiguration.builder()
                 .s3OriginSource(S3OriginConfig.builder()
                         .s3BucketSource(sourceBucket)
                         .build())
                 .behaviors(List.of(Behavior.builder().isDefaultBehavior(true).build()))
                 .build()))
         .viewerCertificate(viewerCertificate)
         .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 java.util.Map<java.lang.String,java.lang.String>	getOriginHeaders() Any additional headers to pass to the origin.
default java.lang.String	getOriginPath() The relative path to the origin root to use for sources.
default java.lang.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.

Method Detail

getS3BucketSource

IBucket getS3BucketSource()

The source bucket to serve content from.

getOriginAccessIdentity

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

default java.util.Map<java.lang.String,java.lang.String> getOriginHeaders()

Any additional headers to pass to the origin.

Default: - No additional headers are passed.

getOriginPath

default java.lang.String getOriginPath()

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

Default: /

getOriginShieldRegion

default java.lang.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

builder

static S3OriginConfig.Builder builder()

Returns:

a S3OriginConfig.Builder of S3OriginConfig