AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateExportTask operation. Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

Exporting to S3 buckets that are encrypted with AES-256 is supported.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest
      Amazon.CloudWatchLogs.Model.CreateExportTaskRequest

Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

C#
public class CreateExportTaskRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The CreateExportTaskRequest type exposes the following members

Constructors

NameDescription
Public Method CreateExportTaskRequest()

Properties

NameTypeDescription
Public Property Destination System.String

Gets and sets the property Destination.

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

Public Property DestinationPrefix System.String

Gets and sets the property DestinationPrefix.

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

Public Property From System.Int64

Gets and sets the property From.

The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

Public Property LogGroupName System.String

Gets and sets the property LogGroupName.

The name of the log group.

Public Property LogStreamNamePrefix System.String

Gets and sets the property LogStreamNamePrefix.

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

Public Property TaskName System.String

Gets and sets the property TaskName.

The name of the export task.

Public Property To System.Int64

Gets and sets the property To.

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

You must specify a time that is not earlier than when this log group was created.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5