Class: Aws::CloudTrail::Types::StartImportRequest

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

Overview

Note:

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

{
  destinations: ["EventDataStoreArn"],
  import_source: {
    s3: { # required
      s3_location_uri: "String", # required
      s3_bucket_region: "String", # required
      s3_bucket_access_role_arn: "String", # required
    },
  },
  start_event_time: Time.now,
  end_event_time: Time.now,
  import_id: "UUID",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationsArray<String>

The ARN of the destination event data store. Use this parameter for a new import.

Returns:

  • (Array<String>)

3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'lib/aws-sdk-cloudtrail/types.rb', line 3945

class StartImportRequest < Struct.new(
  :destinations,
  :import_source,
  :start_event_time,
  :end_event_time,
  :import_id)
  SENSITIVE = []
  include Aws::Structure
end

#end_event_timeTime

Use with `StartEventTime` to bound a `StartImport` request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified `StartEventTime` and `EndEventTime` before attempting to import events.

Returns:

  • (Time)

3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'lib/aws-sdk-cloudtrail/types.rb', line 3945

class StartImportRequest < Struct.new(
  :destinations,
  :import_source,
  :start_event_time,
  :end_event_time,
  :import_id)
  SENSITIVE = []
  include Aws::Structure
end

#import_idString

The ID of the import. Use this parameter when you are retrying an import.

Returns:

  • (String)

3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'lib/aws-sdk-cloudtrail/types.rb', line 3945

class StartImportRequest < Struct.new(
  :destinations,
  :import_source,
  :start_event_time,
  :end_event_time,
  :import_id)
  SENSITIVE = []
  include Aws::Structure
end

#import_sourceTypes::ImportSource

The source S3 bucket for the import. Use this parameter for a new import.

Returns:


3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'lib/aws-sdk-cloudtrail/types.rb', line 3945

class StartImportRequest < Struct.new(
  :destinations,
  :import_source,
  :start_event_time,
  :end_event_time,
  :import_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_event_timeTime

Use with `EndEventTime` to bound a `StartImport` request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified `StartEventTime` and `EndEventTime` before attempting to import events.

Returns:

  • (Time)

3945
3946
3947
3948
3949
3950
3951
3952
3953
# File 'lib/aws-sdk-cloudtrail/types.rb', line 3945

class StartImportRequest < Struct.new(
  :destinations,
  :import_source,
  :start_event_time,
  :end_event_time,
  :import_id)
  SENSITIVE = []
  include Aws::Structure
end