interface CacheTagConfigProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudFront.CfnDistribution.CacheTagConfigProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistribution_CacheTagConfigProperty |
 Java | software.amazon.awscdk.services.cloudfront.CfnDistribution.CacheTagConfigProperty |
 Python | aws_cdk.aws_cloudfront.CfnDistribution.CacheTagConfigProperty |
 TypeScript | aws-cdk-lib » aws_cloudfront » CfnDistribution » CacheTagConfigProperty |
A complex type that specifies the HTTP header name from which CloudFront extracts cache tags from origin responses.
When you add CacheTagConfig to a distribution, CloudFront reads the specified header from origin responses, parses the comma-separated tag values, and stores them with the cached object. You can then invalidate cached objects by tag using the CreateInvalidation API.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const cacheTagConfigProperty: cloudfront.CfnDistribution.CacheTagConfigProperty = {
headerName: 'headerName',
};
Properties
| Name | Type | Description |
|---|---|---|
| header | string | The name of the HTTP header that your origin includes in responses. |
headerName
Type:
string
The name of the HTTP header that your origin includes in responses.
CloudFront uses this header to extract cache tags. The header value must contain comma-separated tag values (for example, product:electronics, category:tv, brand:example).