Class CfnDistribution.S3OriginConfigProperty
A complex type that contains information about the Amazon S3 origin.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3OriginConfigProperty : Object, CfnDistribution.IS3OriginConfigProperty
Syntax (vb)
Public Class S3OriginConfigProperty
Inherits Object
Implements CfnDistribution.IS3OriginConfigProperty
Remarks
If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig
element instead.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;
var s3OriginConfigProperty = new S3OriginConfigProperty {
OriginAccessIdentity = "originAccessIdentity"
};
Synopsis
Constructors
S3OriginConfigProperty() |
Properties
OriginAccessIdentity | If you're using origin access control (OAC) instead of origin access identity, specify an empty |
Constructors
S3OriginConfigProperty()
public S3OriginConfigProperty()
Properties
OriginAccessIdentity
If you're using origin access control (OAC) instead of origin access identity, specify an empty
OriginAccessIdentity
element.
public string OriginAccessIdentity { get; set; }
Property Value
System.String
Remarks
For more information, see Restricting access to an AWS in the Amazon CloudFront Developer Guide .
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity
is the value that CloudFront returned in the ID
element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity
element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity
element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide .
Default: - ""