LogpushJobArgs

data class LogpushJobArgs(val accountId: Output<String>? = null, val dataset: Output<String>? = null, val destinationConf: Output<String>? = null, val enabled: Output<Boolean>? = null, val frequency: Output<String>? = null, val kind: Output<String>? = null, val logpullOptions: Output<String>? = null, val maxUploadBytes: Output<Int>? = null, val maxUploadIntervalSeconds: Output<Int>? = null, val maxUploadRecords: Output<Int>? = null, val name: Output<String>? = null, val outputOptions: Output<LogpushJobOutputOptionsArgs>? = null, val ownershipChallenge: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<LogpushJobArgs>

Example Usage

resources:
exampleLogpushJob:
type: cloudflare:LogpushJob
name: example_logpush_job
properties:
destinationConf: s3://mybucket/logs?region=us-west-2
zoneId: zone_id
dataset: http_requests
enabled: false
frequency: high
kind: edge
logpullOptions: fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339
maxUploadBytes: 5e+06
maxUploadIntervalSeconds: 30
maxUploadRecords: 1000
name: example.com
outputOptions:
batch_prefix: batch_prefix
batch_suffix: batch_suffix
cve_2021_44228: true
field_delimiter: field_delimiter
field_names:
- ClientIP
- EdgeStartTimestamp
- RayID
output_type: ndjson
record_delimiter: record_delimiter
record_prefix: record_prefix
record_suffix: record_suffix
record_template: record_template
sample_rate: 0
timestamp_format: unixnano
ownershipChallenge: '00000000000000000000'

Import

$ pulumi import cloudflare:index/logpushJob:LogpushJob example '<{accounts|zones}/{account_id|zone_id}>/<job_id>'

Constructors

Link copied to clipboard
constructor(accountId: Output<String>? = null, dataset: Output<String>? = null, destinationConf: Output<String>? = null, enabled: Output<Boolean>? = null, frequency: Output<String>? = null, kind: Output<String>? = null, logpullOptions: Output<String>? = null, maxUploadBytes: Output<Int>? = null, maxUploadIntervalSeconds: Output<Int>? = null, maxUploadRecords: Output<Int>? = null, name: Output<String>? = null, outputOptions: Output<LogpushJobOutputOptionsArgs>? = null, ownershipChallenge: Output<String>? = null, zoneId: Output<String>? = null)

Properties

Link copied to clipboard
val accountId: Output<String>? = null

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

Link copied to clipboard
val dataset: Output<String>? = null

Name of the dataset. A list of supported datasets can be found on the Developer Docs.

Link copied to clipboard
val destinationConf: Output<String>? = null

Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

Link copied to clipboard
val enabled: Output<Boolean>? = null

Flag that indicates if the job is enabled.

Link copied to clipboard
val frequency: Output<String>? = null

This field is deprecated. Please use max_upload_* parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files. Available values: "high", "low".

Link copied to clipboard
val kind: Output<String>? = null

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only supported for the http_requests dataset. Available values: "edge".

Link copied to clipboard
val logpullOptions: Output<String>? = null

This field is deprecated. Use output_options instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

Link copied to clipboard
val maxUploadBytes: Output<Int>? = null

The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB, or 0 to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. This parameter is not available for jobs with edge as its kind.

Link copied to clipboard
val maxUploadIntervalSeconds: Output<Int>? = null

The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or 0 to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. This parameter is only used for jobs with edge as its kind.

Link copied to clipboard
val maxUploadRecords: Output<Int>? = null

The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or 0 to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this. This parameter is not available for jobs with edge as its kind.

Link copied to clipboard
val name: Output<String>? = null

Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.

Link copied to clipboard

The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored.

Link copied to clipboard
val ownershipChallenge: Output<String>? = null

Ownership challenge token to prove destination ownership.

Link copied to clipboard
val zoneId: Output<String>? = null

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

Functions

Link copied to clipboard
open override fun toJava(): LogpushJobArgs