github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/cloudfront/getOriginRequestPolicy.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package cloudfront
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // ## Example Usage
    15  //
    16  // ### Basic Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudfront"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := cloudfront.LookupOriginRequestPolicy(ctx, &cloudfront.LookupOriginRequestPolicyArgs{
    32  //				Name: pulumi.StringRef("example-policy"),
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  //
    44  // ### AWS-Managed Policies
    45  //
    46  // AWS managed origin request policy names are prefixed with `Managed-`:
    47  //
    48  // <!--Start PulumiCodeChooser -->
    49  // ```go
    50  // package main
    51  //
    52  // import (
    53  //
    54  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudfront"
    55  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    56  //
    57  // )
    58  //
    59  //	func main() {
    60  //		pulumi.Run(func(ctx *pulumi.Context) error {
    61  //			_, err := cloudfront.LookupOriginRequestPolicy(ctx, &cloudfront.LookupOriginRequestPolicyArgs{
    62  //				Name: pulumi.StringRef("Managed-UserAgentRefererHeaders"),
    63  //			}, nil)
    64  //			if err != nil {
    65  //				return err
    66  //			}
    67  //			return nil
    68  //		})
    69  //	}
    70  //
    71  // ```
    72  // <!--End PulumiCodeChooser -->
    73  func LookupOriginRequestPolicy(ctx *pulumi.Context, args *LookupOriginRequestPolicyArgs, opts ...pulumi.InvokeOption) (*LookupOriginRequestPolicyResult, error) {
    74  	opts = internal.PkgInvokeDefaultOpts(opts)
    75  	var rv LookupOriginRequestPolicyResult
    76  	err := ctx.Invoke("aws:cloudfront/getOriginRequestPolicy:getOriginRequestPolicy", args, &rv, opts...)
    77  	if err != nil {
    78  		return nil, err
    79  	}
    80  	return &rv, nil
    81  }
    82  
    83  // A collection of arguments for invoking getOriginRequestPolicy.
    84  type LookupOriginRequestPolicyArgs struct {
    85  	// Identifier for the origin request policy.
    86  	Id *string `pulumi:"id"`
    87  	// Unique name to identify the origin request policy.
    88  	Name *string `pulumi:"name"`
    89  }
    90  
    91  // A collection of values returned by getOriginRequestPolicy.
    92  type LookupOriginRequestPolicyResult struct {
    93  	// Comment to describe the origin request policy.
    94  	Comment string `pulumi:"comment"`
    95  	// 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.
    96  	CookiesConfigs []GetOriginRequestPolicyCookiesConfig `pulumi:"cookiesConfigs"`
    97  	// Current version of the origin request policy.
    98  	Etag string `pulumi:"etag"`
    99  	// 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.
   100  	HeadersConfigs []GetOriginRequestPolicyHeadersConfig `pulumi:"headersConfigs"`
   101  	Id             *string                               `pulumi:"id"`
   102  	Name           *string                               `pulumi:"name"`
   103  	// 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.
   104  	QueryStringsConfigs []GetOriginRequestPolicyQueryStringsConfig `pulumi:"queryStringsConfigs"`
   105  }
   106  
   107  func LookupOriginRequestPolicyOutput(ctx *pulumi.Context, args LookupOriginRequestPolicyOutputArgs, opts ...pulumi.InvokeOption) LookupOriginRequestPolicyResultOutput {
   108  	return pulumi.ToOutputWithContext(context.Background(), args).
   109  		ApplyT(func(v interface{}) (LookupOriginRequestPolicyResult, error) {
   110  			args := v.(LookupOriginRequestPolicyArgs)
   111  			r, err := LookupOriginRequestPolicy(ctx, &args, opts...)
   112  			var s LookupOriginRequestPolicyResult
   113  			if r != nil {
   114  				s = *r
   115  			}
   116  			return s, err
   117  		}).(LookupOriginRequestPolicyResultOutput)
   118  }
   119  
   120  // A collection of arguments for invoking getOriginRequestPolicy.
   121  type LookupOriginRequestPolicyOutputArgs struct {
   122  	// Identifier for the origin request policy.
   123  	Id pulumi.StringPtrInput `pulumi:"id"`
   124  	// Unique name to identify the origin request policy.
   125  	Name pulumi.StringPtrInput `pulumi:"name"`
   126  }
   127  
   128  func (LookupOriginRequestPolicyOutputArgs) ElementType() reflect.Type {
   129  	return reflect.TypeOf((*LookupOriginRequestPolicyArgs)(nil)).Elem()
   130  }
   131  
   132  // A collection of values returned by getOriginRequestPolicy.
   133  type LookupOriginRequestPolicyResultOutput struct{ *pulumi.OutputState }
   134  
   135  func (LookupOriginRequestPolicyResultOutput) ElementType() reflect.Type {
   136  	return reflect.TypeOf((*LookupOriginRequestPolicyResult)(nil)).Elem()
   137  }
   138  
   139  func (o LookupOriginRequestPolicyResultOutput) ToLookupOriginRequestPolicyResultOutput() LookupOriginRequestPolicyResultOutput {
   140  	return o
   141  }
   142  
   143  func (o LookupOriginRequestPolicyResultOutput) ToLookupOriginRequestPolicyResultOutputWithContext(ctx context.Context) LookupOriginRequestPolicyResultOutput {
   144  	return o
   145  }
   146  
   147  // Comment to describe the origin request policy.
   148  func (o LookupOriginRequestPolicyResultOutput) Comment() pulumi.StringOutput {
   149  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) string { return v.Comment }).(pulumi.StringOutput)
   150  }
   151  
   152  // 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.
   153  func (o LookupOriginRequestPolicyResultOutput) CookiesConfigs() GetOriginRequestPolicyCookiesConfigArrayOutput {
   154  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) []GetOriginRequestPolicyCookiesConfig { return v.CookiesConfigs }).(GetOriginRequestPolicyCookiesConfigArrayOutput)
   155  }
   156  
   157  // Current version of the origin request policy.
   158  func (o LookupOriginRequestPolicyResultOutput) Etag() pulumi.StringOutput {
   159  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) string { return v.Etag }).(pulumi.StringOutput)
   160  }
   161  
   162  // 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.
   163  func (o LookupOriginRequestPolicyResultOutput) HeadersConfigs() GetOriginRequestPolicyHeadersConfigArrayOutput {
   164  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) []GetOriginRequestPolicyHeadersConfig { return v.HeadersConfigs }).(GetOriginRequestPolicyHeadersConfigArrayOutput)
   165  }
   166  
   167  func (o LookupOriginRequestPolicyResultOutput) Id() pulumi.StringPtrOutput {
   168  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) *string { return v.Id }).(pulumi.StringPtrOutput)
   169  }
   170  
   171  func (o LookupOriginRequestPolicyResultOutput) Name() pulumi.StringPtrOutput {
   172  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) *string { return v.Name }).(pulumi.StringPtrOutput)
   173  }
   174  
   175  // 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.
   176  func (o LookupOriginRequestPolicyResultOutput) QueryStringsConfigs() GetOriginRequestPolicyQueryStringsConfigArrayOutput {
   177  	return o.ApplyT(func(v LookupOriginRequestPolicyResult) []GetOriginRequestPolicyQueryStringsConfig {
   178  		return v.QueryStringsConfigs
   179  	}).(GetOriginRequestPolicyQueryStringsConfigArrayOutput)
   180  }
   181  
   182  func init() {
   183  	pulumi.RegisterOutputType(LookupOriginRequestPolicyResultOutput{})
   184  }