Struct aws_sdk_cloudwatchlogs::client::fluent_builders::CreateExportTask

pub struct CreateExportTask { /* private fields */ }

Fluent builder constructing a request to CreateExportTask.

Creates an export task, which allows you to 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 Amazon S3 buckets that are encrypted by KMS is not supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not 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 out log data for each export task, you can 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 fild data by using Linux utilities.

Implementations

impl CreateExportTask

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateExportTask, AwsResponseRetryClassifier>, SdkError<CreateExportTaskError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateExportTaskOutput, SdkError<CreateExportTaskError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn task_name(self, input: impl Into<String>) -> Self

The name of the export task.

pub fn set_task_name(self, input: Option<String>) -> Self

The name of the export task.

pub fn log_group_name(self, input: impl Into<String>) -> Self

The name of the log group.

pub fn set_log_group_name(self, input: Option<String>) -> Self

The name of the log group.

pub fn log_stream_name_prefix(self, input: impl Into<String>) -> Self

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

pub fn set_log_stream_name_prefix(self, input: Option<String>) -> Self

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

pub fn from(self, input: i64) -> Self

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.

pub fn set_from(self, input: Option<i64>) -> Self

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.

pub fn to(self, input: i64) -> Self

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.

pub fn set_to(self, input: Option<i64>) -> Self

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.

pub fn destination(self, input: impl Into<String>) -> Self

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

pub fn set_destination(self, input: Option<String>) -> Self

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

pub fn destination_prefix(self, input: impl Into<String>) -> Self

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

pub fn set_destination_prefix(self, input: Option<String>) -> Self

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

Trait Implementations

impl Clone for CreateExportTask

fn clone(&self) -> CreateExportTask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateExportTask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.