Class S3BucketOrigin

A S3 Bucket Origin.

Inheritance
object
OriginBase
S3BucketOrigin
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFront.Origins
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class S3BucketOrigin : OriginBase, IOrigin
Syntax (vb)
Public MustInherit Class S3BucketOrigin Inherits OriginBase Implements IOrigin
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.KMS;


            var myKmsKey = new Key(this, "myKMSKey");
            var myBucket = new Bucket(this, "mySSEKMSEncryptedBucket", new BucketProps {
                Encryption = BucketEncryption.KMS,
                EncryptionKey = myKmsKey,
                ObjectOwnership = ObjectOwnership.BUCKET_OWNER_ENFORCED
            });
            new Distribution(this, "myDist", new DistributionProps {
                DefaultBehavior = new BehaviorOptions {
                    Origin = S3BucketOrigin.WithOriginAccessControl(myBucket)
                }
            });

Synopsis

Constructors

S3BucketOrigin(IBucket, IS3BucketOriginBaseProps?)

A S3 Bucket Origin.

Methods

RenderS3OriginConfig()

A S3 Bucket Origin.
WithBucketDefaults(IBucket, IOriginProps?)

Create a S3 Origin with default S3 bucket settings (no origin access control).
WithOriginAccessControl(IBucket, IS3BucketOriginWithOACProps?)

Create a S3 Origin with Origin Access Control (OAC) configured.
WithOriginAccessIdentity(IBucket, IS3BucketOriginWithOAIProps?)

Create a S3 Origin with Origin Access Identity (OAI) configured OAI is a legacy feature and we strongly recommend you to use OAC via withOriginAccessControl() unless it is not supported in your required region (e.g. China regions).

Constructors

S3BucketOrigin(IBucket, IS3BucketOriginBaseProps?)

A S3 Bucket Origin.

protected S3BucketOrigin(IBucket bucket, IS3BucketOriginBaseProps? props = null)
Parameters
bucket IBucket
props IS3BucketOriginBaseProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.KMS;


            var myKmsKey = new Key(this, "myKMSKey");
            var myBucket = new Bucket(this, "mySSEKMSEncryptedBucket", new BucketProps {
                Encryption = BucketEncryption.KMS,
                EncryptionKey = myKmsKey,
                ObjectOwnership = ObjectOwnership.BUCKET_OWNER_ENFORCED
            });
            new Distribution(this, "myDist", new DistributionProps {
                DefaultBehavior = new BehaviorOptions {
                    Origin = S3BucketOrigin.WithOriginAccessControl(myBucket)
                }
            });

Methods

RenderS3OriginConfig()

A S3 Bucket Origin.

protected override CfnDistribution.IS3OriginConfigProperty? RenderS3OriginConfig()
Returns

CfnDistribution.IS3OriginConfigProperty

Overrides
Remarks

ExampleMetadata: infused

WithBucketDefaults(IBucket, IOriginProps?)

Create a S3 Origin with default S3 bucket settings (no origin access control).

public static IOrigin WithBucketDefaults(IBucket bucket, IOriginProps? props = null)
Parameters
bucket IBucket
props IOriginProps
Returns

IOrigin

Remarks

ExampleMetadata: infused

WithOriginAccessControl(IBucket, IS3BucketOriginWithOACProps?)

Create a S3 Origin with Origin Access Control (OAC) configured.

public static IOrigin WithOriginAccessControl(IBucket bucket, IS3BucketOriginWithOACProps? props = null)
Parameters
bucket IBucket
props IS3BucketOriginWithOACProps
Returns

IOrigin

Remarks

ExampleMetadata: infused

WithOriginAccessIdentity(IBucket, IS3BucketOriginWithOAIProps?)

Create a S3 Origin with Origin Access Identity (OAI) configured OAI is a legacy feature and we strongly recommend you to use OAC via withOriginAccessControl() unless it is not supported in your required region (e.g. China regions).

public static IOrigin WithOriginAccessIdentity(IBucket bucket, IS3BucketOriginWithOAIProps? props = null)
Parameters
bucket IBucket
props IS3BucketOriginWithOAIProps
Returns

IOrigin

Remarks

ExampleMetadata: infused

Implements