Package com.pulumi.cloudflare

Class LogpushJob

  • public class LogpushJob
extends com.pulumi.resources.CustomResource
    ## Import Import an account-scoped job. ```sh $ pulumi import cloudflare:index/logpushJob:LogpushJob example account/<account_id>/<job_id> ``` Import a zone-scoped job. ```sh $ pulumi import cloudflare:index/logpushJob:LogpushJob example zone/<zone_id>/<job_id> ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> accountId()  
      com.pulumi.core.Output<java.lang.String> dataset()  
      com.pulumi.core.Output<java.lang.String> destinationConf()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> filter()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> frequency()  
      static LogpushJob get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LogpushJobState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kind()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> logpullOptions()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadBytes()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadIntervalSeconds()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadRecords()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ownershipChallenge()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> zoneId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • LogpushJob

        public LogpushJob​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • LogpushJob

        public LogpushJob​(java.lang.String name,
                  LogpushJobArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • LogpushJob

        public LogpushJob​(java.lang.String name,
                  LogpushJobArgs args,
                  @Nullable
                  com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accountId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accountId()
        Returns:
        The account identifier to target for the resource. Must provide only one of `account_id`, `zone_id`.

      • dataset

        public com.pulumi.core.Output<java.lang.String> dataset()
        Returns:
        The kind of the dataset to use with the logpush job. Available values: `access_requests`, `casb_findings`, `firewall_events`, `http_requests`, `spectrum_events`, `nel_reports`, `audit_logs`, `gateway_dns`, `gateway_http`, `gateway_network`, `dns_logs`, `network_analytics_logs`, `workers_trace_events`, `device_posture_results`, `zero_trust_network_sessions`, `magic_ids_detections`.

      • destinationConf

        public com.pulumi.core.Output<java.lang.String> destinationConf()
        Returns:
        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](https://developers.cloudflare.com/logs/reference/logpush-api-configuration#destination).

      • enabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()
        Returns:
        Whether to enable the job.

      • filter

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> filter()
        Returns:
        Use filters to select the events to include and/or remove from your logs. For more information, refer to [Filters](https://developers.cloudflare.com/logs/reference/logpush-api-configuration/filters/).

      • frequency

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> frequency()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kind()
        Returns:
        The kind of logpush job to create. Available values: `edge`, `instant-logs`, `""`.

      • logpullOptions

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> logpullOptions()
        Returns:
        Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See [Logpush options documentation](https://developers.cloudflare.com/logs/logpush/logpush-configuration-api/understanding-logpush-api/#options).

      • maxUploadBytes

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadBytes()
        Returns:
        The maximum uncompressed file size of a batch of logs. Value must be between 5MB and 1GB.

      • maxUploadIntervalSeconds

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadIntervalSeconds()
        Returns:
        The maximum interval in seconds for log batches. Value must be between 30 and 300.

      • maxUploadRecords

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxUploadRecords()
        Returns:
        The maximum number of log lines per batch. Value must be between 1000 and 1,000,000.

      • name

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> name()
        Returns:
        The name of the logpush job to create.

      • ownershipChallenge

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ownershipChallenge()
        Returns:
        Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic. See [Developer documentation](https://developers.cloudflare.com/logs/logpush/logpush-configuration-api/understanding-logpush-api/#usage).

      • zoneId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> zoneId()
        Returns:
        The zone identifier to target for the resource. Must provide only one of `account_id`, `zone_id`.

      • get

        public static LogpushJob get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             LogpushJobState state,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.