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

OriginRequestPolicyArgs

data class OriginRequestPolicyArgs(val comment: Output<String>? = null, val cookiesConfig: Output<OriginRequestPolicyCookiesConfigArgs>? = null, val headersConfig: Output<OriginRequestPolicyHeadersConfigArgs>? = null, val name: Output<String>? = null, val queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfigArgs>? = null) : ConvertibleToJava<OriginRequestPolicyArgs>

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"],
        },
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.cloudfront.OriginRequestPolicy("example",
    name="example-policy",
    comment="example comment",
    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.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",
                },
            },
        },
    });
});
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.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
	})
}
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.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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(comment: Output<String>? = null, cookiesConfig: Output<OriginRequestPolicyCookiesConfigArgs>? = null, headersConfig: Output<OriginRequestPolicyHeadersConfigArgs>? = null, name: Output<String>? = null, queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfigArgs>? = null)

Properties

Link copied to clipboard
val comment: Output<String>? = null

Comment to describe the origin request policy.

Link copied to clipboard
val cookiesConfig: Output<OriginRequestPolicyCookiesConfigArgs>? = null

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.

Link copied to clipboard
val headersConfig: Output<OriginRequestPolicyHeadersConfigArgs>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

Unique name to identify the origin request policy.

Link copied to clipboard
val queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfigArgs>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): OriginRequestPolicyArgs