rules
Overview
Name | rules |
Type | Resource |
Id | sumologic.logs_data_forwarding.rules |
Fields
Name | Datatype | Description |
---|---|---|
id | string | The unique identifier of the data forwarding rule. |
bucket | object | |
createdAt | string | Creation timestamp in UTC in RFC3339 format. |
createdBy | string | Identifier of the user who created the resource. |
destinationId | string | The data forwarding destination id. |
enabled | boolean | True when the data forwarding rule is enabled. |
fileFormat | string | Specify the path prefix to a directory in the S3 bucket and how to format the file name. |
format | string | Format of the payload. |
indexId | string | The id of the Partition or Scheduled View the rule applies to. |
modifiedAt | string | Last modification timestamp in UTC. |
modifiedBy | string | Identifier of the user who last modified the resource. |
payloadSchema | string | Schema for the payload. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
getDataForwardingRule | SELECT | indexId, region | Get the details of an S3 data forwarding rule by its Partition or Scheduled View identifier. |
getRulesAndBuckets | SELECT | region | Get a list of all S3 data forwarding rules. |
createDataForwardingRule | INSERT | data__destinationId, data__indexId, region | Create a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket. |
deleteDataForwardingRule | DELETE | indexId, region | Delete an S3 data forwarding rule by its Partition or Scheduled View identifier. |
updateDataForwardingRule | EXEC | indexId, region | Update an S3 data forwarding rule by its Partition or Scheduled View identifier. |