Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cloudfront
  5. getRealtimeLogConfig
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.cloudfront.getRealtimeLogConfig

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides a CloudFront real-time log configuration resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.cloudfront.getRealtimeLogConfig({
    name: "example",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.cloudfront.get_realtime_log_config(name="example")
Copy
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.LookupRealtimeLogConfig(ctx, &cloudfront.LookupRealtimeLogConfigArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.CloudFront.GetRealtimeLogConfig.Invoke(new()
    {
        Name = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.CloudfrontFunctions;
import com.pulumi.aws.cloudfront.inputs.GetRealtimeLogConfigArgs;
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) {
        final var example = CloudfrontFunctions.getRealtimeLogConfig(GetRealtimeLogConfigArgs.builder()
            .name("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:cloudfront:getRealtimeLogConfig
      arguments:
        name: example
Copy

Using getRealtimeLogConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRealtimeLogConfig(args: GetRealtimeLogConfigArgs, opts?: InvokeOptions): Promise<GetRealtimeLogConfigResult>
function getRealtimeLogConfigOutput(args: GetRealtimeLogConfigOutputArgs, opts?: InvokeOptions): Output<GetRealtimeLogConfigResult>
Copy
def get_realtime_log_config(name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRealtimeLogConfigResult
def get_realtime_log_config_output(name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetRealtimeLogConfigResult]
Copy
func LookupRealtimeLogConfig(ctx *Context, args *LookupRealtimeLogConfigArgs, opts ...InvokeOption) (*LookupRealtimeLogConfigResult, error)
func LookupRealtimeLogConfigOutput(ctx *Context, args *LookupRealtimeLogConfigOutputArgs, opts ...InvokeOption) LookupRealtimeLogConfigResultOutput
Copy

> Note: This function is named LookupRealtimeLogConfig in the Go SDK.

public static class GetRealtimeLogConfig 
{
    public static Task<GetRealtimeLogConfigResult> InvokeAsync(GetRealtimeLogConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetRealtimeLogConfigResult> Invoke(GetRealtimeLogConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRealtimeLogConfigResult> getRealtimeLogConfig(GetRealtimeLogConfigArgs args, InvokeOptions options)
public static Output<GetRealtimeLogConfigResult> getRealtimeLogConfig(GetRealtimeLogConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:cloudfront/getRealtimeLogConfig:getRealtimeLogConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Unique name to identify this real-time log configuration.
Name This property is required. string
Unique name to identify this real-time log configuration.
name This property is required. String
Unique name to identify this real-time log configuration.
name This property is required. string
Unique name to identify this real-time log configuration.
name This property is required. str
Unique name to identify this real-time log configuration.
name This property is required. String
Unique name to identify this real-time log configuration.

getRealtimeLogConfig Result

The following output properties are available:

Arn string
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
Endpoints List<GetRealtimeLogConfigEndpoint>
(Required) Amazon Kinesis data streams where real-time log data is sent.
Fields List<string>
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
Id string
The provider-assigned unique ID for this managed resource.
Name string
SamplingRate int
(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.
Arn string
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
Endpoints []GetRealtimeLogConfigEndpoint
(Required) Amazon Kinesis data streams where real-time log data is sent.
Fields []string
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
Id string
The provider-assigned unique ID for this managed resource.
Name string
SamplingRate int
(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.
arn String
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
endpoints List<GetRealtimeLogConfigEndpoint>
(Required) Amazon Kinesis data streams where real-time log data is sent.
fields List<String>
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
id String
The provider-assigned unique ID for this managed resource.
name String
samplingRate Integer
(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.
arn string
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
endpoints GetRealtimeLogConfigEndpoint[]
(Required) Amazon Kinesis data streams where real-time log data is sent.
fields string[]
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
id string
The provider-assigned unique ID for this managed resource.
name string
samplingRate number
(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.
arn str
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
endpoints Sequence[GetRealtimeLogConfigEndpoint]
(Required) Amazon Kinesis data streams where real-time log data is sent.
fields Sequence[str]
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
id str
The provider-assigned unique ID for this managed resource.
name str
sampling_rate int
(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.
arn String
ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
endpoints List<Property Map>
(Required) Amazon Kinesis data streams where real-time log data is sent.
fields List<String>
(Required) Fields that are included in each real-time log record. See the AWS documentation for supported values.
id String
The provider-assigned unique ID for this managed resource.
name String
samplingRate Number
(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.

Supporting Types

GetRealtimeLogConfigEndpoint

KinesisStreamConfigs This property is required. List<GetRealtimeLogConfigEndpointKinesisStreamConfig>
(Required) Amazon Kinesis data stream configuration.
StreamType This property is required. string
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.
KinesisStreamConfigs This property is required. []GetRealtimeLogConfigEndpointKinesisStreamConfig
(Required) Amazon Kinesis data stream configuration.
StreamType This property is required. string
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.
kinesisStreamConfigs This property is required. List<GetRealtimeLogConfigEndpointKinesisStreamConfig>
(Required) Amazon Kinesis data stream configuration.
streamType This property is required. String
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.
kinesisStreamConfigs This property is required. GetRealtimeLogConfigEndpointKinesisStreamConfig[]
(Required) Amazon Kinesis data stream configuration.
streamType This property is required. string
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.
kinesis_stream_configs This property is required. Sequence[GetRealtimeLogConfigEndpointKinesisStreamConfig]
(Required) Amazon Kinesis data stream configuration.
stream_type This property is required. str
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.
kinesisStreamConfigs This property is required. List<Property Map>
(Required) Amazon Kinesis data stream configuration.
streamType This property is required. String
(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

GetRealtimeLogConfigEndpointKinesisStreamConfig

RoleArn This property is required. string
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
StreamArn This property is required. string
(Required) ARN of the Kinesis data stream.
RoleArn This property is required. string
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
StreamArn This property is required. string
(Required) ARN of the Kinesis data stream.
roleArn This property is required. String
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
streamArn This property is required. String
(Required) ARN of the Kinesis data stream.
roleArn This property is required. string
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
streamArn This property is required. string
(Required) ARN of the Kinesis data stream.
role_arn This property is required. str
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
stream_arn This property is required. str
(Required) ARN of the Kinesis data stream.
roleArn This property is required. String
(Required) ARN of an IAM role that CloudFront can use to send real-time log data to the Kinesis data stream. See the AWS documentation for more information.
streamArn This property is required. String
(Required) ARN of the Kinesis data stream.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws