cache_policy_configs

Creates, updates, deletes, gets or lists a cache_policy_configs resource.

Overview

Name	cache_policy_configs
Type	Resource
Id	aws.cloudfront.cache_policy_configs

Fields

The following fields are returned by SELECT queries:

get_cache_policy_config

Name	Datatype	Description
comment	string	A comment to describe the cache policy. The comment cannot be longer than 128 characters.
default_ttl	integer	The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.
max_ttl	integer	The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide. The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.
min_ttl	integer	The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
name	string	A unique name to identify the cache policy.
parameters_in_cache_key_and_forwarded_to_origin	string	The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cache_policy_config	select	id, region		Gets a cache policy configuration. To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the cache policy. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
region	string	AWS region (default: us-east-1)

SELECT examples

get_cache_policy_config

Gets a cache policy configuration. To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

SELECT
comment,
default_ttl,
max_ttl,
min_ttl,
name,
parameters_in_cache_key_and_forwarded_to_origin
FROM aws.cloudfront.cache_policy_configs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;