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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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 Amazon Web Services Region.

Returns:

  • (String)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  SENSITIVE = []
  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`.

The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes.

Returns:

  • (String)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  SENSITIVE = []
  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 timestamp earlier than this time are not exported.

Returns:

  • (Integer)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

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

#log_group_nameString

The name of the log group.

Returns:

  • (String)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  SENSITIVE = []
  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)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

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

#task_nameString

The name of the export task.

Returns:

  • (String)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

class CreateExportTaskRequest < Struct.new(
  :task_name,
  :log_group_name,
  :log_stream_name_prefix,
  :from,
  :to,
  :destination,
  :destination_prefix)
  SENSITIVE = []
  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 timestamp later than this time are not exported.

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

Returns:

  • (Integer)


606
607
608
609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 606

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