Documentation ¶
Index ¶
- func LogpushJob_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func LogpushJob_IsConstruct(x interface{}) *bool
- func LogpushJob_IsTerraformElement(x interface{}) *bool
- func LogpushJob_IsTerraformResource(x interface{}) *bool
- func LogpushJob_TfResourceType() *string
- func NewLogpushJobOutputOptionsOutputReference_Override(l LogpushJobOutputOptionsOutputReference, ...)
- func NewLogpushJob_Override(l LogpushJob, scope constructs.Construct, id *string, config *LogpushJobConfig)
- type LogpushJob
- type LogpushJobConfig
- type LogpushJobOutputOptions
- type LogpushJobOutputOptionsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LogpushJob_GenerateConfigForImport ¶
func LogpushJob_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a LogpushJob resource upon running "cdktf plan <stack-name>".
func LogpushJob_IsConstruct ¶
func LogpushJob_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func LogpushJob_IsTerraformElement ¶
func LogpushJob_IsTerraformElement(x interface{}) *bool
Experimental.
func LogpushJob_IsTerraformResource ¶
func LogpushJob_IsTerraformResource(x interface{}) *bool
Experimental.
func LogpushJob_TfResourceType ¶
func LogpushJob_TfResourceType() *string
func NewLogpushJobOutputOptionsOutputReference_Override ¶ added in v11.5.0
func NewLogpushJobOutputOptionsOutputReference_Override(l LogpushJobOutputOptionsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewLogpushJob_Override ¶
func NewLogpushJob_Override(l LogpushJob, scope constructs.Construct, id *string, config *LogpushJobConfig)
Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job cloudflare_logpush_job} Resource.
Types ¶
type LogpushJob ¶
type LogpushJob interface { cdktf.TerraformResource AccountId() *string SetAccountId(val *string) AccountIdInput() *string // Experimental. CdktfStack() cdktf.TerraformStack // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) // Experimental. ConstructNodeMetadata() *map[string]interface{} // Experimental. Count() interface{} // Experimental. SetCount(val interface{}) Dataset() *string SetDataset(val *string) DatasetInput() *string // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) DestinationConf() *string SetDestinationConf(val *string) DestinationConfInput() *string Enabled() interface{} SetEnabled(val interface{}) EnabledInput() interface{} Filter() *string SetFilter(val *string) FilterInput() *string // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) // Experimental. Fqn() *string Frequency() *string SetFrequency(val *string) FrequencyInput() *string // Experimental. FriendlyUniqueId() *string Id() *string SetId(val *string) IdInput() *string Kind() *string SetKind(val *string) KindInput() *string // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) LogpullOptions() *string SetLogpullOptions(val *string) LogpullOptionsInput() *string MaxUploadBytes() *float64 SetMaxUploadBytes(val *float64) MaxUploadBytesInput() *float64 MaxUploadIntervalSeconds() *float64 SetMaxUploadIntervalSeconds(val *float64) MaxUploadIntervalSecondsInput() *float64 MaxUploadRecords() *float64 SetMaxUploadRecords(val *float64) MaxUploadRecordsInput() *float64 Name() *string SetName(val *string) NameInput() *string // The tree node. Node() constructs.Node OutputOptions() LogpushJobOutputOptionsOutputReference OutputOptionsInput() *LogpushJobOutputOptions OwnershipChallenge() *string SetOwnershipChallenge(val *string) OwnershipChallengeInput() *string // Experimental. Provider() cdktf.TerraformProvider // Experimental. SetProvider(val cdktf.TerraformProvider) // Experimental. Provisioners() *[]interface{} // Experimental. SetProvisioners(val *[]interface{}) // Experimental. RawOverrides() interface{} // Experimental. TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata // Experimental. TerraformMetaArguments() *map[string]interface{} // Experimental. TerraformResourceType() *string ZoneId() *string SetZoneId(val *string) ZoneIdInput() *string // Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. // Experimental. AddMoveTarget(moveTarget *string) // Experimental. AddOverride(path *string, value interface{}) // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. HasResourceMove() interface{} // Experimental. ImportFrom(id *string, provider cdktf.TerraformProvider) // Experimental. InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable // 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. // Experimental. MoveFromId(id *string) // Moves this resource to the target resource given by moveTarget. // Experimental. MoveTo(moveTarget *string, index interface{}) // Moves this resource to the resource corresponding to "id". // Experimental. MoveToId(id *string) // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) PutOutputOptions(value *LogpushJobOutputOptions) ResetAccountId() ResetEnabled() ResetFilter() ResetFrequency() ResetId() ResetKind() ResetLogpullOptions() ResetMaxUploadBytes() ResetMaxUploadIntervalSeconds() ResetMaxUploadRecords() ResetName() ResetOutputOptions() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetOwnershipChallenge() ResetZoneId() SynthesizeAttributes() *map[string]interface{} SynthesizeHclAttributes() *map[string]interface{} // Experimental. ToHclTerraform() interface{} // Experimental. ToMetadata() interface{} // Returns a string representation of this construct. ToString() *string // Adds this resource to the terraform JSON output. // Experimental. ToTerraform() interface{} }
Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job cloudflare_logpush_job}.
func NewLogpushJob ¶
func NewLogpushJob(scope constructs.Construct, id *string, config *LogpushJobConfig) LogpushJob
Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job cloudflare_logpush_job} Resource.
type LogpushJobConfig ¶
type LogpushJobConfig struct { // Experimental. Connection interface{} `field:"optional" json:"connection" yaml:"connection"` // Experimental. Count interface{} `field:"optional" json:"count" yaml:"count"` // Experimental. DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"` // Experimental. ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"` // Experimental. Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"` // Experimental. Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"` // Experimental. Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"` // 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`, `dlp_forensic_copies`. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#dataset LogpushJob#dataset} Dataset *string `field:"required" json:"dataset" yaml:"dataset"` // 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). // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#destination_conf LogpushJob#destination_conf} DestinationConf *string `field:"required" json:"destinationConf" yaml:"destinationConf"` // 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.49.0/docs/resources/logpush_job#account_id LogpushJob#account_id} AccountId *string `field:"optional" json:"accountId" yaml:"accountId"` // Whether to enable the job. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#enabled LogpushJob#enabled} Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // 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/). // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#filter LogpushJob#filter} Filter *string `field:"optional" json:"filter" yaml:"filter"` // 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.49.0/docs/resources/logpush_job#frequency LogpushJob#frequency} Frequency *string `field:"optional" json:"frequency" yaml:"frequency"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.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. Id *string `field:"optional" json:"id" yaml:"id"` // 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.49.0/docs/resources/logpush_job#kind LogpushJob#kind} Kind *string `field:"optional" json:"kind" yaml:"kind"` // 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). // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#logpull_options LogpushJob#logpull_options} LogpullOptions *string `field:"optional" json:"logpullOptions" yaml:"logpullOptions"` // 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.49.0/docs/resources/logpush_job#max_upload_bytes LogpushJob#max_upload_bytes} MaxUploadBytes *float64 `field:"optional" json:"maxUploadBytes" yaml:"maxUploadBytes"` // 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.49.0/docs/resources/logpush_job#max_upload_interval_seconds LogpushJob#max_upload_interval_seconds} MaxUploadIntervalSeconds *float64 `field:"optional" json:"maxUploadIntervalSeconds" yaml:"maxUploadIntervalSeconds"` // 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.49.0/docs/resources/logpush_job#max_upload_records LogpushJob#max_upload_records} MaxUploadRecords *float64 `field:"optional" json:"maxUploadRecords" yaml:"maxUploadRecords"` // The name of the logpush job to create. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#name LogpushJob#name} Name *string `field:"optional" json:"name" yaml:"name"` // output_options block. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#output_options LogpushJob#output_options} OutputOptions *LogpushJobOutputOptions `field:"optional" json:"outputOptions" yaml:"outputOptions"` // 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). // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#ownership_challenge LogpushJob#ownership_challenge} OwnershipChallenge *string `field:"optional" json:"ownershipChallenge" yaml:"ownershipChallenge"` // 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.49.0/docs/resources/logpush_job#zone_id LogpushJob#zone_id} ZoneId *string `field:"optional" json:"zoneId" yaml:"zoneId"` }
type LogpushJobOutputOptions ¶ added in v11.5.0
type LogpushJobOutputOptions struct { // String to be prepended before each batch. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#batch_prefix LogpushJob#batch_prefix} BatchPrefix *string `field:"optional" json:"batchPrefix" yaml:"batchPrefix"` // String to be appended after each batch. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#batch_suffix LogpushJob#batch_suffix} BatchSuffix *string `field:"optional" json:"batchSuffix" yaml:"batchSuffix"` // 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.49.0/docs/resources/logpush_job#cve20214428 LogpushJob#cve20214428} Cve20214428 interface{} `field:"optional" json:"cve20214428" yaml:"cve20214428"` // 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.49.0/docs/resources/logpush_job#field_delimiter LogpushJob#field_delimiter} FieldDelimiter *string `field:"optional" json:"fieldDelimiter" yaml:"fieldDelimiter"` // List of field names to be included in the Logpush output. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#field_names LogpushJob#field_names} FieldNames *[]*string `field:"optional" json:"fieldNames" yaml:"fieldNames"` // Specifies the output type. Available values: `ndjson`, `csv`. Defaults to `ndjson`. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#output_type LogpushJob#output_type} OutputType *string `field:"optional" json:"outputType" yaml:"outputType"` // String to be inserted in-between the records as separator. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#record_delimiter LogpushJob#record_delimiter} RecordDelimiter *string `field:"optional" json:"recordDelimiter" yaml:"recordDelimiter"` // String to be prepended before each record. Defaults to `{`. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#record_prefix LogpushJob#record_prefix} RecordPrefix *string `field:"optional" json:"recordPrefix" yaml:"recordPrefix"` // String to be appended after each record. Defaults to `} `. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#record_suffix LogpushJob#record_suffix} RecordSuffix *string `field:"optional" json:"recordSuffix" yaml:"recordSuffix"` // 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.49.0/docs/resources/logpush_job#record_template LogpushJob#record_template} RecordTemplate *string `field:"optional" json:"recordTemplate" yaml:"recordTemplate"` // Specifies the sampling rate. Defaults to `1`. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.49.0/docs/resources/logpush_job#sample_rate LogpushJob#sample_rate} SampleRate *float64 `field:"optional" json:"sampleRate" yaml:"sampleRate"` // 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.49.0/docs/resources/logpush_job#timestamp_format LogpushJob#timestamp_format} TimestampFormat *string `field:"optional" json:"timestampFormat" yaml:"timestampFormat"` }
type LogpushJobOutputOptionsOutputReference ¶ added in v11.5.0
type LogpushJobOutputOptionsOutputReference interface { cdktf.ComplexObject BatchPrefix() *string SetBatchPrefix(val *string) BatchPrefixInput() *string BatchSuffix() *string SetBatchSuffix(val *string) BatchSuffixInput() *string // the index of the complex object in a list. // Experimental. ComplexObjectIndex() interface{} // Experimental. SetComplexObjectIndex(val interface{}) // set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items. // Experimental. ComplexObjectIsFromSet() *bool // Experimental. SetComplexObjectIsFromSet(val *bool) // 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. // Experimental. CreationStack() *[]*string Cve20214428() interface{} SetCve20214428(val interface{}) Cve20214428Input() interface{} FieldDelimiter() *string SetFieldDelimiter(val *string) FieldDelimiterInput() *string FieldNames() *[]*string SetFieldNames(val *[]*string) FieldNamesInput() *[]*string // Experimental. Fqn() *string InternalValue() *LogpushJobOutputOptions SetInternalValue(val *LogpushJobOutputOptions) OutputType() *string SetOutputType(val *string) OutputTypeInput() *string RecordDelimiter() *string SetRecordDelimiter(val *string) RecordDelimiterInput() *string RecordPrefix() *string SetRecordPrefix(val *string) RecordPrefixInput() *string RecordSuffix() *string SetRecordSuffix(val *string) RecordSuffixInput() *string RecordTemplate() *string SetRecordTemplate(val *string) RecordTemplateInput() *string SampleRate() *float64 SetSampleRate(val *float64) SampleRateInput() *float64 // Experimental. TerraformAttribute() *string // Experimental. SetTerraformAttribute(val *string) // Experimental. TerraformResource() cdktf.IInterpolatingParent // Experimental. SetTerraformResource(val cdktf.IInterpolatingParent) TimestampFormat() *string SetTimestampFormat(val *string) TimestampFormatInput() *string // Experimental. ComputeFqn() *string // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationAsList() cdktf.IResolvable // Experimental. InterpolationForAttribute(property *string) cdktf.IResolvable ResetBatchPrefix() ResetBatchSuffix() ResetCve20214428() ResetFieldDelimiter() ResetFieldNames() ResetOutputType() ResetRecordDelimiter() ResetRecordPrefix() ResetRecordSuffix() ResetRecordTemplate() ResetSampleRate() ResetTimestampFormat() // Produce the Token's value at resolution time. // Experimental. Resolve(_context cdktf.IResolveContext) interface{} // Return a string representation of this resolvable object. // // Returns a reversible string representation. // Experimental. ToString() *string }
func NewLogpushJobOutputOptionsOutputReference ¶ added in v11.5.0
func NewLogpushJobOutputOptionsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) LogpushJobOutputOptionsOutputReference