Interface CfnOriginAccessControl.IOriginAccessControlConfigProperty

Creates a new origin access control in CloudFront.

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnOriginAccessControl.IOriginAccessControlConfigProperty

Syntax (vb)

Public Interface CfnOriginAccessControl.IOriginAccessControlConfigProperty

Remarks

After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.

This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.

For more information about using a CloudFront origin access control, see Restricting access to an AWS origin in the Amazon CloudFront Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html

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 originAccessControlConfigProperty = new OriginAccessControlConfigProperty {
                 Name = "name",
                 OriginAccessControlOriginType = "originAccessControlOriginType",
                 SigningBehavior = "signingBehavior",
                 SigningProtocol = "signingProtocol",

                 // the properties below are optional
                 Description = "description"
             };

Synopsis

Properties

Description	A description of the origin access control.
Name	A name to identify the origin access control.
OriginAccessControlOriginType	The type of origin that this origin access control is for.
SigningBehavior	Specifies which requests CloudFront signs (adds authentication information to).
SigningProtocol	The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.

Properties

Description

A description of the origin access control.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig-description

Name

A name to identify the origin access control.

string Name { get; }

Property Value

string

Remarks

You can specify up to 64 characters.

OriginAccessControlOriginType

The type of origin that this origin access control is for.

string OriginAccessControlOriginType { get; }

Property Value

string

Remarks

SigningBehavior

Specifies which requests CloudFront signs (adds authentication information to).

string SigningBehavior { get; }

Property Value

string

Remarks

Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide .

This field can have one of the following values:

SigningProtocol

The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests.

string SigningProtocol { get; }

Property Value

string

Remarks

The only valid value is sigv4 .