1. Packages
  2. AWS Native
  3. API Docs
  4. cloudfront
  5. RealtimeLogConfig

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.cloudfront.RealtimeLogConfig

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::CloudFront::RealtimeLogConfig

    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,
                          end_points: Optional[Sequence[RealtimeLogConfigEndPointArgs]] = None,
                          fields: Optional[Sequence[str]] = None,
                          sampling_rate: Optional[float] = 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-native: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.

    Example

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

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const realtimeLogConfigResource = new aws_native.cloudfront.RealtimeLogConfig("realtimeLogConfigResource", {
        endPoints: [{
            kinesisStreamConfig: {
                roleArn: "string",
                streamArn: "string",
            },
            streamType: "string",
        }],
        fields: ["string"],
        samplingRate: 0,
        name: "string",
    });
    
    Coming soon!
    

    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

    The RealtimeLogConfig resource accepts the following input properties:

    EndPoints List<Pulumi.AwsNative.CloudFront.Inputs.RealtimeLogConfigEndPoint>
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    Fields List<string>

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    SamplingRate double
    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. The sampling rate is an integer between 1 and 100, inclusive.
    Name string
    The unique name of this real-time log configuration.
    EndPoints []RealtimeLogConfigEndPointArgs
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    Fields []string

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    SamplingRate float64
    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. The sampling rate is an integer between 1 and 100, inclusive.
    Name string
    The unique name of this real-time log configuration.
    endPoints List<RealtimeLogConfigEndPoint>
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    fields List<String>

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    samplingRate Double
    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. The sampling rate is an integer between 1 and 100, inclusive.
    name String
    The unique name of this real-time log configuration.
    endPoints RealtimeLogConfigEndPoint[]
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    fields string[]

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    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. The sampling rate is an integer between 1 and 100, inclusive.
    name string
    The unique name of this real-time log configuration.
    end_points Sequence[RealtimeLogConfigEndPointArgs]
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    fields Sequence[str]

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    sampling_rate float
    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. The sampling rate is an integer between 1 and 100, inclusive.
    name str
    The unique name of this real-time log configuration.
    endPoints List<Property Map>
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
    fields List<String>

    A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

    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. The sampling rate is an integer between 1 and 100, inclusive.
    name String
    The unique name of 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 Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    RealtimeLogConfigEndPoint, RealtimeLogConfigEndPointArgs

    KinesisStreamConfig Pulumi.AwsNative.CloudFront.Inputs.RealtimeLogConfigKinesisStreamConfig
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    StreamType string
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
    KinesisStreamConfig RealtimeLogConfigKinesisStreamConfig
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    StreamType string
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
    kinesisStreamConfig RealtimeLogConfigKinesisStreamConfig
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    streamType String
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
    kinesisStreamConfig RealtimeLogConfigKinesisStreamConfig
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    streamType string
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
    kinesis_stream_config RealtimeLogConfigKinesisStreamConfig
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    stream_type str
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .
    kinesisStreamConfig Property Map
    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
    streamType String
    The type of data stream where you are sending real-time log data. The only valid value is Kinesis .

    RealtimeLogConfigKinesisStreamConfig, RealtimeLogConfigKinesisStreamConfigArgs

    RoleArn string

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    StreamArn string
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
    RoleArn string

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    StreamArn string
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
    roleArn String

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    streamArn String
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
    roleArn string

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    streamArn string
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
    role_arn str

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    stream_arn str
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
    roleArn String

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

    For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

    streamArn String
    The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi