You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudWatchLogs::Types::CreateExportTaskRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Note:

When making an API call, you may pass CreateExportTaskRequest data as a hash:

{
  task_name: "ExportTaskName",
  log_group_name: "LogGroupName", # required
  log_stream_name_prefix: "LogStreamName",
  from: 1, # required
  to: 1, # required
  destination: "ExportDestinationBucket", # required
  destination_prefix: "ExportDestinationPrefix",
}

Instance Attribute Summary collapse

Instance Attribute Details

#destinationString

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

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#destination_prefixString

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

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#fromInteger

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 time stamp earlier than this time are not exported.

Returns:

  • (Integer)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#log_group_nameString

The name of the log group.

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#log_stream_name_prefixString

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

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#task_nameString

The name of the export task.

Returns:

  • (String)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end

#toInteger

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 time stamp later than this time are not exported.

Returns:

  • (Integer)


109
110
111
112
113
114
115
116
117
118
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 109

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  include Aws::Structure
end