@pulumi/aws/cloudfront/getOriginRequestPolicy.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.cloudfront.getOriginRequestPolicy({
 *     name: "example-policy",
 * });
 * ```
 *
 * ### AWS-Managed Policies
 *
 * AWS managed origin request policy names are prefixed with `Managed-`:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const uaReferer = aws.cloudfront.getOriginRequestPolicy({
 *     name: "Managed-UserAgentRefererHeaders",
 * });
 * ```
 */
export declare function getOriginRequestPolicy(args?: GetOriginRequestPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetOriginRequestPolicyResult>;
/**
 * A collection of arguments for invoking getOriginRequestPolicy.
 */
export interface GetOriginRequestPolicyArgs {
    /**
     * Identifier for the origin request policy.
     */
    id?: string;
    /**
     * Unique name to identify the origin request policy.
     */
    name?: string;
}
/**
 * A collection of values returned by getOriginRequestPolicy.
 */
export interface GetOriginRequestPolicyResult {
    /**
     * The origin request policy ARN.
     */
    readonly arn: string;
    /**
     * Comment to describe the origin request policy.
     */
    readonly comment: string;
    /**
     * 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.
     */
    readonly cookiesConfigs: outputs.cloudfront.GetOriginRequestPolicyCookiesConfig[];
    /**
     * Current version of the origin request policy.
     */
    readonly etag: string;
    /**
     * 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.
     */
    readonly headersConfigs: outputs.cloudfront.GetOriginRequestPolicyHeadersConfig[];
    readonly id?: string;
    readonly name?: string;
    /**
     * 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.
     */
    readonly queryStringsConfigs: outputs.cloudfront.GetOriginRequestPolicyQueryStringsConfig[];
}
/**
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.cloudfront.getOriginRequestPolicy({
 *     name: "example-policy",
 * });
 * ```
 *
 * ### AWS-Managed Policies
 *
 * AWS managed origin request policy names are prefixed with `Managed-`:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const uaReferer = aws.cloudfront.getOriginRequestPolicy({
 *     name: "Managed-UserAgentRefererHeaders",
 * });
 * ```
 */
export declare function getOriginRequestPolicyOutput(args?: GetOriginRequestPolicyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetOriginRequestPolicyResult>;
/**
 * A collection of arguments for invoking getOriginRequestPolicy.
 */
export interface GetOriginRequestPolicyOutputArgs {
    /**
     * Identifier for the origin request policy.
     */
    id?: pulumi.Input<string>;
    /**
     * Unique name to identify the origin request policy.
     */
    name?: pulumi.Input<string>;
}