Class: AWSCDK::Sagemaker::CfnMonitoringSchedule::EndpointInputProperty

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

Overview

Input object for the endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint_name:, local_path:, exclude_features_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil) ⇒ EndpointInputProperty

Returns a new instance of EndpointInputProperty.

Parameters:

  • endpoint_name (String) —

    An endpoint in customer's account which has enabled DataCaptureConfig enabled.

  • local_path (String) —

    Path to the filesystem where the endpoint data is available to the container.

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

    The attributes of the input data to exclude from the analysis.

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

    Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

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

    Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.



933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 933

def initialize(endpoint_name:, local_path:, exclude_features_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil)
  @endpoint_name = endpoint_name
  Jsii::Type.check_type(@endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName")
  @local_path = local_path
  Jsii::Type.check_type(@local_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localPath")
  @exclude_features_attribute = exclude_features_attribute
  Jsii::Type.check_type(@exclude_features_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "excludeFeaturesAttribute") unless @exclude_features_attribute.nil?
  @s3_data_distribution_type = s3_data_distribution_type
  Jsii::Type.check_type(@s3_data_distribution_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3DataDistributionType") unless @s3_data_distribution_type.nil?
  @s3_input_mode = s3_input_mode
  Jsii::Type.check_type(@s3_input_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3InputMode") unless @s3_input_mode.nil?
end

Instance Attribute Details

#endpoint_name ⇒ String (readonly)

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

Returns:

  • (String)

See Also:



950
951
952
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 950

def endpoint_name
  @endpoint_name
end

#exclude_features_attribute ⇒ String? (readonly)

The attributes of the input data to exclude from the analysis.

Returns:

  • (String, nil)

See Also:



960
961
962
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 960

def exclude_features_attribute
  @exclude_features_attribute
end

#local_path ⇒ String (readonly)

Path to the filesystem where the endpoint data is available to the container.

Returns:

  • (String)

See Also:



955
956
957
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 955

def local_path
  @local_path
end

#s3_data_distribution_type ⇒ String? (readonly)

Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.

Defaults to FullyReplicated

Returns:

  • (String, nil)

See Also:



967
968
969
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 967

def s3_data_distribution_type
  @s3_data_distribution_type
end

#s3_input_mode ⇒ String? (readonly)

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .

Returns:

  • (String, nil)

See Also:



974
975
976
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 974

def s3_input_mode
  @s3_input_mode
end

Class Method Details

.jsii_properties ⇒ Object 



976
977
978
979
980
981
982
983
984
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 976

def self.jsii_properties
  {
    :endpoint_name => "endpointName",
    :local_path => "localPath",
    :exclude_features_attribute => "excludeFeaturesAttribute",
    :s3_data_distribution_type => "s3DataDistributionType",
    :s3_input_mode => "s3InputMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



986
987
988
989
990
991
992
993
994
995
996
 
# File 'sagemaker/cfn_monitoring_schedule.rb', line 986

def to_jsii
  result = {}
  result.merge!({
    "endpointName" => @endpoint_name,
    "localPath" => @local_path,
    "excludeFeaturesAttribute" => @exclude_features_attribute,
    "s3DataDistributionType" => @s3_data_distribution_type,
    "s3InputMode" => @s3_input_mode,
  })
  result.compact
end