Class: AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinitionProps

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

Overview

Properties for defining a CfnModelExplainabilityJobDefinition.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job_resources:, model_explainability_app_specification:, model_explainability_job_input:, model_explainability_job_output_config:, role_arn:, endpoint_name: nil, job_definition_name: nil, model_explainability_baseline_config: nil, network_config: nil, stopping_condition: nil, tags: nil) ⇒ CfnModelExplainabilityJobDefinitionProps

Returns a new instance of CfnModelExplainabilityJobDefinitionProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 20

def initialize(job_resources:, model_explainability_app_specification:, model_explainability_job_input:, model_explainability_job_output_config:, role_arn:, endpoint_name: nil, job_definition_name: nil, model_explainability_baseline_config: nil, network_config: nil, stopping_condition: nil, tags: nil)
  @job_resources = job_resources.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringResourcesProperty.new(**job_resources.transform_keys(&:to_sym)) : job_resources
  Jsii::Type.check_type(@job_resources, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9uaXRvcmluZ1Jlc291cmNlc1Byb3BlcnR5In1dfX0=")), "jobResources")
  @model_explainability_app_specification = model_explainability_app_specification.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityAppSpecificationProperty.new(**model_explainability_app_specification.transform_keys(&:to_sym)) : model_explainability_app_specification
  Jsii::Type.check_type(@model_explainability_app_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUFwcFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "modelExplainabilityAppSpecification")
  @model_explainability_job_input = model_explainability_job_input.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityJobInputProperty.new(**model_explainability_job_input.transform_keys(&:to_sym)) : model_explainability_job_input
  Jsii::Type.check_type(@model_explainability_job_input, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUpvYklucHV0UHJvcGVydHkifV19fQ==")), "modelExplainabilityJobInput")
  @model_explainability_job_output_config = model_explainability_job_output_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringOutputConfigProperty.new(**model_explainability_job_output_config.transform_keys(&:to_sym)) : model_explainability_job_output_config
  Jsii::Type.check_type(@model_explainability_job_output_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9uaXRvcmluZ091dHB1dENvbmZpZ1Byb3BlcnR5In1dfX0=")), "modelExplainabilityJobOutputConfig")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "roleArn")
  @endpoint_name = endpoint_name
  Jsii::Type.check_type(@endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName") unless @endpoint_name.nil?
  @job_definition_name = job_definition_name
  Jsii::Type.check_type(@job_definition_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobDefinitionName") unless @job_definition_name.nil?
  @model_explainability_baseline_config = model_explainability_baseline_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityBaselineConfigProperty.new(**model_explainability_baseline_config.transform_keys(&:to_sym)) : model_explainability_baseline_config
  Jsii::Type.check_type(@model_explainability_baseline_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUJhc2VsaW5lQ29uZmlnUHJvcGVydHkifV19fQ==")), "modelExplainabilityBaselineConfig") unless @model_explainability_baseline_config.nil?
  @network_config = network_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::NetworkConfigProperty.new(**network_config.transform_keys(&:to_sym)) : network_config
  Jsii::Type.check_type(@network_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTmV0d29ya0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "networkConfig") unless @network_config.nil?
  @stopping_condition = stopping_condition.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::StoppingConditionProperty.new(**stopping_condition.transform_keys(&:to_sym)) : stopping_condition
  Jsii::Type.check_type(@stopping_condition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uU3RvcHBpbmdDb25kaXRpb25Qcm9wZXJ0eSJ9XX19")), "stoppingCondition") unless @stopping_condition.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#endpoint_name ⇒ String? (readonly)

The name of the endpoint used to run the monitoring job.

Returns:

  • (String, nil)

See Also:



74
75
76
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 74

def endpoint_name
  @endpoint_name
end

#job_definition_name ⇒ String? (readonly)

The name of the model explainability job definition.

The name must be unique within an AWS Region in the AWS account.

Returns:

  • (String, nil)

See Also:



81
82
83
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 81

def job_definition_name
  @job_definition_name
end

#job_resources ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringResourcesProperty (readonly)

Identifies the resources to deploy for a monitoring job.

Returns:

See Also:



49
50
51
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 49

def job_resources
  @job_resources
end

#model_explainability_app_specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityAppSpecificationProperty (readonly)

Configures the model explainability job to run a specified Docker container image.

Returns:

See Also:



54
55
56
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 54

def model_explainability_app_specification
  @model_explainability_app_specification
end

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

The baseline configuration for a model explainability job.

Returns:

See Also:



86
87
88
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 86

def model_explainability_baseline_config
  @model_explainability_baseline_config
end

#model_explainability_job_input ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityJobInputProperty (readonly)

Inputs for the model explainability job.

Returns:

See Also:



59
60
61
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 59

def model_explainability_job_input
  @model_explainability_job_input
end

#model_explainability_job_output_config ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringOutputConfigProperty (readonly)

The output configuration for monitoring jobs.

Returns:

See Also:



64
65
66
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 64

def model_explainability_job_output_config
  @model_explainability_job_output_config
end

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

Networking options for a model explainability job.

Returns:

See Also:



91
92
93
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 91

def network_config
  @network_config
end

#role_arn ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Returns:

See Also:



69
70
71
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 69

def role_arn
  @role_arn
end

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

A time limit for how long the monitoring job is allowed to run before stopping.

Returns:

See Also:



96
97
98
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 96

def stopping_condition
  @stopping_condition
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



103
104
105
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 103

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 105

def self.jsii_properties
  {
    :job_resources => "jobResources",
    :model_explainability_app_specification => "modelExplainabilityAppSpecification",
    :model_explainability_job_input => "modelExplainabilityJobInput",
    :model_explainability_job_output_config => "modelExplainabilityJobOutputConfig",
    :role_arn => "roleArn",
    :endpoint_name => "endpointName",
    :job_definition_name => "jobDefinitionName",
    :model_explainability_baseline_config => "modelExplainabilityBaselineConfig",
    :network_config => "networkConfig",
    :stopping_condition => "stoppingCondition",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'sagemaker/cfn_model_explainability_job_definition_props.rb', line 121

def to_jsii
  result = {}
  result.merge!({
    "jobResources" => @job_resources,
    "modelExplainabilityAppSpecification" => @model_explainability_app_specification,
    "modelExplainabilityJobInput" => @model_explainability_job_input,
    "modelExplainabilityJobOutputConfig" => @model_explainability_job_output_config,
    "roleArn" => @role_arn,
    "endpointName" => @endpoint_name,
    "jobDefinitionName" => @job_definition_name,
    "modelExplainabilityBaselineConfig" => @model_explainability_baseline_config,
    "networkConfig" => @network_config,
    "stoppingCondition" => @stopping_condition,
    "tags" => @tags,
  })
  result.compact
end