Class: Aws::CloudFront::Types::ResponseHeadersPolicyServerTimingHeadersConfig

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

Overview

A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

You can use the Server-Timing header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in the Server-Timing header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

Returns:

  • (Boolean)


10003
10004
10005
10006
10007
10008
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 10003

class ResponseHeadersPolicyServerTimingHeadersConfig < Struct.new(
  :enabled,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_rateFloat

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

Returns:

  • (Float)


10003
10004
10005
10006
10007
10008
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 10003

class ResponseHeadersPolicyServerTimingHeadersConfig < Struct.new(
  :enabled,
  :sampling_rate)
  SENSITIVE = []
  include Aws::Structure
end