AWS S3
  • Dark
    Light

AWS S3

  • Dark
    Light

Overview

This output type sends logs to an AWS S3 endpoint.

Note

In the Edge Delta App, when you create an integration or an individual output, similar parameters will display. As a result, this document applies to both outputs and integrations.


Create an IAM User and Attach a Custom Policy

Before you configure your Edge Delta account to sends logs to an AWS S3 endpoint, you must first access the AWS console to:

  1. Create an IAM user to access the AWS S3 bucket
  2. Attach the custom policy below to the newly created IAM user
Note

The custom policy lists 3 permissions:

  • PutObject
  • GetObject
  • ListBucket

If you want to create an S3 archive for rehydration purposes only, then at a minimum, your custom policy must include GetObject.

All other permissions are only required for archiving purposes.

As a result, if you prefer, you can create 2 different S3 archive integrations with different custom policies.

To learn more, see Rehydrations.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::bucket-name",
                "arn:aws:s3:::bucket-name/*"
            ]
        }
    ]
}

Review Sample Configuration

The following sample configuration displays an output without the name of the organization-level integration:

archives:
    - name: my-s3
      type: s3
      aws_key_id: '{{ Env "AWS_KEY_ID" }}'
      aws_sec_key: '{{ Env "AWS_SECRET_KEY" }}'
      bucket: testbucket
      region: us-east-2
    - name: my-s3-assumes-role
      type: s3
      role_arn: "arn:aws:iam::1234567890:role/ed-s3-archiver-role"
      external_id: "053cf606-8e80-47bf-b849-8cd1cc826cfc"
      bucket: testbucket
      region: us-east-2

Review Parameters

Review the following parameters that you can configure in the Edge Delta App.


name

Required

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

Review the following example:

name: s3

integration_name

Optional

This parameter refers to the organization-level integration created in the Integrations page.

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

Review the following example:

integration_name: orgs-aws-s3

type

Required

Enter s3.

Review the following example:

type: s3

bucket

Required

Enter the target S3 bucket to send the archived logs.

Review the following example:

bucket: "testbucket"

region

Required

Enter the specified S3 bucket's region.

Review the following example:

region: "us-east-2"

aws_key_id

Optional

Enter the AWS key ID that has the PutObject permission to target the bucket. If you use role-based AWS authentication where keys are not provided, then you should keep this field empty; however, you must still attach the custom policy listed above.

Review the following example:

aws_key_id: '{{ Env "TEST_AWS_KEY_ID" }}'

aws_sec_key

Optional

Enter the AWS secret key ID that has the PutObject permission to target the bucket. If you use role-based AWS authentication where keys are not provided, then you should keep this field empty; however, you must still attach the custom policy listed above.

Review the following example:

aws_sec_key: "awssecret123"

role_arn

Optional

Enter the ARN that has permissions to use the desired IAM Role

To learn more, review this document from AWS.

Review the following example:

role_arn: "arn:aws:iam::1234567890:role/ed-s3-archiver-role"

external_id

Optional

Enter the external ID associated with the desired IAM role.

To learn more, review this document from AWS.

Review the following example:

external_id: "053cf606-8e80-47bf-b849-8cd1cc826cfc"

compress

Optional

Enter a compression type for archiving purposes.

You can enter gzip, zstd, snappy, or uncompressed.

Review the following example:

compress: gzip

encoding

Optional

Enter an encoding type for archiving purposes.

You can enter json or parquet.

Review the following example:

encoding: parquet

use_native_compression

Optional

Enter true or false to compress parquet-encoded data.

This option will not compress metadata.

This option can be useful with big data cloud applications, such as AWS Athena and Google BigQuery.

Note

To use this parameter, you must set the encoding parameter to parquet.

Review the following example:

use_native_compression: true

buffer_ttl

Optional

Enter a length of time to retry failed streaming data.

After this length of time is reached, the failed streaming data will no longer be tried.

Review the following example:

buffer_ttl: 2h

buffer_path

Optional

Enter a folder path to temporarily store failed streaming data.

The failed streaming data will be retried until the data reaches its destinations or until the Buffer TTL value is reached.

If you enter a path that does not exist, then the agent will create directories, as needed.

Review the following example:

buffer_path: /var/log/edgedelta/pushbuffer/

buffer_max_bytesize

Optional

Enter the maximum size of failed streaming data that you want to retry.

If the failed streaming data is larger than this size, then the failed streaming data will not be retried.

Review the following example:

buffer_max_bytesize: 100MB

disable_metadata_ingestion

Optional

Enter true or false to disable metadata file ingestion. 

Typically, metadata is used for rehydration analysis. 

Review the following example: 

disable_metadata_ingestion: true




Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.