import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cloudflare from "@pulumi/cloudflare"; * * const exampleLogpushJob = cloudflare.getLogpushJob({ * jobId: 1, * accountId: "account_id", * zoneId: "zone_id", * }); * ``` */ export declare function getLogpushJob(args?: GetLogpushJobArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getLogpushJob. */ export interface GetLogpushJobArgs { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ accountId?: string; /** * Unique id of the job. */ jobId?: number; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zoneId?: string; } /** * A collection of values returned by getLogpushJob. */ export interface GetLogpushJobResult { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ readonly accountId?: string; /** * Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/). * Available values: "access*requests", "audit*logs", "biso*user*actions", "casb*findings", "device*posture*results", "dlp*forensic*copies", "dns*firewall*logs", "dns*logs", "email*security*alerts", "firewall*events", "gateway*dns", "gateway*http", "gateway*network", "http*requests", "magic*ids*detections", "nel*reports", "network*analytics*logs", "page*shield*events", "sinkhole*http*logs", "spectrum*events", "ssh*logs", "workers*trace*events", "zaraz*events", "zero*trust*network*sessions". */ readonly dataset: string; /** * Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. */ readonly destinationConf: string; /** * Flag that indicates if the job is enabled. */ readonly enabled: boolean; /** * If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error*message and last*error are set to null. */ readonly errorMessage: string; /** * 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". * * @deprecated This attribute is deprecated. */ readonly frequency: string; /** * Unique id of the job. */ readonly id: number; /** * Unique id of the job. */ readonly jobId?: number; /** * The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only supported for the `httpRequests` dataset. * Available values: "edge". */ readonly kind: string; /** * Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty. */ readonly lastComplete: string; /** * Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the errorMessage field. */ readonly lastError: string; /** * This field is deprecated. Use `outputOptions` 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. * * @deprecated This attribute is deprecated. */ readonly logpullOptions: string; /** * 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. */ readonly maxUploadBytes: number; /** * 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. */ readonly maxUploadIntervalSeconds: number; /** * 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. */ readonly maxUploadRecords: number; /** * 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. */ readonly name: string; /** * The structured replacement for `logpullOptions`. When including this field, the `logpullOption` field will be ignored. */ readonly outputOptions: outputs.GetLogpushJobOutputOptions; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ readonly zoneId?: string; } /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cloudflare from "@pulumi/cloudflare"; * * const exampleLogpushJob = cloudflare.getLogpushJob({ * jobId: 1, * accountId: "account_id", * zoneId: "zone_id", * }); * ``` */ export declare function getLogpushJobOutput(args?: GetLogpushJobOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getLogpushJob. */ export interface GetLogpushJobOutputArgs { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ accountId?: pulumi.Input; /** * Unique id of the job. */ jobId?: pulumi.Input; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zoneId?: pulumi.Input; }