Cache
data class CachePolicyArgs(val comment: Output<String>? = null, val defaultTtl: Output<Int>? = null, val maxTtl: Output<Int>? = null, val minTtl: Output<Int>? = null, val name: Output<String>? = null, val parametersInCacheKeyAndForwardedToOrigin: Output<CachePolicyParametersInCacheKeyAndForwardedToOriginArgs>? = null) : ConvertibleToJava<CachePolicyArgs>
Example Usage
Use the aws.cloudfront.CachePolicy resource to create a cache policy for CloudFront.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cloudfront.CachePolicy("example", {
name: "example-policy",
comment: "test comment",
defaultTtl: 50,
maxTtl: 100,
minTtl: 1,
parametersInCacheKeyAndForwardedToOrigin: {
cookiesConfig: {
cookieBehavior: "whitelist",
cookies: {
items: ["example"],
},
},
headersConfig: {
headerBehavior: "whitelist",
headers: {
items: ["example"],
},
},
queryStringsConfig: {
queryStringBehavior: "whitelist",
queryStrings: {
items: ["example"],
},
},
},
});Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.cloudfront.CachePolicy("example",
name="example-policy",
comment="test comment",
default_ttl=50,
max_ttl=100,
min_ttl=1,
parameters_in_cache_key_and_forwarded_to_origin={
"cookies_config": {
"cookie_behavior": "whitelist",
"cookies": {
"items": ["example"],
},
},
"headers_config": {
"header_behavior": "whitelist",
"headers": {
"items": ["example"],
},
},
"query_strings_config": {
"query_string_behavior": "whitelist",
"query_strings": {
"items": ["example"],
},
},
})Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.CloudFront.CachePolicy("example", new()
{
Name = "example-policy",
Comment = "test comment",
DefaultTtl = 50,
MaxTtl = 100,
MinTtl = 1,
ParametersInCacheKeyAndForwardedToOrigin = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginArgs
{
CookiesConfig = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigArgs
{
CookieBehavior = "whitelist",
Cookies = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookiesArgs
{
Items = new[]
{
"example",
},
},
},
HeadersConfig = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigArgs
{
HeaderBehavior = "whitelist",
Headers = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeadersArgs
{
Items = new[]
{
"example",
},
},
},
QueryStringsConfig = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigArgs
{
QueryStringBehavior = "whitelist",
QueryStrings = new Aws.CloudFront.Inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStringsArgs
{
Items = new[]
{
"example",
},
},
},
},
});
});Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudfront"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudfront.NewCachePolicy(ctx, "example", &cloudfront.CachePolicyArgs{
Name: pulumi.String("example-policy"),
Comment: pulumi.String("test comment"),
DefaultTtl: pulumi.Int(50),
MaxTtl: pulumi.Int(100),
MinTtl: pulumi.Int(1),
ParametersInCacheKeyAndForwardedToOrigin: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginArgs{
CookiesConfig: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigArgs{
CookieBehavior: pulumi.String("whitelist"),
Cookies: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookiesArgs{
Items: pulumi.StringArray{
pulumi.String("example"),
},
},
},
HeadersConfig: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigArgs{
HeaderBehavior: pulumi.String("whitelist"),
Headers: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeadersArgs{
Items: pulumi.StringArray{
pulumi.String("example"),
},
},
},
QueryStringsConfig: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigArgs{
QueryStringBehavior: pulumi.String("whitelist"),
QueryStrings: &cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStringsArgs{
Items: pulumi.StringArray{
pulumi.String("example"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.CachePolicy;
import com.pulumi.aws.cloudfront.CachePolicyArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookiesArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeadersArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigArgs;
import com.pulumi.aws.cloudfront.inputs.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStringsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new CachePolicy("example", CachePolicyArgs.builder()
.name("example-policy")
.comment("test comment")
.defaultTtl(50)
.maxTtl(100)
.minTtl(1)
.parametersInCacheKeyAndForwardedToOrigin(CachePolicyParametersInCacheKeyAndForwardedToOriginArgs.builder()
.cookiesConfig(CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigArgs.builder()
.cookieBehavior("whitelist")
.cookies(CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookiesArgs.builder()
.items("example")
.build())
.build())
.headersConfig(CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigArgs.builder()
.headerBehavior("whitelist")
.headers(CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeadersArgs.builder()
.items("example")
.build())
.build())
.queryStringsConfig(CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigArgs.builder()
.queryStringBehavior("whitelist")
.queryStrings(CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStringsArgs.builder()
.items("example")
.build())
.build())
.build())
.build());
}
}Content copied to clipboard
resources:
example:
type: aws:cloudfront:CachePolicy
properties:
name: example-policy
comment: test comment
defaultTtl: 50
maxTtl: 100
minTtl: 1
parametersInCacheKeyAndForwardedToOrigin:
cookiesConfig:
cookieBehavior: whitelist
cookies:
items:
- example
headersConfig:
headerBehavior: whitelist
headers:
items:
- example
queryStringsConfig:
queryStringBehavior: whitelist
queryStrings:
items:
- exampleContent copied to clipboard
Import
Using pulumi import, import CloudFront cache policies using the id of the cache policy. For example:
$ pulumi import aws:cloudfront/cachePolicy:CachePolicy policy 658327ea-f89d-4fab-a63d-7e88639e58f6Content copied to clipboard
Properties
Link copied to clipboard
Amount of time, in seconds, that objects are allowed to remain in the CloudFront cache before CloudFront sends a new request to the origin server to check if the object has been updated.
Link copied to clipboard
val parametersInCacheKeyAndForwardedToOrigin: Output<CachePolicyParametersInCacheKeyAndForwardedToOriginArgs>? = null
Configuration for including HTTP headers, cookies, and URL query strings in the cache key. For more information, refer to the Parameters In Cache Key And Forwarded To Origin section.