Class: AWSCDK::Sagemaker::CfnProcessingJob::DatasetDefinitionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_processing_job.rb

Overview

Configuration for Dataset Definition inputs.

The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(athena_dataset_definition: nil, data_distribution_type: nil, input_mode: nil, local_path: nil, redshift_dataset_definition: nil) ⇒ DatasetDefinitionProperty

Returns a new instance of DatasetDefinitionProperty.

Parameters:



979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'sagemaker/cfn_processing_job.rb', line 979

def initialize(athena_dataset_definition: nil, data_distribution_type: nil, input_mode: nil, local_path: nil, redshift_dataset_definition: nil)
  @athena_dataset_definition = athena_dataset_definition.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::AthenaDatasetDefinitionProperty.new(**athena_dataset_definition.transform_keys(&:to_sym)) : athena_dataset_definition
  Jsii::Type.check_type(@athena_dataset_definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5BdGhlbmFEYXRhc2V0RGVmaW5pdGlvblByb3BlcnR5In1dfX0=")), "athenaDatasetDefinition") unless @athena_dataset_definition.nil?
  @data_distribution_type = data_distribution_type
  Jsii::Type.check_type(@data_distribution_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataDistributionType") unless @data_distribution_type.nil?
  @input_mode = input_mode
  Jsii::Type.check_type(@input_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputMode") unless @input_mode.nil?
  @local_path = local_path
  Jsii::Type.check_type(@local_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localPath") unless @local_path.nil?
  @redshift_dataset_definition = redshift_dataset_definition.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::RedshiftDatasetDefinitionProperty.new(**redshift_dataset_definition.transform_keys(&:to_sym)) : redshift_dataset_definition
  Jsii::Type.check_type(@redshift_dataset_definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5SZWRzaGlmdERhdGFzZXREZWZpbml0aW9uUHJvcGVydHkifV19fQ==")), "redshiftDatasetDefinition") unless @redshift_dataset_definition.nil?
end

Instance Attribute Details

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

Configuration for Athena Dataset Definition input.

Returns:

See Also:



996
997
998
 
# File 'sagemaker/cfn_processing_job.rb', line 996

def athena_dataset_definition
  @athena_dataset_definition
end

#data_distribution_type ⇒ String? (readonly)

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

Returns:

  • (String, nil)

See Also:



1001
1002
1003
 
# File 'sagemaker/cfn_processing_job.rb', line 1001

def data_distribution_type
  @data_distribution_type
end

#input_mode ⇒ String? (readonly)

Whether to use File or Pipe input mode.

In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

Returns:

  • (String, nil)

See Also:



1008
1009
1010
 
# File 'sagemaker/cfn_processing_job.rb', line 1008

def input_mode
  @input_mode
end

#local_path ⇒ String? (readonly)

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job.

LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

Returns:

  • (String, nil)

See Also:



1015
1016
1017
 
# File 'sagemaker/cfn_processing_job.rb', line 1015

def local_path
  @local_path
end

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

Configuration for Redshift Dataset Definition input.

Returns:

See Also:



1020
1021
1022
 
# File 'sagemaker/cfn_processing_job.rb', line 1020

def redshift_dataset_definition
  @redshift_dataset_definition
end

Class Method Details

.jsii_properties ⇒ Object 



1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'sagemaker/cfn_processing_job.rb', line 1022

def self.jsii_properties
  {
    :athena_dataset_definition => "athenaDatasetDefinition",
    :data_distribution_type => "dataDistributionType",
    :input_mode => "inputMode",
    :local_path => "localPath",
    :redshift_dataset_definition => "redshiftDatasetDefinition",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'sagemaker/cfn_processing_job.rb', line 1032

def to_jsii
  result = {}
  result.merge!({
    "athenaDatasetDefinition" => @athena_dataset_definition,
    "dataDistributionType" => @data_distribution_type,
    "inputMode" => @input_mode,
    "localPath" => @local_path,
    "redshiftDatasetDefinition" => @redshift_dataset_definition,
  })
  result.compact
end