LogpushJob

Cloudflare v4.16.0 (4.x), Mar 9 26

Viewing docs for Cloudflare v4.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v4.16.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-cloudflare

Import

Import an account-scoped job.

 $ pulumi import cloudflare:index/logpushJob:LogpushJob example account/<account_id>/<job_id>

Import a zone-scoped job.

 $ pulumi import cloudflare:index/logpushJob:LogpushJob example zone/<zone_id>/<job_id>

Create LogpushJob Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LogpushJob(name: string, args: LogpushJobArgs, opts?: CustomResourceOptions);

@overload
def LogpushJob(resource_name: str,
               args: LogpushJobArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def LogpushJob(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               dataset: Optional[str] = None,
               destination_conf: Optional[str] = None,
               account_id: Optional[str] = None,
               enabled: Optional[bool] = None,
               filter: Optional[str] = None,
               frequency: Optional[str] = None,
               kind: Optional[str] = None,
               logpull_options: Optional[str] = None,
               name: Optional[str] = None,
               ownership_challenge: Optional[str] = None,
               zone_id: Optional[str] = None)

func NewLogpushJob(ctx *Context, name string, args LogpushJobArgs, opts ...ResourceOption) (*LogpushJob, error)

public LogpushJob(string name, LogpushJobArgs args, CustomResourceOptions? opts = null)

public LogpushJob(String name, LogpushJobArgs args)
public LogpushJob(String name, LogpushJobArgs args, CustomResourceOptions options)

type: cloudflare:LogpushJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args LogpushJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args LogpushJobArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LogpushJobArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LogpushJobArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LogpushJobArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var logpushJobResource = new Cloudflare.LogpushJob("logpushJobResource", new()
{
    Dataset = "string",
    DestinationConf = "string",
    AccountId = "string",
    Enabled = false,
    Filter = "string",
    Frequency = "string",
    Kind = "string",
    LogpullOptions = "string",
    Name = "string",
    OwnershipChallenge = "string",
    ZoneId = "string",
});

example, err := cloudflare.NewLogpushJob(ctx, "logpushJobResource", &cloudflare.LogpushJobArgs{
	Dataset:            pulumi.String("string"),
	DestinationConf:    pulumi.String("string"),
	AccountId:          pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	Filter:             pulumi.String("string"),
	Frequency:          pulumi.String("string"),
	Kind:               pulumi.String("string"),
	LogpullOptions:     pulumi.String("string"),
	Name:               pulumi.String("string"),
	OwnershipChallenge: pulumi.String("string"),
	ZoneId:             pulumi.String("string"),
})

var logpushJobResource = new LogpushJob("logpushJobResource", LogpushJobArgs.builder()
    .dataset("string")
    .destinationConf("string")
    .accountId("string")
    .enabled(false)
    .filter("string")
    .frequency("string")
    .kind("string")
    .logpullOptions("string")
    .name("string")
    .ownershipChallenge("string")
    .zoneId("string")
    .build());

logpush_job_resource = cloudflare.LogpushJob("logpushJobResource",
    dataset="string",
    destination_conf="string",
    account_id="string",
    enabled=False,
    filter="string",
    frequency="string",
    kind="string",
    logpull_options="string",
    name="string",
    ownership_challenge="string",
    zone_id="string")

const logpushJobResource = new cloudflare.LogpushJob("logpushJobResource", {
    dataset: "string",
    destinationConf: "string",
    accountId: "string",
    enabled: false,
    filter: "string",
    frequency: "string",
    kind: "string",
    logpullOptions: "string",
    name: "string",
    ownershipChallenge: "string",
    zoneId: "string",
});

type: cloudflare:LogpushJob
properties:
    accountId: string
    dataset: string
    destinationConf: string
    enabled: false
    filter: string
    frequency: string
    kind: string
    logpullOptions: string
    name: string
    ownershipChallenge: string
    zoneId: string

LogpushJob Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LogpushJob resource accepts the following input properties:

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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
DestinationConf 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. See Logpush destination documentation.
AccountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
Enabled bool: Whether to enable the job.
Filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
Frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
Kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
LogpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
Name string: The name of the logpush job to create.
OwnershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
ZoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
DestinationConf 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. See Logpush destination documentation.
AccountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
Enabled bool: Whether to enable the job.
Filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
Frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
Kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
LogpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
Name string: The name of the logpush job to create.
OwnershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
ZoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
accountId String: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
enabled Boolean: Whether to enable the job.
filter String: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency String: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind String: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions String: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name String: The name of the logpush job to create.
ownershipChallenge String: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId String: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
accountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
enabled boolean: Whether to enable the job.
filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name string: The name of the logpush job to create.
ownershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

dataset str: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destination_conf str: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation.
account_id str: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
enabled bool: Whether to enable the job.
filter str: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency str: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind str: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpull_options str: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name str: The name of the logpush job to create.
ownership_challenge str: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zone_id str: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
accountId String: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
enabled Boolean: Whether to enable the job.
filter String: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency String: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind String: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions String: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name String: The name of the logpush job to create.
ownershipChallenge String: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId String: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

Outputs

All input properties are implicitly available as output properties. Additionally, the LogpushJob resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing LogpushJob Resource

Get an existing LogpushJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LogpushJobState, opts?: CustomResourceOptions): LogpushJob

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        dataset: Optional[str] = None,
        destination_conf: Optional[str] = None,
        enabled: Optional[bool] = None,
        filter: Optional[str] = None,
        frequency: Optional[str] = None,
        kind: Optional[str] = None,
        logpull_options: Optional[str] = None,
        name: Optional[str] = None,
        ownership_challenge: Optional[str] = None,
        zone_id: Optional[str] = None) -> LogpushJob

func GetLogpushJob(ctx *Context, name string, id IDInput, state *LogpushJobState, opts ...ResourceOption) (*LogpushJob, error)

public static LogpushJob Get(string name, Input<string> id, LogpushJobState? state, CustomResourceOptions? opts = null)

public static LogpushJob get(String name, Output<String> id, LogpushJobState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:LogpushJob    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
DestinationConf 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. See Logpush destination documentation.
Enabled bool: Whether to enable the job.
Filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
Frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
Kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
LogpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
Name string: The name of the logpush job to create.
OwnershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
ZoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

AccountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
DestinationConf 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. See Logpush destination documentation.
Enabled bool: Whether to enable the job.
Filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
Frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
Kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
LogpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
Name string: The name of the logpush job to create.
OwnershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
ZoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

accountId String: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
enabled Boolean: Whether to enable the job.
filter String: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency String: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind String: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions String: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name String: The name of the logpush job to create.
ownershipChallenge String: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId String: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

accountId string: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
enabled boolean: Whether to enable the job.
filter string: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency string: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind string: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions string: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name string: The name of the logpush job to create.
ownershipChallenge string: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId string: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

account_id str: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
dataset str: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destination_conf str: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included. See Logpush destination documentation.
enabled bool: Whether to enable the job.
filter str: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency str: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind str: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpull_options str: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name str: The name of the logpush job to create.
ownership_challenge str: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zone_id str: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

accountId String: The account identifier to target for the resource. Must provide only one of account_id, zone_id.
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. See Logpush destination documentation. Available values: access_requests, firewall_events, http_requests, spectrum_events, nel_reports, audit_logs, gateway_dns, gateway_http, gateway_network, dns_logs, network_analytics_logs, workers_trace_events.
destinationConf 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. See Logpush destination documentation.
enabled Boolean: Whether to enable the job.
filter String: Use filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency String: A higher frequency will result in logs being pushed on faster with smaller files. low frequency will push logs less often with larger files. Available values: high, low. Defaults to high.
kind String: The kind of logpush job to create. Available values: edge, instant-logs, "".
logpullOptions String: Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.
name String: The name of the logpush job to create.
ownershipChallenge String: Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See Developer documentation.
zoneId String: The zone identifier to target for the resource. Must provide only one of account_id, zone_id.