Skip to content

Latest commit

 

History

History
2269 lines (1414 loc) · 95.4 KB

logpushJob.typescript.md

File metadata and controls

2269 lines (1414 loc) · 95.4 KB
Raw

logpushJob Submodule

Constructs

LogpushJob

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.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.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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.
resetEnabled No description.
resetFilter No description.
resetFrequency No description.
resetId 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
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

putOutputOptions 
public putOutputOptions(value: LogpushJobOutputOptions): void
valueRequired
resetAccountId 
public resetAccountId(): void
resetEnabled 
public resetEnabled(): void
resetFilter 
public resetFilter(): void
resetFrequency 
public resetFrequency(): void
resetId 
public resetId(): 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.

xRequired
  • Type: any

Any object.

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

logpushJob.LogpushJob.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { logpushJob } from '@cdktf/provider-cloudflare'

logpushJob.LogpushJob.isTerraformResource(x: any)
xRequired
  • 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 ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing LogpushJob that should be imported.

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

providerOptional
  • 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.
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.
idInput 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 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.
id 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
outputOptionsRequired 
public readonly outputOptions: LogpushJobOutputOptionsOutputReference;
accountIdInputOptional 
public readonly accountIdInput: string;
  • Type: string
datasetInputOptional 
public readonly datasetInput: string;
  • Type: string
destinationConfInputOptional 
public readonly destinationConfInput: string;
  • Type: string
enabledInputOptional 
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
filterInputOptional 
public readonly filterInput: string;
  • Type: string
frequencyInputOptional 
public readonly frequencyInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
kindInputOptional 
public readonly kindInput: string;
  • Type: string
logpullOptionsInputOptional 
public readonly logpullOptionsInput: string;
  • Type: string
maxUploadBytesInputOptional 
public readonly maxUploadBytesInput: number;
  • Type: number
maxUploadIntervalSecondsInputOptional 
public readonly maxUploadIntervalSecondsInput: number;
  • Type: number
maxUploadRecordsInputOptional 
public readonly maxUploadRecordsInput: number;
  • Type: number
nameInputOptional 
public readonly nameInput: string;
  • Type: string
outputOptionsInputOptional 
public readonly outputOptionsInput: LogpushJobOutputOptions;
ownershipChallengeInputOptional 
public readonly ownershipChallengeInput: string;
  • Type: string
zoneIdInputOptional 
public readonly zoneIdInput: string;
  • Type: string
accountIdRequired 
public readonly accountId: string;
  • Type: string
datasetRequired 
public readonly dataset: string;
  • Type: string
destinationConfRequired 
public readonly destinationConf: string;
  • Type: string
enabledRequired 
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
filterRequired 
public readonly filter: string;
  • Type: string
frequencyRequired 
public readonly frequency: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
kindRequired 
public readonly kind: string;
  • Type: string
logpullOptionsRequired 
public readonly logpullOptions: string;
  • Type: string
maxUploadBytesRequired 
public readonly maxUploadBytes: number;
  • Type: number
maxUploadIntervalSecondsRequired 
public readonly maxUploadIntervalSeconds: number;
  • Type: number
maxUploadRecordsRequired 
public readonly maxUploadRecords: number;
  • Type: number
nameRequired 
public readonly name: string;
  • Type: string
ownershipChallengeRequired 
public readonly ownershipChallenge: string;
  • Type: string
zoneIdRequired 
public readonly zoneId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
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.
dataset string The kind of the dataset to use with the logpush job.
destinationConf string Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
accountId string The account identifier to target for the resource. Must provide only one of account_id, zone_id.
enabled boolean | cdktf.IResolvable 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.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/logpush_job#id LogpushJob#id}.
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.
maxUploadBytes number The maximum uncompressed file size of a batch of logs. Value must be between 5MB and 1GB.
maxUploadIntervalSeconds number The maximum interval in seconds for log batches. Value must be between 30 and 300.
maxUploadRecords number The maximum number of log lines per batch. Value must be between 1000 and 1,000,000.
name string The name of the logpush job to create.
outputOptions LogpushJobOutputOptions output_options block.
ownershipChallenge string Ownership challenge token to prove destination ownership, required when destination is Amazon S3, Google Cloud Storage, Microsoft Azure or Sumo Logic.
zoneId string The zone identifier to target for the resource. Must provide only one of account_id, zone_id.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
datasetRequired 
public readonly dataset: string;
  • Type: string

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, page_shield_events.

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

destinationConfRequired 
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. See Logpush destination documentation.

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

accountIdOptional 
public readonly accountId: string;
  • Type: string

The account identifier to target for the resource. Must provide only one of account_id, zone_id.

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

enabledOptional 
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether to enable the job.

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

filterOptional 
public readonly filter: string;
  • Type: string

Use 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/4.34.0/docs/resources/logpush_job#filter LogpushJob#filter}

frequencyOptional 
public readonly frequency: string;
  • Type: 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.

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

idOptional 
public readonly id: string;
  • Type: string

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

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

kindOptional 
public readonly kind: string;
  • Type: string

The kind of logpush job to create. Available values: edge, instant-logs, "".

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

logpullOptionsOptional 
public readonly logpullOptions: string;
  • Type: string

Configuration string for the Logshare API. It specifies things like requested fields and timestamp formats. See Logpush options documentation.

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

maxUploadBytesOptional 
public readonly maxUploadBytes: number;
  • Type: number

The maximum uncompressed file size of a batch of logs. Value must be between 5MB and 1GB.

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

maxUploadIntervalSecondsOptional 
public readonly maxUploadIntervalSeconds: number;
  • Type: number

The maximum interval in seconds for log batches. Value must be between 30 and 300.

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

maxUploadRecordsOptional 
public readonly maxUploadRecords: number;
  • Type: number

The maximum number of log lines per batch. Value must be between 1000 and 1,000,000.

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

nameOptional 
public readonly name: string;
  • Type: string

The name of the logpush job to create.

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

outputOptionsOptional 
public readonly outputOptions: LogpushJobOutputOptions;

output_options block.

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

ownershipChallengeOptional 
public readonly ownershipChallenge: string;
  • Type: 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.

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

zoneIdOptional 
public readonly zoneId: string;
  • Type: string

The zone identifier to target for the resource. Must provide only one of account_id, zone_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.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.
cve20214428 boolean | cdktf.IResolvable Mitigation for CVE-2021-44228.
fieldDelimiter string String to join fields. This field be ignored when record_template is set. Defaults to ,.
fieldNames string[] List of field names to be included in the Logpush output.
outputType string Specifies the output type. Available values: ndjson, csv. Defaults to ndjson.
recordDelimiter string String to be inserted in-between the records as separator.
recordPrefix string String to be prepended before each record. Defaults to {.
recordSuffix string String to be appended after each record. Defaults to }.
recordTemplate string String to use as template for each record instead of the default comma-separated list.
sampleRate number Specifies the sampling rate. Defaults to 1.
timestampFormat string Specifies the format for timestamps. Available values: unixnano, unix, rfc3339. Defaults to unixnano.
batchPrefixOptional 
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/4.34.0/docs/resources/logpush_job#batch_prefix LogpushJob#batch_prefix}

batchSuffixOptional 
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/4.34.0/docs/resources/logpush_job#batch_suffix LogpushJob#batch_suffix}

cve20214428Optional 
public readonly cve20214428: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Mitigation for CVE-2021-44228.

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

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

fieldDelimiterOptional 
public readonly fieldDelimiter: string;
  • Type: string

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

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

fieldNamesOptional 
public readonly fieldNames: string[];
  • Type: string[]

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

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

outputTypeOptional 
public readonly outputType: string;
  • Type: string

Specifies the output type. Available values: ndjson, csv. Defaults to ndjson.

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

recordDelimiterOptional 
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/4.34.0/docs/resources/logpush_job#record_delimiter LogpushJob#record_delimiter}

recordPrefixOptional 
public readonly recordPrefix: string;
  • Type: string

String to be prepended before each record. Defaults to {.

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

recordSuffixOptional 
public readonly recordSuffix: string;
  • Type: string

String to be appended after each record. Defaults to }.

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

recordTemplateOptional 
public readonly recordTemplate: string;
  • Type: string

String to use as template for each record instead of the default comma-separated list.

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

sampleRateOptional 
public readonly sampleRate: number;
  • Type: number

Specifies the sampling rate. Defaults to 1.

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

timestampFormatOptional 
public readonly timestampFormat: string;
  • Type: string

Specifies the format for timestamps. Available values: unixnano, unix, rfc3339. Defaults to unixnano.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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.
resetCve20214428 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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
resetCve20214428 
public resetCve20214428(): 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.
cve20214428Input 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.
cve20214428 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 LogpushJobOutputOptions No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
batchPrefixInputOptional 
public readonly batchPrefixInput: string;
  • Type: string
batchSuffixInputOptional 
public readonly batchSuffixInput: string;
  • Type: string
cve20214428InputOptional 
public readonly cve20214428Input: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
fieldDelimiterInputOptional 
public readonly fieldDelimiterInput: string;
  • Type: string
fieldNamesInputOptional 
public readonly fieldNamesInput: string[];
  • Type: string[]
outputTypeInputOptional 
public readonly outputTypeInput: string;
  • Type: string
recordDelimiterInputOptional 
public readonly recordDelimiterInput: string;
  • Type: string
recordPrefixInputOptional 
public readonly recordPrefixInput: string;
  • Type: string
recordSuffixInputOptional 
public readonly recordSuffixInput: string;
  • Type: string
recordTemplateInputOptional 
public readonly recordTemplateInput: string;
  • Type: string
sampleRateInputOptional 
public readonly sampleRateInput: number;
  • Type: number
timestampFormatInputOptional 
public readonly timestampFormatInput: string;
  • Type: string
batchPrefixRequired 
public readonly batchPrefix: string;
  • Type: string
batchSuffixRequired 
public readonly batchSuffix: string;
  • Type: string
cve20214428Required 
public readonly cve20214428: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
fieldDelimiterRequired 
public readonly fieldDelimiter: string;
  • Type: string
fieldNamesRequired 
public readonly fieldNames: string[];
  • Type: string[]
outputTypeRequired 
public readonly outputType: string;
  • Type: string
recordDelimiterRequired 
public readonly recordDelimiter: string;
  • Type: string
recordPrefixRequired 
public readonly recordPrefix: string;
  • Type: string
recordSuffixRequired 
public readonly recordSuffix: string;
  • Type: string
recordTemplateRequired 
public readonly recordTemplate: string;
  • Type: string
sampleRateRequired 
public readonly sampleRate: number;
  • Type: number
timestampFormatRequired 
public readonly timestampFormat: string;
  • Type: string
internalValueOptional 
public readonly internalValue: LogpushJobOutputOptions;