github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/cloudfront/getRealtimeLogConfig.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  // Provides a CloudFront real-time log configuration resource.
    15  //
    16  // ## Example 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.LookupRealtimeLogConfig(ctx, &cloudfront.LookupRealtimeLogConfigArgs{
    32  //				Name: "example",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupRealtimeLogConfig(ctx *pulumi.Context, args *LookupRealtimeLogConfigArgs, opts ...pulumi.InvokeOption) (*LookupRealtimeLogConfigResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupRealtimeLogConfigResult
    46  	err := ctx.Invoke("aws:cloudfront/getRealtimeLogConfig:getRealtimeLogConfig", args, &rv, opts...)
    47  	if err != nil {
    48  		return nil, err
    49  	}
    50  	return &rv, nil
    51  }
    52  
    53  // A collection of arguments for invoking getRealtimeLogConfig.
    54  type LookupRealtimeLogConfigArgs struct {
    55  	// Unique name to identify this real-time log configuration.
    56  	Name string `pulumi:"name"`
    57  }
    58  
    59  // A collection of values returned by getRealtimeLogConfig.
    60  type LookupRealtimeLogConfigResult struct {
    61  	// ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    62  	Arn string `pulumi:"arn"`
    63  	// (Required) Amazon Kinesis data streams where real-time log data is sent.
    64  	Endpoints []GetRealtimeLogConfigEndpoint `pulumi:"endpoints"`
    65  	// (Required) Fields that are included in each real-time log record. See the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) for supported values.
    66  	Fields []string `pulumi:"fields"`
    67  	// The provider-assigned unique ID for this managed resource.
    68  	Id   string `pulumi:"id"`
    69  	Name string `pulumi:"name"`
    70  	// (Required) Sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. An integer between `1` and `100`, inclusive.
    71  	SamplingRate int `pulumi:"samplingRate"`
    72  }
    73  
    74  func LookupRealtimeLogConfigOutput(ctx *pulumi.Context, args LookupRealtimeLogConfigOutputArgs, opts ...pulumi.InvokeOption) LookupRealtimeLogConfigResultOutput {
    75  	return pulumi.ToOutputWithContext(context.Background(), args).
    76  		ApplyT(func(v interface{}) (LookupRealtimeLogConfigResult, error) {
    77  			args := v.(LookupRealtimeLogConfigArgs)
    78  			r, err := LookupRealtimeLogConfig(ctx, &args, opts...)
    79  			var s LookupRealtimeLogConfigResult
    80  			if r != nil {
    81  				s = *r
    82  			}
    83  			return s, err
    84  		}).(LookupRealtimeLogConfigResultOutput)
    85  }
    86  
    87  // A collection of arguments for invoking getRealtimeLogConfig.
    88  type LookupRealtimeLogConfigOutputArgs struct {
    89  	// Unique name to identify this real-time log configuration.
    90  	Name pulumi.StringInput `pulumi:"name"`
    91  }
    92  
    93  func (LookupRealtimeLogConfigOutputArgs) ElementType() reflect.Type {
    94  	return reflect.TypeOf((*LookupRealtimeLogConfigArgs)(nil)).Elem()
    95  }
    96  
    97  // A collection of values returned by getRealtimeLogConfig.
    98  type LookupRealtimeLogConfigResultOutput struct{ *pulumi.OutputState }
    99  
   100  func (LookupRealtimeLogConfigResultOutput) ElementType() reflect.Type {
   101  	return reflect.TypeOf((*LookupRealtimeLogConfigResult)(nil)).Elem()
   102  }
   103  
   104  func (o LookupRealtimeLogConfigResultOutput) ToLookupRealtimeLogConfigResultOutput() LookupRealtimeLogConfigResultOutput {
   105  	return o
   106  }
   107  
   108  func (o LookupRealtimeLogConfigResultOutput) ToLookupRealtimeLogConfigResultOutputWithContext(ctx context.Context) LookupRealtimeLogConfigResultOutput {
   109  	return o
   110  }
   111  
   112  // ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
   113  func (o LookupRealtimeLogConfigResultOutput) Arn() pulumi.StringOutput {
   114  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) string { return v.Arn }).(pulumi.StringOutput)
   115  }
   116  
   117  // (Required) Amazon Kinesis data streams where real-time log data is sent.
   118  func (o LookupRealtimeLogConfigResultOutput) Endpoints() GetRealtimeLogConfigEndpointArrayOutput {
   119  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) []GetRealtimeLogConfigEndpoint { return v.Endpoints }).(GetRealtimeLogConfigEndpointArrayOutput)
   120  }
   121  
   122  // (Required) Fields that are included in each real-time log record. See the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) for supported values.
   123  func (o LookupRealtimeLogConfigResultOutput) Fields() pulumi.StringArrayOutput {
   124  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) []string { return v.Fields }).(pulumi.StringArrayOutput)
   125  }
   126  
   127  // The provider-assigned unique ID for this managed resource.
   128  func (o LookupRealtimeLogConfigResultOutput) Id() pulumi.StringOutput {
   129  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) string { return v.Id }).(pulumi.StringOutput)
   130  }
   131  
   132  func (o LookupRealtimeLogConfigResultOutput) Name() pulumi.StringOutput {
   133  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) string { return v.Name }).(pulumi.StringOutput)
   134  }
   135  
   136  // (Required) Sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. An integer between `1` and `100`, inclusive.
   137  func (o LookupRealtimeLogConfigResultOutput) SamplingRate() pulumi.IntOutput {
   138  	return o.ApplyT(func(v LookupRealtimeLogConfigResult) int { return v.SamplingRate }).(pulumi.IntOutput)
   139  }
   140  
   141  func init() {
   142  	pulumi.RegisterOutputType(LookupRealtimeLogConfigResultOutput{})
   143  }