Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. cloudfront
  5. CachePolicy

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.cloudfront.CachePolicy

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Import

    Cloudfront Cache Policies can be imported using the id, e.g.,

     $ pulumi import aws:cloudfront/cachePolicy:CachePolicy policy 658327ea-f89d-4fab-a63d-7e88639e58f6

    Example Usage

    The following example below creates a CloudFront cache policy.

    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()
    {
        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",
                    },
                },
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			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
	})
}

    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()        
            .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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.cloudfront.CachePolicy("example",
    comment="test comment",
    default_ttl=50,
    max_ttl=100,
    min_ttl=1,
    parameters_in_cache_key_and_forwarded_to_origin=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginArgs(
        cookies_config=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigArgs(
            cookie_behavior="whitelist",
            cookies=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookiesArgs(
                items=["example"],
            ),
        ),
        headers_config=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigArgs(
            header_behavior="whitelist",
            headers=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeadersArgs(
                items=["example"],
            ),
        ),
        query_strings_config=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigArgs(
            query_string_behavior="whitelist",
            query_strings=aws.cloudfront.CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStringsArgs(
                items=["example"],
            ),
        ),
    ))

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cloudfront.CachePolicy("example", {
    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"],
            },
        },
    },
});

    resources:
  example:
    type: aws:cloudfront:CachePolicy
    properties:
      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

    Create CachePolicy Resource

    new CachePolicy(name: string, args: CachePolicyArgs, opts?: CustomResourceOptions);
    @overload
def CachePolicy(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                comment: Optional[str] = None,
                default_ttl: Optional[int] = None,
                max_ttl: Optional[int] = None,
                min_ttl: Optional[int] = None,
                name: Optional[str] = None,
                parameters_in_cache_key_and_forwarded_to_origin: Optional[CachePolicyParametersInCacheKeyAndForwardedToOriginArgs] = None)
@overload
def CachePolicy(resource_name: str,
                args: CachePolicyArgs,
                opts: Optional[ResourceOptions] = None)
    func NewCachePolicy(ctx *Context, name string, args CachePolicyArgs, opts ...ResourceOption) (*CachePolicy, error)
    public CachePolicy(string name, CachePolicyArgs args, CustomResourceOptions? opts = null)
    public CachePolicy(String name, CachePolicyArgs args)
public CachePolicy(String name, CachePolicyArgs args, CustomResourceOptions options)

    type: aws:cloudfront:CachePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CachePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CachePolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CachePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CachePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CachePolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CachePolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CachePolicy resource accepts the following input properties:

    ParametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    Comment string

    A comment to describe the cache policy.

    DefaultTtl int

    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.

    MaxTtl int

    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.

    MinTtl int

    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.

    Name string

    A unique name to identify the cache policy.

    ParametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    Comment string

    A comment to describe the cache policy.

    DefaultTtl int

    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.

    MaxTtl int

    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.

    MinTtl int

    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.

    Name string

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment String

    A comment to describe the cache policy.

    defaultTtl 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.

    maxTtl 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.

    minTtl 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.

    name String

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment string

    A comment to describe the cache policy.

    defaultTtl number

    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.

    maxTtl number

    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.

    minTtl number

    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.

    name string

    A unique name to identify the cache policy.

    parameters_in_cache_key_and_forwarded_to_origin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment str

    A comment to describe the cache policy.

    default_ttl int

    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.

    max_ttl int

    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.

    min_ttl int

    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.

    name str

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin Property Map

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment String

    A comment to describe the cache policy.

    defaultTtl Number

    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.

    maxTtl Number

    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.

    minTtl Number

    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.

    name String

    A unique name to identify the cache policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CachePolicy resource produces the following output properties:

    Etag string

    The current version of the cache policy.

    Id string

    The provider-assigned unique ID for this managed resource.

    Etag string

    The current version of the cache policy.

    Id string

    The provider-assigned unique ID for this managed resource.

    etag String

    The current version of the cache policy.

    id String

    The provider-assigned unique ID for this managed resource.

    etag string

    The current version of the cache policy.

    id string

    The provider-assigned unique ID for this managed resource.

    etag str

    The current version of the cache policy.

    id str

    The provider-assigned unique ID for this managed resource.

    etag String

    The current version of the cache policy.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing CachePolicy Resource

    Get an existing CachePolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CachePolicyState, opts?: CustomResourceOptions): CachePolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        default_ttl: Optional[int] = None,
        etag: Optional[str] = None,
        max_ttl: Optional[int] = None,
        min_ttl: Optional[int] = None,
        name: Optional[str] = None,
        parameters_in_cache_key_and_forwarded_to_origin: Optional[CachePolicyParametersInCacheKeyAndForwardedToOriginArgs] = None) -> CachePolicy
    func GetCachePolicy(ctx *Context, name string, id IDInput, state *CachePolicyState, opts ...ResourceOption) (*CachePolicy, error)
    public static CachePolicy Get(string name, Input<string> id, CachePolicyState? state, CustomResourceOptions? opts = null)
    public static CachePolicy get(String name, Output<String> id, CachePolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Comment string

    A comment to describe the cache policy.

    DefaultTtl int

    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.

    Etag string

    The current version of the cache policy.

    MaxTtl int

    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.

    MinTtl int

    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.

    Name string

    A unique name to identify the cache policy.

    ParametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    Comment string

    A comment to describe the cache policy.

    DefaultTtl int

    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.

    Etag string

    The current version of the cache policy.

    MaxTtl int

    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.

    MinTtl int

    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.

    Name string

    A unique name to identify the cache policy.

    ParametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment String

    A comment to describe the cache policy.

    defaultTtl 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.

    etag String

    The current version of the cache policy.

    maxTtl 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.

    minTtl 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.

    name String

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment string

    A comment to describe the cache policy.

    defaultTtl number

    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.

    etag string

    The current version of the cache policy.

    maxTtl number

    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.

    minTtl number

    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.

    name string

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment str

    A comment to describe the cache policy.

    default_ttl int

    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.

    etag str

    The current version of the cache policy.

    max_ttl int

    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.

    min_ttl int

    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.

    name str

    A unique name to identify the cache policy.

    parameters_in_cache_key_and_forwarded_to_origin CachePolicyParametersInCacheKeyAndForwardedToOriginArgs

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    comment String

    A comment to describe the cache policy.

    defaultTtl Number

    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.

    etag String

    The current version of the cache policy.

    maxTtl Number

    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.

    minTtl Number

    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.

    name String

    A unique name to identify the cache policy.

    parametersInCacheKeyAndForwardedToOrigin Property Map

    The HTTP headers, cookies, and URL query strings to include in the cache key. See Parameters In Cache Key And Forwarded To Origin for more information.

    Supporting Types

    CachePolicyParametersInCacheKeyAndForwardedToOrigin

    CookiesConfig CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    HeadersConfig CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    QueryStringsConfig CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    EnableAcceptEncodingBrotli bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    EnableAcceptEncodingGzip bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    CookiesConfig CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    HeadersConfig CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    QueryStringsConfig CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    EnableAcceptEncodingBrotli bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    EnableAcceptEncodingGzip bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    cookiesConfig CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    headersConfig CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    queryStringsConfig CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    enableAcceptEncodingBrotli Boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    enableAcceptEncodingGzip Boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    cookiesConfig CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    headersConfig CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    queryStringsConfig CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    enableAcceptEncodingBrotli boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    enableAcceptEncodingGzip boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    cookies_config CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    headers_config CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    query_strings_config CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    enable_accept_encoding_brotli bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    enable_accept_encoding_gzip bool

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    cookiesConfig Property Map

    Object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Cookies Config for more information.

    headersConfig Property Map

    Object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Headers Config for more information.

    queryStringsConfig Property Map

    Object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin. See Query String Config for more information.

    enableAcceptEncodingBrotli Boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    enableAcceptEncodingGzip Boolean

    A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

    CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfig

    CookieBehavior string

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    Cookies CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Object that contains a list of cookie names. See Items for more information.

    CookieBehavior string

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    Cookies CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Object that contains a list of cookie names. See Items for more information.

    cookieBehavior String

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    cookies CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Object that contains a list of cookie names. See Items for more information.

    cookieBehavior string

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    cookies CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Object that contains a list of cookie names. See Items for more information.

    cookie_behavior str

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    cookies CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Object that contains a list of cookie names. See Items for more information.

    cookieBehavior String

    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    cookies Property Map

    Object that contains a list of cookie names. See Items for more information.

    CachePolicyParametersInCacheKeyAndForwardedToOriginCookiesConfigCookies

    Items List<string>
    Items []string
    items List<String>
    items string[]
    items Sequence[str]
    items List<String>

    CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfig

    HeaderBehavior string

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    Headers CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Object that contains a list of header names. See Items for more information.

    HeaderBehavior string

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    Headers CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Object that contains a list of header names. See Items for more information.

    headerBehavior String

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    headers CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Object that contains a list of header names. See Items for more information.

    headerBehavior string

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    headers CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Object that contains a list of header names. See Items for more information.

    header_behavior str

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    headers CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Object that contains a list of header names. See Items for more information.

    headerBehavior String

    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist.

    headers Property Map

    Object that contains a list of header names. See Items for more information.

    CachePolicyParametersInCacheKeyAndForwardedToOriginHeadersConfigHeaders

    Items List<string>
    Items []string
    items List<String>
    items string[]
    items Sequence[str]
    items List<String>

    CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfig

    QueryStringBehavior string

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    QueryStrings CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Object that contains a list of query string names. See Items for more information.

    QueryStringBehavior string

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    QueryStrings CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Object that contains a list of query string names. See Items for more information.

    queryStringBehavior String

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    queryStrings CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Object that contains a list of query string names. See Items for more information.

    queryStringBehavior string

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    queryStrings CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Object that contains a list of query string names. See Items for more information.

    query_string_behavior str

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    query_strings CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Object that contains a list of query string names. See Items for more information.

    queryStringBehavior String

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are none, whitelist, allExcept, all.

    queryStrings Property Map

    Object that contains a list of query string names. See Items for more information.

    CachePolicyParametersInCacheKeyAndForwardedToOriginQueryStringsConfigQueryStrings

    Items List<string>
    Items []string
    items List<String>
    items string[]
    items Sequence[str]
    items List<String>

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws