Class: Aws::CloudFront::Types::CreateRealtimeLogConfigRequest

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

Overview

Note:

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

{
  end_points: [ # required
    {
      stream_type: "string", # required
      kinesis_stream_config: {
        role_arn: "string", # required
        stream_arn: "string", # required
      },
    },
  ],
  fields: ["string"], # required
  name: "string", # required
  sampling_rate: 1, # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_pointsArray<Types::EndPoint>

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

Returns:


3005
3006
3007
3008
3009
3010
3011
3012
# File 'lib/aws-sdk-cloudfront/types.rb', line 3005

class CreateRealtimeLogConfigRequest < Struct.new(
  :end_points,
  :fields,
  :name,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end

#fieldsArray<String>

A list of fields to include in each real-time log record.

For more information about fields, see [Real-time log configuration fields] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields

Returns:

  • (Array<String>)

3005
3006
3007
3008
3009
3010
3011
3012
# File 'lib/aws-sdk-cloudfront/types.rb', line 3005

class CreateRealtimeLogConfigRequest < Struct.new(
  :end_points,
  :fields,
  :name,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A unique name to identify this real-time log configuration.

Returns:

  • (String)

3005
3006
3007
3008
3009
3010
3011
3012
# File 'lib/aws-sdk-cloudfront/types.rb', line 3005

class CreateRealtimeLogConfigRequest < Struct.new(
  :end_points,
  :fields,
  :name,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_rateInteger

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

Returns:

  • (Integer)

3005
3006
3007
3008
3009
3010
3011
3012
# File 'lib/aws-sdk-cloudfront/types.rb', line 3005

class CreateRealtimeLogConfigRequest < Struct.new(
  :end_points,
  :fields,
  :name,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end