Class CfnCloudFrontOriginAccessIdentity
A CloudFormation AWS::CloudFront::CloudFrontOriginAccessIdentity
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.AWS.CloudFront.dll
Syntax (csharp)
public class CfnCloudFrontOriginAccessIdentity : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCloudFrontOriginAccessIdentity
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide .
CloudformationResource: AWS::CloudFront::CloudFrontOriginAccessIdentity
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 cfnCloudFrontOriginAccessIdentity = new CfnCloudFrontOriginAccessIdentity(this, "MyCfnCloudFrontOriginAccessIdentity", new CfnCloudFrontOriginAccessIdentityProps {
CloudFrontOriginAccessIdentityConfig = new CloudFrontOriginAccessIdentityConfigProperty {
Comment = "comment"
}
});
Synopsis
Constructors
CfnCloudFrontOriginAccessIdentity(Construct, String, ICfnCloudFrontOriginAccessIdentityProps) | Create a new |
CfnCloudFrontOriginAccessIdentity(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCloudFrontOriginAccessIdentity(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrId | The ID for the origin access identity, for example, |
AttrS3CanonicalUserId | The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CloudFrontOriginAccessIdentityConfig | The current configuration information for the identity. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCloudFrontOriginAccessIdentity(Construct, String, ICfnCloudFrontOriginAccessIdentityProps)
Create a new AWS::CloudFront::CloudFrontOriginAccessIdentity
.
public CfnCloudFrontOriginAccessIdentity(Construct scope, string id, ICfnCloudFrontOriginAccessIdentityProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCloudFrontOriginAccessIdentityProps
- resource properties.
CfnCloudFrontOriginAccessIdentity(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCloudFrontOriginAccessIdentity(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCloudFrontOriginAccessIdentity(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCloudFrontOriginAccessIdentity(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrId
The ID for the origin access identity, for example, E74FTE3AJFJ256A
.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrS3CanonicalUserId
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
public virtual string AttrS3CanonicalUserId { get; }
Property Value
System.String
Remarks
For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd
.
CloudformationAttribute: S3CanonicalUserId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
public virtual object CloudFrontOriginAccessIdentityConfig { get; set; }
Property Value
System.Object
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>