Class: AWSCDK::Sagemaker::CfnProcessingJob::AthenaDatasetDefinitionProperty

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

Overview

Configuration for Athena Dataset Definition input.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(catalog:, database:, output_format:, output_s3_uri:, query_string:, kms_key_id: nil, output_compression: nil, work_group: nil) ⇒ AthenaDatasetDefinitionProperty

Returns a new instance of AthenaDatasetDefinitionProperty.

Parameters:

  • catalog (String) —

    The name of the data catalog used in Athena query execution.

  • database (String) —

    The name of the database used in the Athena query execution.

  • output_format (String) —

    The data storage format for Athena query results.

  • output_s3_uri (String) —

    The location in Amazon S3 where Athena query results are stored.

  • query_string (String) —

    The SQL query statements, to be executed.

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

    The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

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

    The compression used for Athena query results.

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

    The name of the workgroup in which the Athena query is being started.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'sagemaker/cfn_processing_job.rb', line 800

def initialize(catalog:, database:, output_format:, output_s3_uri:, query_string:, kms_key_id: nil, output_compression: nil, work_group: nil)
  @catalog = catalog
  Jsii::Type.check_type(@catalog, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalog")
  @database = database
  Jsii::Type.check_type(@database, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "database")
  @output_format = output_format
  Jsii::Type.check_type(@output_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputFormat")
  @output_s3_uri = output_s3_uri
  Jsii::Type.check_type(@output_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputS3Uri")
  @query_string = query_string
  Jsii::Type.check_type(@query_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString")
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @output_compression = output_compression
  Jsii::Type.check_type(@output_compression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputCompression") unless @output_compression.nil?
  @work_group = work_group
  Jsii::Type.check_type(@work_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workGroup") unless @work_group.nil?
end

Instance Attribute Details

#catalog ⇒ String (readonly)

The name of the data catalog used in Athena query execution.

Returns:

  • (String)

See Also:



823
824
825
 
# File 'sagemaker/cfn_processing_job.rb', line 823

def catalog
  @catalog
end

#database ⇒ String (readonly)

The name of the database used in the Athena query execution.

Returns:

  • (String)

See Also:



828
829
830
 
# File 'sagemaker/cfn_processing_job.rb', line 828

def database
  @database
end

#kms_key_id ⇒ String? (readonly)

The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

Returns:

  • (String, nil)

See Also:



848
849
850
 
# File 'sagemaker/cfn_processing_job.rb', line 848

def kms_key_id
  @kms_key_id
end

#output_compression ⇒ String? (readonly)

The compression used for Athena query results.

Returns:

  • (String, nil)

See Also:



853
854
855
 
# File 'sagemaker/cfn_processing_job.rb', line 853

def output_compression
  @output_compression
end

#output_format ⇒ String (readonly)

The data storage format for Athena query results.

Returns:

  • (String)

See Also:



833
834
835
 
# File 'sagemaker/cfn_processing_job.rb', line 833

def output_format
  @output_format
end

#output_s3_uri ⇒ String (readonly)

The location in Amazon S3 where Athena query results are stored.

Returns:

  • (String)

See Also:



838
839
840
 
# File 'sagemaker/cfn_processing_job.rb', line 838

def output_s3_uri
  @output_s3_uri
end

#query_string ⇒ String (readonly)

The SQL query statements, to be executed.

Returns:

  • (String)

See Also:



843
844
845
 
# File 'sagemaker/cfn_processing_job.rb', line 843

def query_string
  @query_string
end

#work_group ⇒ String? (readonly)

The name of the workgroup in which the Athena query is being started.

Returns:

  • (String, nil)

See Also:



858
859
860
 
# File 'sagemaker/cfn_processing_job.rb', line 858

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object 



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'sagemaker/cfn_processing_job.rb', line 860

def self.jsii_properties
  {
    :catalog => "catalog",
    :database => "database",
    :output_format => "outputFormat",
    :output_s3_uri => "outputS3Uri",
    :query_string => "queryString",
    :kms_key_id => "kmsKeyId",
    :output_compression => "outputCompression",
    :work_group => "workGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'sagemaker/cfn_processing_job.rb', line 873

def to_jsii
  result = {}
  result.merge!({
    "catalog" => @catalog,
    "database" => @database,
    "outputFormat" => @output_format,
    "outputS3Uri" => @output_s3_uri,
    "queryString" => @query_string,
    "kmsKeyId" => @kms_key_id,
    "outputCompression" => @output_compression,
    "workGroup" => @work_group,
  })
  result.compact
end