Interface CfnDistribution.ILoggingProperty

A complex type that specifies whether access logs are written for the distribution.

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDistribution.ILoggingProperty

Syntax (vb)

Public Interface CfnDistribution.ILoggingProperty

Remarks

If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a <em>different</em> Amazon S3 bucket or use a <em>separate path</em> in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html">Standard logging (access logs)</a> in the <em>Amazon CloudFront Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.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 loggingProperty = new LoggingProperty {
                 Bucket = "bucket",
                 IncludeCookies = false,
                 Prefix = "prefix"
             };

Synopsis

Properties

Bucket	The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com .
IncludeCookies	Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies .
Prefix	An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/ .

Properties

Bucket

The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com .

string? Bucket { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-bucket

IncludeCookies

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies .

object? IncludeCookies { get; }

Property Value

object

Remarks

If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies .

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-includecookies

Type union: either bool or IResolvable

Prefix

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/ .

string? Prefix { get; }

Property Value

string

Remarks

If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Default: - ""

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html#cfn-cloudfront-distribution-logging-prefix