aws logo
AWS Classic v5.28.0, Jan 23 23

aws.cloudfront.getRealtimeLogConfig

Provides a CloudFront real-time log configuration resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}
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());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.cloudfront.get_realtime_log_config(name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.cloudfront.getRealtimeLogConfig({
    name: "example",
});
variables:
  example:
    fn::invoke:
      Function: aws:cloudfront:getRealtimeLogConfig
      Arguments:
        name: example

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>
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]
func LookupRealtimeLogConfig(ctx *Context, args *LookupRealtimeLogConfigArgs, opts ...InvokeOption) (*LookupRealtimeLogConfigResult, error)
func LookupRealtimeLogConfigOutput(ctx *Context, args *LookupRealtimeLogConfigOutputArgs, opts ...InvokeOption) LookupRealtimeLogConfigResultOutput

> 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)
}
public static CompletableFuture<GetRealtimeLogConfigResult> getRealtimeLogConfig(GetRealtimeLogConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws:cloudfront/getRealtimeLogConfig:getRealtimeLogConfig
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

Unique name to identify this real-time log configuration.

Name string

Unique name to identify this real-time log configuration.

name String

Unique name to identify this real-time log configuration.

name string

Unique name to identify this real-time log configuration.

name str

Unique name to identify this real-time log configuration.

name 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 List<GetRealtimeLogConfigEndpointKinesisStreamConfig>

(Required) Amazon Kinesis data stream configuration.

StreamType string

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

KinesisStreamConfigs []GetRealtimeLogConfigEndpointKinesisStreamConfig

(Required) Amazon Kinesis data stream configuration.

StreamType string

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

kinesisStreamConfigs List<GetRealtimeLogConfigEndpointKinesisStreamConfig>

(Required) Amazon Kinesis data stream configuration.

streamType String

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

kinesisStreamConfigs GetRealtimeLogConfigEndpointKinesisStreamConfig[]

(Required) Amazon Kinesis data stream configuration.

streamType string

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

kinesis_stream_configs Sequence[GetRealtimeLogConfigEndpointKinesisStreamConfig]

(Required) Amazon Kinesis data stream configuration.

stream_type str

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

kinesisStreamConfigs List<Property Map>

(Required) Amazon Kinesis data stream configuration.

streamType String

(Required) Type of data stream where real-time log data is sent. The only valid value is Kinesis.

GetRealtimeLogConfigEndpointKinesisStreamConfig

RoleArn 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 string

(Required) ARN of the Kinesis data stream.

RoleArn 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 string

(Required) ARN of the Kinesis data stream.

roleArn 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 String

(Required) ARN of the Kinesis data stream.

roleArn 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 string

(Required) ARN of the Kinesis data stream.

role_arn 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 str

(Required) ARN of the Kinesis data stream.

roleArn 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 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.