datadog create-log-archive-s3
Create an archive in your organization
Description
Create an archive in your organization
Synopsis
datadog create-log-archive-s3
[--site <site>]
[--include_tags]
--name <name>
--query <query>
[--rehydration_size <rehydration_size>]
[--rehydration_tags <rehydration_tags>]
--bucket <bucket>
[--path <path>]
--account_id <account_id>
--role_name <role_name>
Arguments
site
- (string)
Site where this command will be executed
Example: --site "site-1"
Default: input.site
Attributes: optional
include_tags
- (bool)
set "true" to save tags. Else, the tags will be deleted when logs sent to archive
Example: --include_tags
Default: false
Attributes: optional
name
- (string)
The archive name
Example: --name "name-1"
Default: _None_
Attributes: required
query
- (string)
The archive query/filter. Logs matching this query are included in the archive
Example: --query "query-1"
Default: _None_
Attributes: required
rehydration_size
- (int)
Maximum scan size for rehydration in gb from this archive
Example: --rehydration_size 1
Default: _None_
Attributes: optional
rehydration_tags
- (string)
An array of tags to add to rehydrated logs from an archive
Example: --rehydration_tags "rehydration_tags-1"
Default: _None_
Attributes: optional, multiple allowed
bucket
- (string)
The bucket where the archive will be stored
Example: --bucket "bucket-1"
Default: _None_
Attributes: required
path
- (string)
The archive path
Example: --path "path-1"
Default: _None_
Attributes: optional
account_id
- (string)
account ID for the integration
Example: --account_id "account_id-1"
Default: _None_
Attributes: required
role_name
- (string)
path of the integration
Example: --role_name "role_name-1"
Default: _None_
Attributes: required
Examples
datadog create-log-archive-s3 --name "name-1" --query "query-1" --rehydration_size 1 --rehydration_tags "rehydration_tags-1" --bucket "bucket-1" --path "path-1" --account_id "account_id-1" --role_name "role_name-1"
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "create" |
Service Type | "datadog" |
Service Instance | |
Namespace | |
Object Type | "archive" |
Object ID |
Please see Access Control for details.