Class CfnOriginAccessControl
Creates a new origin access control in CloudFront.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnOriginAccessControl : CfnResource, IInspectable, IOriginAccessControlRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnOriginAccessControl Inherits CfnResource Implements IInspectable, IOriginAccessControlRef, IConstruct, IDependable, IEnvironmentAware
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
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 cfnOriginAccessControl = new CfnOriginAccessControl(this, "MyCfnOriginAccessControl", new CfnOriginAccessControlProps {
OriginAccessControlConfig = new OriginAccessControlConfigProperty {
Name = "name",
OriginAccessControlOriginType = "originAccessControlOriginType",
SigningBehavior = "signingBehavior",
SigningProtocol = "signingProtocol",
// the properties below are optional
Description = "description"
}
});
Synopsis
Constructors
| CfnOriginAccessControl(Construct, string, ICfnOriginAccessControlProps) | Create a new |
Properties
| AttrId | The unique identifier of the origin access control. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Creates a new origin access control in CloudFront. |
| CfnPropertyNames | Creates a new origin access control in CloudFront. |
| OriginAccessControlConfig | The origin access control. |
| OriginAccessControlRef | A reference to a OriginAccessControl resource. |
Methods
| ArnForOriginAccessControl(IOriginAccessControlRef) | Creates a new origin access control in CloudFront. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnOriginAccessControl(object) | Checks whether the given object is a CfnOriginAccessControl. |
| RenderProperties(IDictionary<string, object>) | Creates a new origin access control in CloudFront. |
Constructors
CfnOriginAccessControl(Construct, string, ICfnOriginAccessControlProps)
Create a new AWS::CloudFront::OriginAccessControl.
public CfnOriginAccessControl(Construct scope, string id, ICfnOriginAccessControlProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnOriginAccessControlProps
Resource properties.
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
Properties
AttrId
The unique identifier of the origin access control.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
CfnProperties
Creates a new origin access control in CloudFront.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
CfnPropertyNames
Creates a new origin access control in CloudFront.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
OriginAccessControlConfig
The origin access control.
public virtual object OriginAccessControlConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnOriginAccessControl.IOriginAccessControlConfigProperty
OriginAccessControlRef
A reference to a OriginAccessControl resource.
public virtual IOriginAccessControlReference OriginAccessControlRef { get; }
Property Value
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
Methods
ArnForOriginAccessControl(IOriginAccessControlRef)
Creates a new origin access control in CloudFront.
public static string ArnForOriginAccessControl(IOriginAccessControlRef resource)
Parameters
- resource IOriginAccessControlRef
Returns
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
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 cfnOriginAccessControl = new CfnOriginAccessControl(this, "MyCfnOriginAccessControl", new CfnOriginAccessControlProps {
OriginAccessControlConfig = new OriginAccessControlConfigProperty {
Name = "name",
OriginAccessControlOriginType = "originAccessControlOriginType",
SigningBehavior = "signingBehavior",
SigningProtocol = "signingProtocol",
// the properties below are optional
Description = "description"
}
});
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
IsCfnOriginAccessControl(object)
Checks whether the given object is a CfnOriginAccessControl.
public static bool IsCfnOriginAccessControl(object x)
Parameters
- x object
Returns
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a new origin access control in CloudFront.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
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 .
CloudformationResource: AWS::CloudFront::OriginAccessControl
ExampleMetadata: fixture=_generated