You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFront::Types::StreamingLoggingConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass StreamingLoggingConfig data as a hash:

{
  enabled: false, # required
  bucket: "string", # required
  prefix: "string", # required
}

A complex type that controls whether access logs are written for this streaming distribution.

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)


5018
5019
5020
5021
5022
5023
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5018

class StreamingLoggingConfig < Struct.new(
  :enabled,
  :bucket,
  :prefix)
  include Aws::Structure
end

#enabledBoolean

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

Returns:

  • (Boolean)


5018
5019
5020
5021
5022
5023
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5018

class StreamingLoggingConfig < Struct.new(
  :enabled,
  :bucket,
  :prefix)
  include Aws::Structure
end

#prefixString

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

Returns:

  • (String)


5018
5019
5020
5021
5022
5023
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 5018

class StreamingLoggingConfig < Struct.new(
  :enabled,
  :bucket,
  :prefix)
  include Aws::Structure
end