Class: AWSCDK::Personalize::CfnDataset::DatasetImportJobProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
personalize/cfn_dataset.rb

Overview

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

If you specify a dataset import job as part of a dataset, all dataset import job fields are required.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dataset_arn: nil, dataset_import_job_arn: nil, data_source: nil, job_name: nil, role_arn: nil) ⇒ DatasetImportJobProperty

Returns a new instance of DatasetImportJobProperty.

Parameters:

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

    The Amazon Resource Name (ARN) of the dataset that receives the imported data.

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

    The ARN of the dataset import job.

  • data_source (Object, nil) (defaults to: nil) —

    The Amazon S3 bucket that contains the training data to import.

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

    The name of the import job.

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

    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.



638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'personalize/cfn_dataset.rb', line 638

def initialize(dataset_arn: nil, dataset_import_job_arn: nil, data_source: nil, job_name: nil, role_arn: nil)
  @dataset_arn = dataset_arn
  Jsii::Type.check_type(@dataset_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetArn") unless @dataset_arn.nil?
  @dataset_import_job_arn = dataset_import_job_arn
  Jsii::Type.check_type(@dataset_import_job_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetImportJobArn") unless @dataset_import_job_arn.nil?
  @data_source = data_source
  Jsii::Type.check_type(@data_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataSource") unless @data_source.nil?
  @job_name = job_name
  Jsii::Type.check_type(@job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName") unless @job_name.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#data_source ⇒ Object? (readonly)

The Amazon S3 bucket that contains the training data to import.

Returns:

  • (Object, nil)

See Also:



665
666
667
 
# File 'personalize/cfn_dataset.rb', line 665

def data_source
  @data_source
end

#dataset_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

Returns:

  • (String, nil)

See Also:



655
656
657
 
# File 'personalize/cfn_dataset.rb', line 655

def dataset_arn
  @dataset_arn
end

#dataset_import_job_arn ⇒ String? (readonly)

The ARN of the dataset import job.

Returns:

  • (String, nil)

See Also:



660
661
662
 
# File 'personalize/cfn_dataset.rb', line 660

def dataset_import_job_arn
  @dataset_import_job_arn
end

#job_name ⇒ String? (readonly)

The name of the import job.

Returns:

  • (String, nil)

See Also:



670
671
672
 
# File 'personalize/cfn_dataset.rb', line 670

def job_name
  @job_name
end

#role_arn ⇒ String? (readonly)

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

Returns:

  • (String, nil)

See Also:



675
676
677
 
# File 'personalize/cfn_dataset.rb', line 675

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



677
678
679
680
681
682
683
684
685
 
# File 'personalize/cfn_dataset.rb', line 677

def self.jsii_properties
  {
    :dataset_arn => "datasetArn",
    :dataset_import_job_arn => "datasetImportJobArn",
    :data_source => "dataSource",
    :job_name => "jobName",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



687
688
689
690
691
692
693
694
695
696
697
 
# File 'personalize/cfn_dataset.rb', line 687

def to_jsii
  result = {}
  result.merge!({
    "datasetArn" => @dataset_arn,
    "datasetImportJobArn" => @dataset_import_job_arn,
    "dataSource" => @data_source,
    "jobName" => @job_name,
    "roleArn" => @role_arn,
  })
  result.compact
end