RealtimeLogConfig class

Provides a CloudFront real-time log configuration resource.

Example Usage

Basic Usage

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

const assumeRole = aws.iam.getPolicyDocument({
    statements: [{
        principals: [{
            type: "Service",
            identifiers: ["cloudfront.amazonaws.com"],
        }],
        effect: "Allow",
        actions: ["sts:AssumeRole"],
    }],
});
const exampleRole = new aws.iam.Role("example", {
    name: "cloudfront-realtime-log-config-example",
    assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
});
const example = aws.iam.getPolicyDocument({
    statements: [{
        effect: "Allow",
        actions: [
            "kinesis:DescribeStreamSummary",
            "kinesis:DescribeStream",
            "kinesis:PutRecord",
            "kinesis:PutRecords",
        ],
        resources: [exampleAwsKinesisStream.arn],
    }],
});
const exampleRolePolicy = new aws.iam.RolePolicy("example", {
    name: "cloudfront-realtime-log-config-example",
    role: exampleRole.id,
    policy: example.then(example => example.json),
});
const exampleRealtimeLogConfig = new aws.cloudfront.RealtimeLogConfig("example", {
    endpoint: {
        kinesisStreamConfig: {
            roleArn: exampleRole.arn,
            streamArn: exampleAwsKinesisStream.arn,
        },
        streamType: "Kinesis",
    },
    name: "example",
    samplingRate: 75,
    fields: [
        "timestamp",
        "c-ip",
    ],
}, {
    dependsOn: [exampleRolePolicy],
});
import pulumi
import pulumi_aws as aws

assume_role = aws.iam.get_policy_document(statements=[{
    "principals": [{
        "type": "Service",
        "identifiers": ["cloudfront.amazonaws.com"],
    }],
    "effect": "Allow",
    "actions": ["sts:AssumeRole"],
}])
example_role = aws.iam.Role("example",
    name="cloudfront-realtime-log-config-example",
    assume_role_policy=assume_role.json)
example = aws.iam.get_policy_document(statements=[{
    "effect": "Allow",
    "actions": [
        "kinesis:DescribeStreamSummary",
        "kinesis:DescribeStream",
        "kinesis:PutRecord",
        "kinesis:PutRecords",
    ],
    "resources": [example_aws_kinesis_stream["arn"]],
}])
example_role_policy = aws.iam.RolePolicy("example",
    name="cloudfront-realtime-log-config-example",
    role=example_role.id,
    policy=example.json)
example_realtime_log_config = aws.cloudfront.RealtimeLogConfig("example",
    endpoint={
        "kinesis_stream_config": {
            "role_arn": example_role.arn,
            "stream_arn": example_aws_kinesis_stream["arn"],
        },
        "stream_type": "Kinesis",
    },
    name="example",
    sampling_rate=75,
    fields=[
        "timestamp",
        "c-ip",
    ],
    opts = pulumi.ResourceOptions(depends_on=[example_role_policy]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "Service",
                        Identifiers = new[]
                        {
                            "cloudfront.amazonaws.com",
                        },
                    },
                },
                Effect = "Allow",
                Actions = new[]
                {
                    "sts:AssumeRole",
                },
            },
        },
    });

    var exampleRole = new Aws.Iam.Role("example", new()
    {
        Name = "cloudfront-realtime-log-config-example",
        AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

    var example = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Effect = "Allow",
                Actions = new[]
                {
                    "kinesis:DescribeStreamSummary",
                    "kinesis:DescribeStream",
                    "kinesis:PutRecord",
                    "kinesis:PutRecords",
                },
                Resources = new[]
                {
                    exampleAwsKinesisStream.Arn,
                },
            },
        },
    });

    var exampleRolePolicy = new Aws.Iam.RolePolicy("example", new()
    {
        Name = "cloudfront-realtime-log-config-example",
        Role = exampleRole.Id,
        Policy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

    var exampleRealtimeLogConfig = new Aws.CloudFront.RealtimeLogConfig("example", new()
    {
        Endpoint = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointArgs
        {
            KinesisStreamConfig = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs
            {
                RoleArn = exampleRole.Arn,
                StreamArn = exampleAwsKinesisStream.Arn,
            },
            StreamType = "Kinesis",
        },
        Name = "example",
        SamplingRate = 75,
        Fields = new[]
        {
            "timestamp",
            "c-ip",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleRolePolicy,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudfront"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "Service",
							Identifiers: []string{
								"cloudfront.amazonaws.com",
							},
						},
					},
					Effect: pulumi.StringRef("Allow"),
					Actions: []string{
						"sts:AssumeRole",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
			Name:             pulumi.String("cloudfront-realtime-log-config-example"),
			AssumeRolePolicy: pulumi.String(assumeRole.Json),
		})
		if err != nil {
			return err
		}
		example, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Effect: pulumi.StringRef("Allow"),
					Actions: []string{
						"kinesis:DescribeStreamSummary",
						"kinesis:DescribeStream",
						"kinesis:PutRecord",
						"kinesis:PutRecords",
					},
					Resources: pulumi.StringArray{
						exampleAwsKinesisStream.Arn,
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		exampleRolePolicy, err := iam.NewRolePolicy(ctx, "example", &iam.RolePolicyArgs{
			Name:   pulumi.String("cloudfront-realtime-log-config-example"),
			Role:   exampleRole.ID().ToIDOutput().ToStringOutput(),
			Policy: pulumi.String(example.Json),
		})
		if err != nil {
			return err
		}
		_, err = cloudfront.NewRealtimeLogConfig(ctx, "example", &cloudfront.RealtimeLogConfigArgs{
			Endpoint: &cloudfront.RealtimeLogConfigEndpointArgs{
				KinesisStreamConfig: &cloudfront.RealtimeLogConfigEndpointKinesisStreamConfigArgs{
					RoleArn:   exampleRole.Arn,
					StreamArn: pulumi.Any(exampleAwsKinesisStream.Arn),
				},
				StreamType: pulumi.String("Kinesis"),
			},
			Name:         pulumi.String("example"),
			SamplingRate: pulumi.Int(75),
			Fields: pulumi.StringArray{
				pulumi.String("timestamp"),
				pulumi.String("c-ip"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleRolePolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getpolicydocument" "assumeRole" {
  statements {
    principals {
      type        = "Service"
      identifiers = ["cloudfront.amazonaws.com"]
    }
    effect  = "Allow"
    actions = ["sts:AssumeRole"]
  }
}
data "aws_iam_getpolicydocument" "example" {
  statements {
    effect    = "Allow"
    actions   = ["kinesis:DescribeStreamSummary", "kinesis:DescribeStream", "kinesis:PutRecord", "kinesis:PutRecords"]
    resources = [exampleAwsKinesisStream.arn]
  }
}

resource "aws_iam_role" "example" {
  name               = "cloudfront-realtime-log-config-example"
  assume_role_policy = data.aws_iam_getpolicydocument.assumeRole.json
}
resource "aws_iam_rolepolicy" "example" {
  name   = "cloudfront-realtime-log-config-example"
  role   = aws_iam_role.example.id
  policy = data.aws_iam_getpolicydocument.example.json
}
resource "aws_cloudfront_realtimelogconfig" "example" {
  depends_on = [aws_iam_rolepolicy.example]
  endpoint = {
    kinesis_stream_config = {
      role_arn   = aws_iam_role.example.arn
      stream_arn = exampleAwsKinesisStream.arn
    }
    stream_type = "Kinesis"
  }
  name          = "example"
  sampling_rate = 75
  fields        = ["timestamp", "c-ip"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicy;
import com.pulumi.aws.iam.RolePolicyArgs;
import com.pulumi.aws.cloudfront.RealtimeLogConfig;
import com.pulumi.aws.cloudfront.RealtimeLogConfigArgs;
import com.pulumi.aws.cloudfront.inputs.RealtimeLogConfigEndpointArgs;
import com.pulumi.aws.cloudfront.inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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 assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("Service")
                    .identifiers("cloudfront.amazonaws.com")
                    .build())
                .effect("Allow")
                .actions("sts:AssumeRole")
                .build())
            .build());

        var exampleRole = new Role("exampleRole", RoleArgs.builder()
            .name("cloudfront-realtime-log-config-example")
            .assumeRolePolicy(assumeRole.json())
            .build());

        final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .effect("Allow")
                .actions(
                    "kinesis:DescribeStreamSummary",
                    "kinesis:DescribeStream",
                    "kinesis:PutRecord",
                    "kinesis:PutRecords")
                .resources(exampleAwsKinesisStream.arn())
                .build())
            .build());

        var exampleRolePolicy = new RolePolicy("exampleRolePolicy", RolePolicyArgs.builder()
            .name("cloudfront-realtime-log-config-example")
            .role(exampleRole.id())
            .policy(example.json())
            .build());

        var exampleRealtimeLogConfig = new RealtimeLogConfig("exampleRealtimeLogConfig", RealtimeLogConfigArgs.builder()
            .endpoint(RealtimeLogConfigEndpointArgs.builder()
                .kinesisStreamConfig(RealtimeLogConfigEndpointKinesisStreamConfigArgs.builder()
                    .roleArn(exampleRole.arn())
                    .streamArn(exampleAwsKinesisStream.arn())
                    .build())
                .streamType("Kinesis")
                .build())
            .name("example")
            .samplingRate(75)
            .fields(
                "timestamp",
                "c-ip")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleRolePolicy)
                .build());

    }
}
resources:
  exampleRole:
    type: aws:iam:Role
    name: example
    properties:
      name: cloudfront-realtime-log-config-example
      assumeRolePolicy: ${assumeRole.json}
  exampleRolePolicy:
    type: aws:iam:RolePolicy
    name: example
    properties:
      name: cloudfront-realtime-log-config-example
      role: ${exampleRole.id}
      policy: ${example.json}
  exampleRealtimeLogConfig:
    type: aws:cloudfront:RealtimeLogConfig
    name: example
    properties:
      endpoint:
        kinesisStreamConfig:
          roleArn: ${exampleRole.arn}
          streamArn: ${exampleAwsKinesisStream.arn}
        streamType: Kinesis
      name: example
      samplingRate: 75
      fields:
        - timestamp
        - c-ip
    options:
      dependsOn:
        - ${exampleRolePolicy}
variables:
  assumeRole:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - principals:
              - type: Service
                identifiers:
                  - cloudfront.amazonaws.com
            effect: Allow
            actions:
              - sts:AssumeRole
  example:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - effect: Allow
            actions:
              - kinesis:DescribeStreamSummary
              - kinesis:DescribeStream
              - kinesis:PutRecord
              - kinesis:PutRecords
            resources:
              - ${exampleAwsKinesisStream.arn}

Logging Custom Data From a CloudFront Function

A viewer request or viewer response CloudFront Function can write arbitrary data into the log record for the request by calling the cf.logCustomData() helper method, which requires JavaScript runtime 2.0 (cloudfront-js-2.0) and the cloudfront module. The data is surfaced in the viewer-request-log-data and viewer-response-log-data fields, which must be selected in the real-time log configuration for them to be delivered.

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

const example = new aws.cloudfront.Function("example", {
    name: "tag-request",
    runtime: "cloudfront-js-2.0",
    publish: true,
    code: `import cf from 'cloudfront';

function handler(event) {
  var variant = event.request.uri.indexOf(\\"/beta\\") === 0 ? \\"b\\" : \\"a\\";
  cf.logCustomData(\\"variant=\\" + variant);
  return event.request;
}
`,
});
const exampleRealtimeLogConfig = new aws.cloudfront.RealtimeLogConfig("example", {
    endpoint: {
        kinesisStreamConfig: {
            roleArn: exampleAwsIamRole.arn,
            streamArn: exampleAwsKinesisStream.arn,
        },
        streamType: "Kinesis",
    },
    name: "example",
    samplingRate: 100,
    fields: [
        "timestamp",
        "c-ip",
        "sc-status",
        "viewer-request-log-data",
        "viewer-response-log-data",
    ],
}, {
    dependsOn: [exampleAwsIamRolePolicy],
});
import pulumi
import pulumi_aws as aws

example = aws.cloudfront.Function("example",
    name="tag-request",
    runtime="cloudfront-js-2.0",
    publish=True,
    code="""import cf from 'cloudfront';

function handler(event) {
  var variant = event.request.uri.indexOf(\"/beta\") === 0 ? \"b\" : \"a\";
  cf.logCustomData(\"variant=\" + variant);
  return event.request;
}
""")
example_realtime_log_config = aws.cloudfront.RealtimeLogConfig("example",
    endpoint={
        "kinesis_stream_config": {
            "role_arn": example_aws_iam_role["arn"],
            "stream_arn": example_aws_kinesis_stream["arn"],
        },
        "stream_type": "Kinesis",
    },
    name="example",
    sampling_rate=100,
    fields=[
        "timestamp",
        "c-ip",
        "sc-status",
        "viewer-request-log-data",
        "viewer-response-log-data",
    ],
    opts = pulumi.ResourceOptions(depends_on=[example_aws_iam_role_policy]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.CloudFront.Function("example", new()
    {
        Name = "tag-request",
        Runtime = "cloudfront-js-2.0",
        Publish = true,
        Code = @"import cf from 'cloudfront';

function handler(event) {
  var variant = event.request.uri.indexOf(\""/beta\"") === 0 ? \""b\"" : \""a\"";
  cf.logCustomData(\""variant=\"" + variant);
  return event.request;
}
",
    });

    var exampleRealtimeLogConfig = new Aws.CloudFront.RealtimeLogConfig("example", new()
    {
        Endpoint = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointArgs
        {
            KinesisStreamConfig = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs
            {
                RoleArn = exampleAwsIamRole.Arn,
                StreamArn = exampleAwsKinesisStream.Arn,
            },
            StreamType = "Kinesis",
        },
        Name = "example",
        SamplingRate = 100,
        Fields = new[]
        {
            "timestamp",
            "c-ip",
            "sc-status",
            "viewer-request-log-data",
            "viewer-response-log-data",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsIamRolePolicy,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudfront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfront.NewFunction(ctx, "example", &cloudfront.FunctionArgs{
			Name:    pulumi.String("tag-request"),
			Runtime: pulumi.String("cloudfront-js-2.0"),
			Publish: pulumi.Bool(true),
			Code: pulumi.String(`import cf from 'cloudfront';

function handler(event) {
  var variant = event.request.uri.indexOf(\"/beta\") === 0 ? \"b\" : \"a\";
  cf.logCustomData(\"variant=\" + variant);
  return event.request;
}
`),
		})
		if err != nil {
			return err
		}
		_, err = cloudfront.NewRealtimeLogConfig(ctx, "example", &cloudfront.RealtimeLogConfigArgs{
			Endpoint: &cloudfront.RealtimeLogConfigEndpointArgs{
				KinesisStreamConfig: &cloudfront.RealtimeLogConfigEndpointKinesisStreamConfigArgs{
					RoleArn:   pulumi.Any(exampleAwsIamRole.Arn),
					StreamArn: pulumi.Any(exampleAwsKinesisStream.Arn),
				},
				StreamType: pulumi.String("Kinesis"),
			},
			Name:         pulumi.String("example"),
			SamplingRate: pulumi.Int(100),
			Fields: pulumi.StringArray{
				pulumi.String("timestamp"),
				pulumi.String("c-ip"),
				pulumi.String("sc-status"),
				pulumi.String("viewer-request-log-data"),
				pulumi.String("viewer-response-log-data"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsIamRolePolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudfront_function" "example" {
  name    = "tag-request"
  runtime = "cloudfront-js-2.0"
  publish = true
  code    = "import cf from 'cloudfront';\n\nfunction handler(event) {\n  var variant = event.request.uri.indexOf(\\\"/beta\\\") === 0 ? \\\"b\\\" : \\\"a\\\";\n  cf.logCustomData(\\\"variant=\\\" + variant);\n  return event.request;\n}\n"
}
resource "aws_cloudfront_realtimelogconfig" "example" {
  depends_on = [exampleAwsIamRolePolicy]
  endpoint = {
    kinesis_stream_config = {
      role_arn   = exampleAwsIamRole.arn
      stream_arn = exampleAwsKinesisStream.arn
    }
    stream_type = "Kinesis"
  }
  name          = "example"
  sampling_rate = 100
  fields        = ["timestamp", "c-ip", "sc-status", "viewer-request-log-data", "viewer-response-log-data"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.Function;
import com.pulumi.aws.cloudfront.FunctionArgs;
import com.pulumi.aws.cloudfront.RealtimeLogConfig;
import com.pulumi.aws.cloudfront.RealtimeLogConfigArgs;
import com.pulumi.aws.cloudfront.inputs.RealtimeLogConfigEndpointArgs;
import com.pulumi.aws.cloudfront.inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new Function("example", FunctionArgs.builder()
            .name("tag-request")
            .runtime("cloudfront-js-2.0")
            .publish(true)
            .code("""
import cf from 'cloudfront';

function handler(event) {
  var variant = event.request.uri.indexOf(\"/beta\") === 0 ? \"b\" : \"a\";
  cf.logCustomData(\"variant=\" + variant);
  return event.request;
}
            """)
            .build());

        var exampleRealtimeLogConfig = new RealtimeLogConfig("exampleRealtimeLogConfig", RealtimeLogConfigArgs.builder()
            .endpoint(RealtimeLogConfigEndpointArgs.builder()
                .kinesisStreamConfig(RealtimeLogConfigEndpointKinesisStreamConfigArgs.builder()
                    .roleArn(exampleAwsIamRole.arn())
                    .streamArn(exampleAwsKinesisStream.arn())
                    .build())
                .streamType("Kinesis")
                .build())
            .name("example")
            .samplingRate(100)
            .fields(
                "timestamp",
                "c-ip",
                "sc-status",
                "viewer-request-log-data",
                "viewer-response-log-data")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsIamRolePolicy)
                .build());

    }
}
resources:
  example:
    type: aws:cloudfront:Function
    properties:
      name: tag-request
      runtime: cloudfront-js-2.0
      publish: true
      code: |
        import cf from 'cloudfront';

        function handler(event) {
          var variant = event.request.uri.indexOf(\"/beta\") === 0 ? \"b\" : \"a\";
          cf.logCustomData(\"variant=\" + variant);
          return event.request;
        }
  exampleRealtimeLogConfig:
    type: aws:cloudfront:RealtimeLogConfig
    name: example
    properties:
      endpoint:
        kinesisStreamConfig:
          roleArn: ${exampleAwsIamRole.arn}
          streamArn: ${exampleAwsKinesisStream.arn}
        streamType: Kinesis
      name: example
      samplingRate: 100
      fields:
        - timestamp
        - c-ip
        - sc-status
        - viewer-request-log-data
        - viewer-response-log-data
    options:
      dependsOn:
        - ${exampleAwsIamRolePolicy}

Associate the function with a cache behavior on the distribution (functionAssociation with eventType = "viewer-request") and attach the real-time log configuration to the same cache behavior via realtimeLogConfigArn. The field is - for any request whose viewer request or viewer response function did not call cf.logCustomData().

Import

Identity Schema

Required

  • arn (String) ARN of the CloudFront real-time log configuration.

Using pulumi import, import CloudFront real-time log configurations using the ARN. For example:

$ pulumi import aws:cloudfront/realtimeLogConfig:RealtimeLogConfig example arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig

Constructors

RealtimeLogConfig(String name, {RealtimeLogConfigArgs? args, CustomResourceOptions? options})
Creates a new RealtimeLogConfig. name The Pulumi resource name. args Arguments used to configure this RealtimeLogConfig. The set of arguments for RealtimeLogConfig. options Resource options controlling this resource's behavior.
RealtimeLogConfig.reference(String urn)
Creates a typed reference to an existing RealtimeLogConfig resource.

Properties

arn ↔ Output<String>
ARN of the CloudFront real-time log configuration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
endpoint ↔ Output<RealtimeLogConfigEndpoint>
The Amazon Kinesis data streams where real-time log data is sent.
latefinal
fields ↔ Output<List<String>>
The fields that are included in each real-time log record. See the AWS documentation for supported values. This includes viewer-request-log-data and viewer-response-log-data, which carry the custom data that a CloudFront Function logs with cf.logCustomData().
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The unique name to identify this real-time log configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samplingRate ↔ Output<int>
The 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.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RealtimeLogConfigState? state, CustomResourceOptions? options}) → RealtimeLogConfig
Gets an existing RealtimeLogConfig resource's state with the given name and id.