| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudFront.UpdateRealtimeLogConfig
Description
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
- Call
GetRealtimeLogConfigto get the current real-time log configuration. - Locally modify the parameters in the real-time log configuration that you want to update.
- Call this API (
UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's Name or ARN.
Synopsis
- data UpdateRealtimeLogConfig = UpdateRealtimeLogConfig' {}
- newUpdateRealtimeLogConfig :: UpdateRealtimeLogConfig
- updateRealtimeLogConfig_arn :: Lens' UpdateRealtimeLogConfig (Maybe Text)
- updateRealtimeLogConfig_endPoints :: Lens' UpdateRealtimeLogConfig (Maybe [EndPoint])
- updateRealtimeLogConfig_fields :: Lens' UpdateRealtimeLogConfig (Maybe [Text])
- updateRealtimeLogConfig_name :: Lens' UpdateRealtimeLogConfig (Maybe Text)
- updateRealtimeLogConfig_samplingRate :: Lens' UpdateRealtimeLogConfig (Maybe Integer)
- data UpdateRealtimeLogConfigResponse = UpdateRealtimeLogConfigResponse' {}
- newUpdateRealtimeLogConfigResponse :: Int -> UpdateRealtimeLogConfigResponse
- updateRealtimeLogConfigResponse_realtimeLogConfig :: Lens' UpdateRealtimeLogConfigResponse (Maybe RealtimeLogConfig)
- updateRealtimeLogConfigResponse_httpStatus :: Lens' UpdateRealtimeLogConfigResponse Int
Creating a Request
data UpdateRealtimeLogConfig Source #
See: newUpdateRealtimeLogConfig smart constructor.
Constructors
| UpdateRealtimeLogConfig' | |
Fields
| |
Instances
newUpdateRealtimeLogConfig :: UpdateRealtimeLogConfig Source #
Create a value of UpdateRealtimeLogConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRealtimeLogConfig, updateRealtimeLogConfig_arn - The Amazon Resource Name (ARN) for this real-time log configuration.
UpdateRealtimeLogConfig, updateRealtimeLogConfig_endPoints - Contains information about the Amazon Kinesis data stream where you are
sending real-time log data.
UpdateRealtimeLogConfig, updateRealtimeLogConfig_fields - 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.
UpdateRealtimeLogConfig, updateRealtimeLogConfig_name - The name for this real-time log configuration.
UpdateRealtimeLogConfig, updateRealtimeLogConfig_samplingRate - 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. You must provide an integer between 1 and
100, inclusive.
Request Lenses
updateRealtimeLogConfig_arn :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) for this real-time log configuration.
updateRealtimeLogConfig_endPoints :: Lens' UpdateRealtimeLogConfig (Maybe [EndPoint]) Source #
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
updateRealtimeLogConfig_fields :: Lens' UpdateRealtimeLogConfig (Maybe [Text]) Source #
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.
updateRealtimeLogConfig_name :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #
The name for this real-time log configuration.
updateRealtimeLogConfig_samplingRate :: Lens' UpdateRealtimeLogConfig (Maybe Integer) Source #
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. You must provide an integer between 1 and 100, inclusive.
Destructuring the Response
data UpdateRealtimeLogConfigResponse Source #
See: newUpdateRealtimeLogConfigResponse smart constructor.
Constructors
| UpdateRealtimeLogConfigResponse' | |
Fields
| |
Instances
newUpdateRealtimeLogConfigResponse Source #
Create a value of UpdateRealtimeLogConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:realtimeLogConfig:UpdateRealtimeLogConfigResponse', updateRealtimeLogConfigResponse_realtimeLogConfig - A real-time log configuration.
$sel:httpStatus:UpdateRealtimeLogConfigResponse', updateRealtimeLogConfigResponse_httpStatus - The response's http status code.
Response Lenses
updateRealtimeLogConfigResponse_realtimeLogConfig :: Lens' UpdateRealtimeLogConfigResponse (Maybe RealtimeLogConfig) Source #
A real-time log configuration.
updateRealtimeLogConfigResponse_httpStatus :: Lens' UpdateRealtimeLogConfigResponse Int Source #
The response's http status code.