Skip to main content

rules

Overview

Namerules
TypeResource
Idsumologic.logs_data_forwarding.rules

Fields

NameDatatypeDescription
idstringThe unique identifier of the data forwarding rule.
indexIdstringThe id of the Partition or Scheduled View the rule applies to.
bucketobject
enabledbooleanTrue when the data forwarding rule is enabled.
modifiedAtstringLast modification timestamp in UTC.
createdBystringIdentifier of the user who created the resource.
createdAtstringCreation timestamp in UTC in RFC3339 format.
formatstringFormat of the payload.
destinationIdstringThe data forwarding destination id.
fileFormatstringSpecify the path prefix to a directory in the S3 bucket and how to format the file name.
modifiedBystringIdentifier of the user who last modified the resource.
payloadSchemastringSchema for the payload.

Methods

NameAccessible byRequired ParamsDescription
getDataForwardingRuleSELECTindexId, regionGet the details of an S3 data forwarding rule by its Partition or Scheduled View identifier.
getRulesAndBucketsSELECTregionGet a list of all S3 data forwarding rules.
createDataForwardingRuleINSERTdata__destinationId, data__indexId, regionCreate a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket.
deleteDataForwardingRuleDELETEindexId, regionDelete an S3 data forwarding rule by its Partition or Scheduled View identifier.
updateDataForwardingRuleEXECindexId, regionUpdate an S3 data forwarding rule by its Partition or Scheduled View identifier.