pulumi-aws-kotlin/com.pulumi.aws.cloudfront.kotlin/OriginRequestPolicy

OriginRequestPolicy

class OriginRequestPolicy : KotlinCustomResource

Example Usage

The following example below creates a CloudFront origin request policy.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cloudfront.OriginRequestPolicy("example", {
    name: "example-policy",
    comment: "example comment",
    cookiesConfig: {
        cookieBehavior: "whitelist",
        cookies: {
            items: ["example"],
        },
    },
    headersConfig: {
        headerBehavior: "whitelist",
        headers: {
            items: ["example"],
        },
    },
    queryStringsConfig: {
        queryStringBehavior: "whitelist",
        queryStrings: {
            items: ["example"],
        },
    },
});

import pulumi
import pulumi_aws as aws
example = aws.cloudfront.OriginRequestPolicy("example",
    name="example-policy",
    comment="example comment",
    cookies_config=aws.cloudfront.OriginRequestPolicyCookiesConfigArgs(
        cookie_behavior="whitelist",
        cookies=aws.cloudfront.OriginRequestPolicyCookiesConfigCookiesArgs(
            items=["example"],
        ),
    ),
    headers_config=aws.cloudfront.OriginRequestPolicyHeadersConfigArgs(
        header_behavior="whitelist",
        headers=aws.cloudfront.OriginRequestPolicyHeadersConfigHeadersArgs(
            items=["example"],
        ),
    ),
    query_strings_config=aws.cloudfront.OriginRequestPolicyQueryStringsConfigArgs(
        query_string_behavior="whitelist",
        query_strings=aws.cloudfront.OriginRequestPolicyQueryStringsConfigQueryStringsArgs(
            items=["example"],
        ),
    ))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.CloudFront.OriginRequestPolicy("example", new()
    {
        Name = "example-policy",
        Comment = "example comment",
        CookiesConfig = new Aws.CloudFront.Inputs.OriginRequestPolicyCookiesConfigArgs
        {
            CookieBehavior = "whitelist",
            Cookies = new Aws.CloudFront.Inputs.OriginRequestPolicyCookiesConfigCookiesArgs
            {
                Items = new[]
                {
                    "example",
                },
            },
        },
        HeadersConfig = new Aws.CloudFront.Inputs.OriginRequestPolicyHeadersConfigArgs
        {
            HeaderBehavior = "whitelist",
            Headers = new Aws.CloudFront.Inputs.OriginRequestPolicyHeadersConfigHeadersArgs
            {
                Items = new[]
                {
                    "example",
                },
            },
        },
        QueryStringsConfig = new Aws.CloudFront.Inputs.OriginRequestPolicyQueryStringsConfigArgs
        {
            QueryStringBehavior = "whitelist",
            QueryStrings = new Aws.CloudFront.Inputs.OriginRequestPolicyQueryStringsConfigQueryStringsArgs
            {
                Items = new[]
                {
                    "example",
                },
            },
        },
    });
});

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.NewOriginRequestPolicy(ctx, "example", &cloudfront.OriginRequestPolicyArgs{
			Name:    pulumi.String("example-policy"),
			Comment: pulumi.String("example comment"),
			CookiesConfig: &cloudfront.OriginRequestPolicyCookiesConfigArgs{
				CookieBehavior: pulumi.String("whitelist"),
				Cookies: &cloudfront.OriginRequestPolicyCookiesConfigCookiesArgs{
					Items: pulumi.StringArray{
						pulumi.String("example"),
					},
				},
			},
			HeadersConfig: &cloudfront.OriginRequestPolicyHeadersConfigArgs{
				HeaderBehavior: pulumi.String("whitelist"),
				Headers: &cloudfront.OriginRequestPolicyHeadersConfigHeadersArgs{
					Items: pulumi.StringArray{
						pulumi.String("example"),
					},
				},
			},
			QueryStringsConfig: &cloudfront.OriginRequestPolicyQueryStringsConfigArgs{
				QueryStringBehavior: pulumi.String("whitelist"),
				QueryStrings: &cloudfront.OriginRequestPolicyQueryStringsConfigQueryStringsArgs{
					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.OriginRequestPolicy;
import com.pulumi.aws.cloudfront.OriginRequestPolicyArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyCookiesConfigArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyCookiesConfigCookiesArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyHeadersConfigArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyHeadersConfigHeadersArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyQueryStringsConfigArgs;
import com.pulumi.aws.cloudfront.inputs.OriginRequestPolicyQueryStringsConfigQueryStringsArgs;
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 OriginRequestPolicy("example", OriginRequestPolicyArgs.builder()
            .name("example-policy")
            .comment("example comment")
            .cookiesConfig(OriginRequestPolicyCookiesConfigArgs.builder()
                .cookieBehavior("whitelist")
                .cookies(OriginRequestPolicyCookiesConfigCookiesArgs.builder()
                    .items("example")
                    .build())
                .build())
            .headersConfig(OriginRequestPolicyHeadersConfigArgs.builder()
                .headerBehavior("whitelist")
                .headers(OriginRequestPolicyHeadersConfigHeadersArgs.builder()
                    .items("example")
                    .build())
                .build())
            .queryStringsConfig(OriginRequestPolicyQueryStringsConfigArgs.builder()
                .queryStringBehavior("whitelist")
                .queryStrings(OriginRequestPolicyQueryStringsConfigQueryStringsArgs.builder()
                    .items("example")
                    .build())
                .build())
            .build());
    }
}

resources:
  example:
    type: aws:cloudfront:OriginRequestPolicy
    properties:
      name: example-policy
      comment: example comment
      cookiesConfig:
        cookieBehavior: whitelist
        cookies:
          items:
            - example
      headersConfig:
        headerBehavior: whitelist
        headers:
          items:
            - example
      queryStringsConfig:
        queryStringBehavior: whitelist
        queryStrings:
          items:
            - example

Import

Using pulumi import, import Cloudfront Origin Request Policies using the id. For example:

$ pulumi import aws:cloudfront/originRequestPolicy:OriginRequestPolicy policy ccca32ef-dce3-4df3-80df-1bd3000bc4d3

Properties

comment

val comment: Output<String>?

Comment to describe the origin request policy.

cookiesConfig

val cookiesConfig: Output<OriginRequestPolicyCookiesConfig>

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

etag

val etag: Output<String>

The current version of the origin request policy.

headersConfig

val headersConfig: Output<OriginRequestPolicyHeadersConfig>

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

val id: Output<String>

name

val name: Output<String>

Unique name to identify the origin request policy.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

queryStringsConfig

val queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfig>

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

urn

val urn: Output<String>