1. Packages
  2. AWS
  3. API Docs
  4. cloudfront
  5. RealtimeLogConfig
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.cloudfront.RealtimeLogConfig

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides a CloudFront real-time log configuration resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const assumeRole = aws.iam.getPolicyDocument({
        statements: [{
            effect: "Allow",
            principals: [{
                type: "Service",
                identifiers: ["cloudfront.amazonaws.com"],
            }],
            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", {
        name: "example",
        samplingRate: 75,
        fields: [
            "timestamp",
            "c-ip",
        ],
        endpoint: {
            streamType: "Kinesis",
            kinesisStreamConfig: {
                roleArn: exampleRole.arn,
                streamArn: exampleAwsKinesisStream.arn,
            },
        },
    }, {
        dependsOn: [exampleRolePolicy],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    assume_role = aws.iam.get_policy_document(statements=[{
        "effect": "Allow",
        "principals": [{
            "type": "Service",
            "identifiers": ["cloudfront.amazonaws.com"],
        }],
        "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",
        name="example",
        sampling_rate=75,
        fields=[
            "timestamp",
            "c-ip",
        ],
        endpoint={
            "stream_type": "Kinesis",
            "kinesis_stream_config": {
                "role_arn": example_role.arn,
                "stream_arn": example_aws_kinesis_stream["arn"],
            },
        },
        opts = pulumi.ResourceOptions(depends_on=[example_role_policy]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudfront"
    	"github.com/pulumi/pulumi-aws/sdk/v6/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{
    {
    Effect: pulumi.StringRef("Allow"),
    Principals: []iam.GetPolicyDocumentStatementPrincipal{
    {
    Type: "Service",
    Identifiers: []string{
    "cloudfront.amazonaws.com",
    },
    },
    },
    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: interface{}{
    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(),
    Policy: pulumi.String(example.Json),
    })
    if err != nil {
    return err
    }
    _, err = cloudfront.NewRealtimeLogConfig(ctx, "example", &cloudfront.RealtimeLogConfigArgs{
    Name: pulumi.String("example"),
    SamplingRate: pulumi.Int(75),
    Fields: pulumi.StringArray{
    pulumi.String("timestamp"),
    pulumi.String("c-ip"),
    },
    Endpoint: &cloudfront.RealtimeLogConfigEndpointArgs{
    StreamType: pulumi.String("Kinesis"),
    KinesisStreamConfig: &cloudfront.RealtimeLogConfigEndpointKinesisStreamConfigArgs{
    RoleArn: exampleRole.Arn,
    StreamArn: pulumi.Any(exampleAwsKinesisStream.Arn),
    },
    },
    }, pulumi.DependsOn([]pulumi.Resource{
    exampleRolePolicy,
    }))
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    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
                {
                    Effect = "Allow",
                    Principals = new[]
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                        {
                            Type = "Service",
                            Identifiers = new[]
                            {
                                "cloudfront.amazonaws.com",
                            },
                        },
                    },
                    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()
        {
            Name = "example",
            SamplingRate = 75,
            Fields = new[]
            {
                "timestamp",
                "c-ip",
            },
            Endpoint = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointArgs
            {
                StreamType = "Kinesis",
                KinesisStreamConfig = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs
                {
                    RoleArn = exampleRole.Arn,
                    StreamArn = exampleAwsKinesisStream.Arn,
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleRolePolicy,
            },
        });
    
    });
    
    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.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.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 assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                .statements(GetPolicyDocumentStatementArgs.builder()
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("Service")
                        .identifiers("cloudfront.amazonaws.com")
                        .build())
                    .actions("sts:AssumeRole")
                    .build())
                .build());
    
            var exampleRole = new Role("exampleRole", RoleArgs.builder()
                .name("cloudfront-realtime-log-config-example")
                .assumeRolePolicy(assumeRole.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.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.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
                .build());
    
            var exampleRealtimeLogConfig = new RealtimeLogConfig("exampleRealtimeLogConfig", RealtimeLogConfigArgs.builder()
                .name("example")
                .samplingRate(75)
                .fields(            
                    "timestamp",
                    "c-ip")
                .endpoint(RealtimeLogConfigEndpointArgs.builder()
                    .streamType("Kinesis")
                    .kinesisStreamConfig(RealtimeLogConfigEndpointKinesisStreamConfigArgs.builder()
                        .roleArn(exampleRole.arn())
                        .streamArn(exampleAwsKinesisStream.arn())
                        .build())
                    .build())
                .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:
          name: example
          samplingRate: 75
          fields:
            - timestamp
            - c-ip
          endpoint:
            streamType: Kinesis
            kinesisStreamConfig:
              roleArn: ${exampleRole.arn}
              streamArn: ${exampleAwsKinesisStream.arn}
        options:
          dependson:
            - ${exampleRolePolicy}
    variables:
      assumeRole:
        fn::invoke:
          Function: aws:iam:getPolicyDocument
          Arguments:
            statements:
              - effect: Allow
                principals:
                  - type: Service
                    identifiers:
                      - cloudfront.amazonaws.com
                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}
    

    Create RealtimeLogConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RealtimeLogConfig(name: string, args: RealtimeLogConfigArgs, opts?: CustomResourceOptions);
    @overload
    def RealtimeLogConfig(resource_name: str,
                          args: RealtimeLogConfigArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def RealtimeLogConfig(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          endpoint: Optional[RealtimeLogConfigEndpointArgs] = None,
                          fields: Optional[Sequence[str]] = None,
                          sampling_rate: Optional[int] = None,
                          name: Optional[str] = None)
    func NewRealtimeLogConfig(ctx *Context, name string, args RealtimeLogConfigArgs, opts ...ResourceOption) (*RealtimeLogConfig, error)
    public RealtimeLogConfig(string name, RealtimeLogConfigArgs args, CustomResourceOptions? opts = null)
    public RealtimeLogConfig(String name, RealtimeLogConfigArgs args)
    public RealtimeLogConfig(String name, RealtimeLogConfigArgs args, CustomResourceOptions options)
    
    type: aws:cloudfront:RealtimeLogConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RealtimeLogConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RealtimeLogConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RealtimeLogConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RealtimeLogConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RealtimeLogConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var realtimeLogConfigResource = new Aws.CloudFront.RealtimeLogConfig("realtimeLogConfigResource", new()
    {
        Endpoint = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointArgs
        {
            KinesisStreamConfig = new Aws.CloudFront.Inputs.RealtimeLogConfigEndpointKinesisStreamConfigArgs
            {
                RoleArn = "string",
                StreamArn = "string",
            },
            StreamType = "string",
        },
        Fields = new[]
        {
            "string",
        },
        SamplingRate = 0,
        Name = "string",
    });
    
    example, err := cloudfront.NewRealtimeLogConfig(ctx, "realtimeLogConfigResource", &cloudfront.RealtimeLogConfigArgs{
    	Endpoint: &cloudfront.RealtimeLogConfigEndpointArgs{
    		KinesisStreamConfig: &cloudfront.RealtimeLogConfigEndpointKinesisStreamConfigArgs{
    			RoleArn:   pulumi.String("string"),
    			StreamArn: pulumi.String("string"),
    		},
    		StreamType: pulumi.String("string"),
    	},
    	Fields: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SamplingRate: pulumi.Int(0),
    	Name:         pulumi.String("string"),
    })
    
    var realtimeLogConfigResource = new RealtimeLogConfig("realtimeLogConfigResource", RealtimeLogConfigArgs.builder()
        .endpoint(RealtimeLogConfigEndpointArgs.builder()
            .kinesisStreamConfig(RealtimeLogConfigEndpointKinesisStreamConfigArgs.builder()
                .roleArn("string")
                .streamArn("string")
                .build())
            .streamType("string")
            .build())
        .fields("string")
        .samplingRate(0)
        .name("string")
        .build());
    
    realtime_log_config_resource = aws.cloudfront.RealtimeLogConfig("realtimeLogConfigResource",
        endpoint={
            "kinesis_stream_config": {
                "role_arn": "string",
                "stream_arn": "string",
            },
            "stream_type": "string",
        },
        fields=["string"],
        sampling_rate=0,
        name="string")
    
    const realtimeLogConfigResource = new aws.cloudfront.RealtimeLogConfig("realtimeLogConfigResource", {
        endpoint: {
            kinesisStreamConfig: {
                roleArn: "string",
                streamArn: "string",
            },
            streamType: "string",
        },
        fields: ["string"],
        samplingRate: 0,
        name: "string",
    });
    
    type: aws:cloudfront:RealtimeLogConfig
    properties:
        endpoint:
            kinesisStreamConfig:
                roleArn: string
                streamArn: string
            streamType: string
        fields:
            - string
        name: string
        samplingRate: 0
    

    RealtimeLogConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RealtimeLogConfig resource accepts the following input properties:

    Endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    Fields List<string>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    SamplingRate 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.
    Name string
    The unique name to identify this real-time log configuration.
    Endpoint RealtimeLogConfigEndpointArgs
    The Amazon Kinesis data streams where real-time log data is sent.
    Fields []string
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    SamplingRate 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.
    Name string
    The unique name to identify this real-time log configuration.
    endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    fields List<String>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    samplingRate Integer
    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.
    name String
    The unique name to identify this real-time log configuration.
    endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    fields string[]
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    samplingRate number
    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.
    name string
    The unique name to identify this real-time log configuration.
    endpoint RealtimeLogConfigEndpointArgs
    The Amazon Kinesis data streams where real-time log data is sent.
    fields Sequence[str]
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    sampling_rate 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.
    name str
    The unique name to identify this real-time log configuration.
    endpoint Property Map
    The Amazon Kinesis data streams where real-time log data is sent.
    fields List<String>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    samplingRate Number
    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.
    name String
    The unique name to identify this real-time log configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RealtimeLogConfig resource produces the following output properties:

    Arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RealtimeLogConfig Resource

    Get an existing RealtimeLogConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RealtimeLogConfigState, opts?: CustomResourceOptions): RealtimeLogConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            endpoint: Optional[RealtimeLogConfigEndpointArgs] = None,
            fields: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            sampling_rate: Optional[int] = None) -> RealtimeLogConfig
    func GetRealtimeLogConfig(ctx *Context, name string, id IDInput, state *RealtimeLogConfigState, opts ...ResourceOption) (*RealtimeLogConfig, error)
    public static RealtimeLogConfig Get(string name, Input<string> id, RealtimeLogConfigState? state, CustomResourceOptions? opts = null)
    public static RealtimeLogConfig get(String name, Output<String> id, RealtimeLogConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    Endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    Fields List<string>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    Name string
    The unique name to identify this real-time log configuration.
    SamplingRate 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.
    Arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    Endpoint RealtimeLogConfigEndpointArgs
    The Amazon Kinesis data streams where real-time log data is sent.
    Fields []string
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    Name string
    The unique name to identify this real-time log configuration.
    SamplingRate 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.
    arn String
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    fields List<String>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    name String
    The unique name to identify this real-time log configuration.
    samplingRate Integer
    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.
    arn string
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    endpoint RealtimeLogConfigEndpoint
    The Amazon Kinesis data streams where real-time log data is sent.
    fields string[]
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    name string
    The unique name to identify this real-time log configuration.
    samplingRate number
    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.
    arn str
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    endpoint RealtimeLogConfigEndpointArgs
    The Amazon Kinesis data streams where real-time log data is sent.
    fields Sequence[str]
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    name str
    The unique name to identify this real-time log configuration.
    sampling_rate 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.
    arn String
    The ARN (Amazon Resource Name) of the CloudFront real-time log configuration.
    endpoint Property Map
    The Amazon Kinesis data streams where real-time log data is sent.
    fields List<String>
    The fields that are included in each real-time log record. See the AWS documentation for supported values.
    name String
    The unique name to identify this real-time log configuration.
    samplingRate Number
    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.

    Supporting Types

    RealtimeLogConfigEndpoint, RealtimeLogConfigEndpointArgs

    KinesisStreamConfig RealtimeLogConfigEndpointKinesisStreamConfig
    The Amazon Kinesis data stream configuration.
    StreamType string
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.
    KinesisStreamConfig RealtimeLogConfigEndpointKinesisStreamConfig
    The Amazon Kinesis data stream configuration.
    StreamType string
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.
    kinesisStreamConfig RealtimeLogConfigEndpointKinesisStreamConfig
    The Amazon Kinesis data stream configuration.
    streamType String
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.
    kinesisStreamConfig RealtimeLogConfigEndpointKinesisStreamConfig
    The Amazon Kinesis data stream configuration.
    streamType string
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.
    kinesis_stream_config RealtimeLogConfigEndpointKinesisStreamConfig
    The Amazon Kinesis data stream configuration.
    stream_type str
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.
    kinesisStreamConfig Property Map
    The Amazon Kinesis data stream configuration.
    streamType String
    The type of data stream where real-time log data is sent. The only valid value is Kinesis.

    RealtimeLogConfigEndpointKinesisStreamConfig, RealtimeLogConfigEndpointKinesisStreamConfigArgs

    RoleArn string
    The 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
    The ARN of the Kinesis data stream.
    RoleArn string
    The 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
    The ARN of the Kinesis data stream.
    roleArn String
    The 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
    The ARN of the Kinesis data stream.
    roleArn string
    The 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
    The ARN of the Kinesis data stream.
    role_arn str
    The 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
    The ARN of the Kinesis data stream.
    roleArn String
    The 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
    The ARN of the Kinesis data stream.

    Import

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi