Class CfnDistribution.HeaderObjectProperty
HeaderObject
is a property of the CacheSettings property. It describes the request headers used by your distribution, which caches your content based on the request headers.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public class HeaderObjectProperty : Object, CfnDistribution.IHeaderObjectProperty
Syntax (vb)
Public Class HeaderObjectProperty
Inherits Object
Implements CfnDistribution.IHeaderObjectProperty
Remarks
For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose that viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex. Also, suppose that you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.
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.Lightsail;
var headerObjectProperty = new HeaderObjectProperty {
HeadersAllowList = new [] { "headersAllowList" },
Option = "option"
};
Synopsis
Constructors
HeaderObjectProperty() |
Properties
HeadersAllowList | The specific headers to forward to your distribution's origin. |
Option | The headers that you want your distribution to forward to your origin. |
Constructors
HeaderObjectProperty()
public HeaderObjectProperty()
Properties
HeadersAllowList
The specific headers to forward to your distribution's origin.
public string[] HeadersAllowList { get; set; }
Property Value
System.String[]
Remarks
Option
The headers that you want your distribution to forward to your origin.
public string Option { get; set; }
Property Value
System.String
Remarks
Your distribution caches your content based on these headers.
Use one of the following configurations for your distribution: