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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.getRealtimeLogConfig

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CloudFront::RealtimeLogConfig

    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(arn: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRealtimeLogConfigResult
def get_realtime_log_config_output(arn: 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-native:cloudfront:getRealtimeLogConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    Arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    arn str
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .

    getRealtimeLogConfig Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    EndPoints List<Pulumi.AwsNative.CloudFront.Outputs.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.
    Arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    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 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.
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    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.
    arn string
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    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.
    arn str
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    end_points Sequence[RealtimeLogConfigEndPoint]
    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.
    arn String
    The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .
    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.

    Supporting Types

    RealtimeLogConfigEndPoint

    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

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native