create_realtime_log_config¶
Operation¶
create_realtime_log_config
async
¶
create_realtime_log_config(request: CreateRealtimeLogConfigInput | CreateRealtimeLogConfigInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateRealtimeLogConfigOutput
create_realtime_log_config(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRealtimeLogConfigInputDict]) -> CreateRealtimeLogConfigOutput
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateRealtimeLogConfigOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CreateRealtimeLogConfigInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRealtimeLogConfigInput structure.
Attributes¶
end_points
class-attribute
instance-attribute
¶
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
fields
class-attribute
instance-attribute
¶
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
Dictionaries¶
CreateRealtimeLogConfigInputDict
¶
Bases: TypedDict
Dictionary form of CreateRealtimeLogConfigInput.
Attributes¶
end_points
instance-attribute
¶
end_points: Required[Sequence[EndPoint | EndPointDict]]
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
fields
instance-attribute
¶
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
name
instance-attribute
¶
A unique name to identify this real-time log configuration.
Output¶
CreateRealtimeLogConfigOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRealtimeLogConfigOutput structure.
Attributes¶
realtime_log_config
class-attribute
instance-attribute
¶
realtime_log_config: RealtimeLogConfig | None = ...
A real-time log configuration.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.