Class: AWSCDK::Datasync::CfnTask::TaskReportConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
datasync/cfn_task.rb

Overview

Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.

For more information, see Task reports .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination:, output_type:, object_version_ids: nil, overrides: nil, report_level: nil) ⇒ TaskReportConfigProperty

Returns a new instance of TaskReportConfigProperty.

Parameters:

  • destination (AWSCDK::IResolvable, AWSCDK::Datasync::CfnTask::DestinationProperty) —

    Specifies the Amazon S3 bucket where DataSync uploads your task report.

  • output_type (String) —

    Specifies the type of task report that you want:.

  • object_version_ids (String, nil) (defaults to: nil) —

    Specifies whether your task report includes the new version of each object transferred into an S3 bucket.

  • overrides (AWSCDK::IResolvable, AWSCDK::Datasync::CfnTask::OverridesProperty, nil) (defaults to: nil) —

    Customizes the reporting level for aspects of your task report.

  • report_level (String, nil) (defaults to: nil) —

    Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'datasync/cfn_task.rb', line 1409

def initialize(destination:, output_type:, object_version_ids: nil, overrides: nil, report_level: nil)
  @destination = destination.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::DestinationProperty.new(**destination.transform_keys(&:to_sym)) : destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLkRlc3RpbmF0aW9uUHJvcGVydHkifV19fQ==")), "destination")
  @output_type = output_type
  Jsii::Type.check_type(@output_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputType")
  @object_version_ids = object_version_ids
  Jsii::Type.check_type(@object_version_ids, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectVersionIds") unless @object_version_ids.nil?
  @overrides = overrides.is_a?(Hash) ? ::AWSCDK::Datasync::CfnTask::OverridesProperty.new(**overrides.transform_keys(&:to_sym)) : overrides
  Jsii::Type.check_type(@overrides, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhc3luYy5DZm5UYXNrLk92ZXJyaWRlc1Byb3BlcnR5In1dfX0=")), "overrides") unless @overrides.nil?
  @report_level = report_level
  Jsii::Type.check_type(@report_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reportLevel") unless @report_level.nil?
end

Instance Attribute Details

#destination ⇒ AWSCDK::IResolvable, AWSCDK::Datasync::CfnTask::DestinationProperty (readonly)

Specifies the Amazon S3 bucket where DataSync uploads your task report.

For more information, see Task reports .

Returns:

See Also:



1428
1429
1430
 
# File 'datasync/cfn_task.rb', line 1428

def destination
  @destination
end

#object_version_ids ⇒ String? (readonly)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket.

This only applies if you enable versioning on your bucket . Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

  • (String, nil)

See Also:



1443
1444
1445
 
# File 'datasync/cfn_task.rb', line 1443

def object_version_ids
  @object_version_ids
end

#output_type ⇒ String (readonly)

Specifies the type of task report that you want:.

  • SUMMARY_ONLY : Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.
  • STANDARD : Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

  • (String)

See Also:



1436
1437
1438
 
# File 'datasync/cfn_task.rb', line 1436

def output_type
  @output_type
end

#overrides ⇒ AWSCDK::IResolvable, ... (readonly)

Customizes the reporting level for aspects of your task report.

For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Returns:

See Also:



1450
1451
1452
 
# File 'datasync/cfn_task.rb', line 1450

def overrides
  @overrides
end

#report_level ⇒ String? (readonly)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

  • ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip, verify, and delete.
  • SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

  • (String, nil)

See Also:



1458
1459
1460
 
# File 'datasync/cfn_task.rb', line 1458

def report_level
  @report_level
end

Class Method Details

.jsii_properties ⇒ Object 



1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'datasync/cfn_task.rb', line 1460

def self.jsii_properties
  {
    :destination => "destination",
    :output_type => "outputType",
    :object_version_ids => "objectVersionIds",
    :overrides => "overrides",
    :report_level => "reportLevel",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'datasync/cfn_task.rb', line 1470

def to_jsii
  result = {}
  result.merge!({
    "destination" => @destination,
    "outputType" => @output_type,
    "objectVersionIds" => @object_version_ids,
    "overrides" => @overrides,
    "reportLevel" => @report_level,
  })
  result.compact
end