logpushJob.typescript.md

logpushJob Submodule

Constructs

LogpushJob

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job cloudflare_logpush_job}.

Initializers

import { logpushJob } from '@cdktf/provider-cloudflare'

new logpushJob.LogpushJob(scope: Construct, id: string, config: LogpushJobConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	LogpushJobConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: LogpushJobConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putOutputOptions	No description.
resetAccountId	No description.
resetDataset	No description.
resetEnabled	No description.
resetFilter	No description.
resetFrequency	No description.
resetKind	No description.
resetLogpullOptions	No description.
resetMaxUploadBytes	No description.
resetMaxUploadIntervalSeconds	No description.
resetMaxUploadRecords	No description.
resetName	No description.
resetOutputOptions	No description.
resetOwnershipChallenge	No description.
resetZoneId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putOutputOptions

public putOutputOptions(value: LogpushJobOutputOptions): void

value^Required

• Type: LogpushJobOutputOptions

---

resetAccountId

public resetAccountId(): void

resetDataset

public resetDataset(): void

resetEnabled

public resetEnabled(): void

resetFilter

public resetFilter(): void

resetFrequency

public resetFrequency(): void

resetKind

public resetKind(): void

resetLogpullOptions

public resetLogpullOptions(): void

resetMaxUploadBytes

public resetMaxUploadBytes(): void

resetMaxUploadIntervalSeconds

public resetMaxUploadIntervalSeconds(): void

resetMaxUploadRecords

public resetMaxUploadRecords(): void

resetName

public resetName(): void

resetOutputOptions

public resetOutputOptions(): void

resetOwnershipChallenge

public resetOwnershipChallenge(): void

resetZoneId

public resetZoneId(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a LogpushJob resource upon running "cdktf plan ".

---

isConstruct

import { logpushJob } from '@cdktf/provider-cloudflare'

logpushJob.LogpushJob.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { logpushJob } from '@cdktf/provider-cloudflare'

logpushJob.LogpushJob.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { logpushJob } from '@cdktf/provider-cloudflare'

logpushJob.LogpushJob.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { logpushJob } from '@cdktf/provider-cloudflare'

logpushJob.LogpushJob.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a LogpushJob resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the LogpushJob to import.

---

importFromId^Required

• Type: string

The id of the existing LogpushJob that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the LogpushJob to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
errorMessage	string	No description.
id	number	No description.
lastComplete	string	No description.
lastError	string	No description.
outputOptions	LogpushJobOutputOptionsOutputReference	No description.
accountIdInput	string	No description.
datasetInput	string	No description.
destinationConfInput	string	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
filterInput	string	No description.
frequencyInput	string	No description.
kindInput	string	No description.
logpullOptionsInput	string	No description.
maxUploadBytesInput	number	No description.
maxUploadIntervalSecondsInput	number	No description.
maxUploadRecordsInput	number	No description.
nameInput	string	No description.
outputOptionsInput	cdktf.IResolvable | LogpushJobOutputOptions	No description.
ownershipChallengeInput	string	No description.
zoneIdInput	string	No description.
accountId	string	No description.
dataset	string	No description.
destinationConf	string	No description.
enabled	boolean | cdktf.IResolvable	No description.
filter	string	No description.
frequency	string	No description.
kind	string	No description.
logpullOptions	string	No description.
maxUploadBytes	number	No description.
maxUploadIntervalSeconds	number	No description.
maxUploadRecords	number	No description.
name	string	No description.
ownershipChallenge	string	No description.
zoneId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

errorMessage^Required

public readonly errorMessage: string;

• Type: string

---

id^Required

public readonly id: number;

• Type: number

---

lastComplete^Required

public readonly lastComplete: string;

• Type: string

---

lastError^Required

public readonly lastError: string;

• Type: string

---

outputOptions^Required

public readonly outputOptions: LogpushJobOutputOptionsOutputReference;

• Type: LogpushJobOutputOptionsOutputReference

---

accountIdInput^Optional

public readonly accountIdInput: string;

• Type: string

---

datasetInput^Optional

public readonly datasetInput: string;

• Type: string

---

destinationConfInput^Optional

public readonly destinationConfInput: string;

• Type: string

---

enabledInput^Optional

public readonly enabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

filterInput^Optional

public readonly filterInput: string;

• Type: string

---

frequencyInput^Optional

public readonly frequencyInput: string;

• Type: string

---

kindInput^Optional

public readonly kindInput: string;

• Type: string

---

logpullOptionsInput^Optional

public readonly logpullOptionsInput: string;

• Type: string

---

maxUploadBytesInput^Optional

public readonly maxUploadBytesInput: number;

• Type: number

---

maxUploadIntervalSecondsInput^Optional

public readonly maxUploadIntervalSecondsInput: number;

• Type: number

---

maxUploadRecordsInput^Optional

public readonly maxUploadRecordsInput: number;

• Type: number

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

outputOptionsInput^Optional

public readonly outputOptionsInput: IResolvable | LogpushJobOutputOptions;

• Type: cdktf.IResolvable | LogpushJobOutputOptions

---

ownershipChallengeInput^Optional

public readonly ownershipChallengeInput: string;

• Type: string

---

zoneIdInput^Optional

public readonly zoneIdInput: string;

• Type: string

---

accountId^Required

public readonly accountId: string;

• Type: string

---

dataset^Required

public readonly dataset: string;

• Type: string

---

destinationConf^Required

public readonly destinationConf: string;

• Type: string

---

enabled^Required

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

filter^Required

public readonly filter: string;

• Type: string

---

frequency^Required

public readonly frequency: string;

• Type: string

---

kind^Required

public readonly kind: string;

• Type: string

---

logpullOptions^Required

public readonly logpullOptions: string;

• Type: string

---

maxUploadBytes^Required

public readonly maxUploadBytes: number;

• Type: number

---

maxUploadIntervalSeconds^Required

public readonly maxUploadIntervalSeconds: number;

• Type: number

---

maxUploadRecords^Required

public readonly maxUploadRecords: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

ownershipChallenge^Required

public readonly ownershipChallenge: string;

• Type: string

---

zoneId^Required

public readonly zoneId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

LogpushJobConfig

Initializer

import { logpushJob } from '@cdktf/provider-cloudflare'

const logpushJobConfig: logpushJob.LogpushJobConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
destinationConf	string	Uniquely identifies a resource (such as an s3 bucket) where data.
accountId	string	The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
dataset	string	Name of the dataset.
enabled	boolean | cdktf.IResolvable	Flag that indicates if the job is enabled.
filter	string	The filters to select the events to include and/or remove from your logs. For more information, refer to Filters.
frequency	string	This field is deprecated.
kind	string	The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).
logpullOptions	string	This field is deprecated.
maxUploadBytes	number	The maximum uncompressed file size of a batch of logs.
maxUploadIntervalSeconds	number	The maximum interval in seconds for log batches.
maxUploadRecords	number	The maximum number of log lines per batch.
name	string	Optional human readable job name.
outputOptions	LogpushJobOutputOptions	The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored.
ownershipChallenge	string	Ownership challenge token to prove destination ownership.
zoneId	string	The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

destinationConf^Required

public readonly destinationConf: string;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#destination_conf LogpushJob#destination_conf}

---

accountId^Optional

public readonly accountId: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#account_id LogpushJob#account_id}

---

dataset^Optional

public readonly dataset: string;

• Type: string

Name of the dataset.

A list of supported datasets can be found on the Developer Docs. Available values: "access_requests", "audit_logs", "audit_logs_v2", "biso_user_actions", "casb_findings", "device_posture_results", "dex_application_tests", "dex_device_state_events", "dlp_forensic_copies", "dns_firewall_logs", "dns_logs", "email_security_alerts", "firewall_events", "gateway_dns", "gateway_http", "gateway_network", "http_requests", "ipsec_logs", "magic_ids_detections", "nel_reports", "network_analytics_logs", "page_shield_events", "sinkhole_http_logs", "spectrum_events", "ssh_logs", "warp_config_changes", "warp_toggle_changes", "workers_trace_events", "zaraz_events", "zero_trust_network_sessions".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#dataset LogpushJob#dataset}

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Flag that indicates if the job is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#enabled LogpushJob#enabled}

---

filter^Optional

public readonly filter: string;

• Type: string

The filters to select the events to include and/or remove from your logs. For more information, refer to Filters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#filter LogpushJob#filter}

---

frequency^Optional

public readonly frequency: string;

• Type: 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".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#frequency LogpushJob#frequency}

---

kind^Optional

public readonly kind: string;

• Type: string

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).

Available values: "", "edge".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#kind LogpushJob#kind}

---

logpullOptions^Optional

public readonly logpullOptions: string;

• Type: string

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#logpull_options LogpushJob#logpull_options}

---

maxUploadBytes^Optional

public readonly maxUploadBytes: number;

• Type: number

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#max_upload_bytes LogpushJob#max_upload_bytes}

---

maxUploadIntervalSeconds^Optional

public readonly maxUploadIntervalSeconds: number;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#max_upload_interval_seconds LogpushJob#max_upload_interval_seconds}

---

maxUploadRecords^Optional

public readonly maxUploadRecords: number;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#max_upload_records LogpushJob#max_upload_records}

---

name^Optional

public readonly name: string;

• Type: string

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#name LogpushJob#name}

---

outputOptions^Optional

public readonly outputOptions: LogpushJobOutputOptions;

• Type: LogpushJobOutputOptions

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#output_options LogpushJob#output_options}

---

ownershipChallenge^Optional

public readonly ownershipChallenge: string;

• Type: string

Ownership challenge token to prove destination ownership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#ownership_challenge LogpushJob#ownership_challenge}

---

zoneId^Optional

public readonly zoneId: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#zone_id LogpushJob#zone_id}

---

LogpushJobOutputOptions

Initializer

import { logpushJob } from '@cdktf/provider-cloudflare'

const logpushJobOutputOptions: logpushJob.LogpushJobOutputOptions = { ... }

Properties

Name	Type	Description
batchPrefix	string	String to be prepended before each batch.
batchSuffix	string	String to be appended after each batch.
cve202144228	boolean | cdktf.IResolvable	If set to true, will cause all occurrences of ${ in the generated files to be replaced with x{.
fieldDelimiter	string	String to join fields. This field be ignored when record_template is set.
fieldNames	string[]	List of field names to be included in the Logpush output.
outputType	string	Specifies the output type, such as ndjson or csv.
recordDelimiter	string	String to be inserted in-between the records as separator.
recordPrefix	string	String to be prepended before each record.
recordSuffix	string	String to be appended after each record.
recordTemplate	string	String to use as template for each record instead of the default json key value mapping.
sampleRate	number	Floating number to specify sampling rate.
timestampFormat	string	String to specify the format for timestamps, such as unixnano, unix, or rfc3339. Available values: "unixnano", "unix", "rfc3339".

---

batchPrefix^Optional

public readonly batchPrefix: string;

• Type: string

String to be prepended before each batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#batch_prefix LogpushJob#batch_prefix}

---

batchSuffix^Optional

public readonly batchSuffix: string;

• Type: string

String to be appended after each batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#batch_suffix LogpushJob#batch_suffix}

---

cve202144228^Optional

public readonly cve202144228: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set to true, will cause all occurrences of ${ in the generated files to be replaced with x{.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#cve_2021_44228 LogpushJob#cve_2021_44228}

---

fieldDelimiter^Optional

public readonly fieldDelimiter: string;

• Type: string

String to join fields. This field be ignored when record_template is set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#field_delimiter LogpushJob#field_delimiter}

---

fieldNames^Optional

public readonly fieldNames: string[];

• Type: string[]

List of field names to be included in the Logpush output.

For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#field_names LogpushJob#field_names}

---

outputType^Optional

public readonly outputType: string;

• Type: string

Specifies the output type, such as ndjson or csv.

This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types. Available values: "ndjson", "csv".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#output_type LogpushJob#output_type}

---

recordDelimiter^Optional

public readonly recordDelimiter: string;

• Type: string

String to be inserted in-between the records as separator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#record_delimiter LogpushJob#record_delimiter}

---

recordPrefix^Optional

public readonly recordPrefix: string;

• Type: string

String to be prepended before each record.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#record_prefix LogpushJob#record_prefix}

---

recordSuffix^Optional

public readonly recordSuffix: string;

• Type: string

String to be appended after each record.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#record_suffix LogpushJob#record_suffix}

---

recordTemplate^Optional

public readonly recordTemplate: string;

• Type: string

String to use as template for each record instead of the default json key value mapping.

All fields used in the template must be present in field_names as well, otherwise they will end up as null. Format as a Go text/template without any standard functions, like conditionals, loops, sub-templates, etc.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#record_template LogpushJob#record_template}

---

sampleRate^Optional

public readonly sampleRate: number;

• Type: number

Floating number to specify sampling rate.

Sampling is applied on top of filtering, and regardless of the current sample_interval of the data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#sample_rate LogpushJob#sample_rate}

---

timestampFormat^Optional

public readonly timestampFormat: string;

• Type: string

String to specify the format for timestamps, such as unixnano, unix, or rfc3339. Available values: "unixnano", "unix", "rfc3339".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/logpush_job#timestamp_format LogpushJob#timestamp_format}

---

Classes

LogpushJobOutputOptionsOutputReference

Initializers

import { logpushJob } from '@cdktf/provider-cloudflare'

new logpushJob.LogpushJobOutputOptionsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetBatchPrefix	No description.
resetBatchSuffix	No description.
resetCve202144228	No description.
resetFieldDelimiter	No description.
resetFieldNames	No description.
resetOutputType	No description.
resetRecordDelimiter	No description.
resetRecordPrefix	No description.
resetRecordSuffix	No description.
resetRecordTemplate	No description.
resetSampleRate	No description.
resetTimestampFormat	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBatchPrefix

public resetBatchPrefix(): void

resetBatchSuffix

public resetBatchSuffix(): void

resetCve202144228

public resetCve202144228(): void

resetFieldDelimiter

public resetFieldDelimiter(): void

resetFieldNames

public resetFieldNames(): void

resetOutputType

public resetOutputType(): void

resetRecordDelimiter

public resetRecordDelimiter(): void

resetRecordPrefix

public resetRecordPrefix(): void

resetRecordSuffix

public resetRecordSuffix(): void

resetRecordTemplate

public resetRecordTemplate(): void

resetSampleRate

public resetSampleRate(): void

resetTimestampFormat

public resetTimestampFormat(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
batchPrefixInput	string	No description.
batchSuffixInput	string	No description.
cve202144228Input	boolean | cdktf.IResolvable	No description.
fieldDelimiterInput	string	No description.
fieldNamesInput	string[]	No description.
outputTypeInput	string	No description.
recordDelimiterInput	string	No description.
recordPrefixInput	string	No description.
recordSuffixInput	string	No description.
recordTemplateInput	string	No description.
sampleRateInput	number	No description.
timestampFormatInput	string	No description.
batchPrefix	string	No description.
batchSuffix	string	No description.
cve202144228	boolean | cdktf.IResolvable	No description.
fieldDelimiter	string	No description.
fieldNames	string[]	No description.
outputType	string	No description.
recordDelimiter	string	No description.
recordPrefix	string	No description.
recordSuffix	string	No description.
recordTemplate	string	No description.
sampleRate	number	No description.
timestampFormat	string	No description.
internalValue	cdktf.IResolvable | LogpushJobOutputOptions	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

batchPrefixInput^Optional

public readonly batchPrefixInput: string;

• Type: string

---

batchSuffixInput^Optional

public readonly batchSuffixInput: string;

• Type: string

---

cve202144228Input^Optional

public readonly cve202144228Input: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

fieldDelimiterInput^Optional

public readonly fieldDelimiterInput: string;

• Type: string

---

fieldNamesInput^Optional

public readonly fieldNamesInput: string[];

• Type: string[]

---

outputTypeInput^Optional

public readonly outputTypeInput: string;

• Type: string

---

recordDelimiterInput^Optional

public readonly recordDelimiterInput: string;

• Type: string

---

recordPrefixInput^Optional

public readonly recordPrefixInput: string;

• Type: string

---

recordSuffixInput^Optional

public readonly recordSuffixInput: string;

• Type: string

---

recordTemplateInput^Optional

public readonly recordTemplateInput: string;

• Type: string

---

sampleRateInput^Optional

public readonly sampleRateInput: number;

• Type: number

---

timestampFormatInput^Optional

public readonly timestampFormatInput: string;

• Type: string

---

batchPrefix^Required

public readonly batchPrefix: string;

• Type: string

---

batchSuffix^Required

public readonly batchSuffix: string;

• Type: string

---

cve202144228^Required

public readonly cve202144228: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

fieldDelimiter^Required

public readonly fieldDelimiter: string;

• Type: string

---

fieldNames^Required

public readonly fieldNames: string[];

• Type: string[]

---

outputType^Required

public readonly outputType: string;

• Type: string

---

recordDelimiter^Required

public readonly recordDelimiter: string;

• Type: string

---

recordPrefix^Required

public readonly recordPrefix: string;

• Type: string

---

recordSuffix^Required

public readonly recordSuffix: string;

• Type: string

---

recordTemplate^Required

public readonly recordTemplate: string;

• Type: string

---

sampleRate^Required

public readonly sampleRate: number;

• Type: number

---

timestampFormat^Required

public readonly timestampFormat: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | LogpushJobOutputOptions;

• Type: cdktf.IResolvable | LogpushJobOutputOptions

---