Class: AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSagemaker::IModelExplainabilityJobDefinitionRef
Defined in:
sagemaker/cfn_model_explainability_job_definition.rb

Overview

Creates the definition for a model explainability job.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnModelExplainabilityJobDefinition

Create a new AWS::SageMaker::ModelExplainabilityJobDefinition.

Parameters:



18
19
20
21
22
23
24
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinitionProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsRXhwbGFpbmFiaWxpdHlKb2JEZWZpbml0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


183
184
185
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 183

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sagemaker.CfnModelExplainabilityJobDefinition", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_model_explainability_job_definition(x) ⇒ Boolean

Checks whether the given object is a CfnModelExplainabilityJobDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_model_explainability_job_definition(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelExplainabilityJobDefinition", "isCfnModelExplainabilityJobDefinition", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_job_definition_arn => { kind: :property, name: "attrJobDefinitionArn", is_optional: false },
    :model_explainability_job_definition_ref => { kind: :property, name: "modelExplainabilityJobDefinitionRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :job_resources => { kind: :property, name: "jobResources", is_optional: false },
    :model_explainability_app_specification => { kind: :property, name: "modelExplainabilityAppSpecification", is_optional: false },
    :model_explainability_job_input => { kind: :property, name: "modelExplainabilityJobInput", is_optional: false },
    :model_explainability_job_output_config => { kind: :property, name: "modelExplainabilityJobOutputConfig", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :endpoint_name => { kind: :property, name: "endpointName", is_optional: true },
    :job_definition_name => { kind: :property, name: "jobDefinitionName", is_optional: true },
    :model_explainability_baseline_config => { kind: :property, name: "modelExplainabilityBaselineConfig", is_optional: true },
    :network_config => { kind: :property, name: "networkConfig", is_optional: true },
    :stopping_condition => { kind: :property, name: "stoppingCondition", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



391
392
393
394
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 391

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



403
404
405
406
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 403

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



413
414
415
416
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 413

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



424
425
426
427
428
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 424

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


481
482
483
484
485
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 481

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



491
492
493
494
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 491

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



503
504
505
506
507
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 503

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



516
517
518
519
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 516

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



538
539
540
541
542
543
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 538

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_creation_time ⇒ String

The time when the job definition was created.

Returns:

  • (String) 


190
191
192
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 190

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_job_definition_arn ⇒ String

The Amazon Resource Name (ARN) of the job definition.

Returns:

  • (String) 


197
198
199
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 197

def attr_job_definition_arn()
  jsii_get_property("attrJobDefinitionArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



136
137
138
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 136

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


141
142
143
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 141

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


547
548
549
550
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 547

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


146
147
148
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 146

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


153
154
155
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 153

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


98
99
100
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 98

def creation_stack()
  jsii_get_property("creationStack")
end

#endpoint_name ⇒ String?

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

Returns:

  • (String, nil) 


282
283
284
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 282

def endpoint_name()
  jsii_get_property("endpointName")
end

#endpoint_name=(value) ⇒ Object 



286
287
288
289
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 286

def endpoint_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName") unless value.nil?
  jsii_set_property("endpointName", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



158
159
160
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 158

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



560
561
562
563
564
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 560

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



571
572
573
574
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 571

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



641
642
643
644
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 641

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#job_definition_name ⇒ String?

The name of the model explainability job definition.

Returns:

  • (String, nil) 


294
295
296
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 294

def job_definition_name()
  jsii_get_property("jobDefinitionName")
end

#job_definition_name=(value) ⇒ Object 



298
299
300
301
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 298

def job_definition_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobDefinitionName") unless value.nil?
  jsii_set_property("jobDefinitionName", value)
end

#job_resources ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringResourcesProperty

Identifies the resources to deploy for a monitoring job.

Returns:



218
219
220
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 218

def job_resources()
  jsii_get_property("jobResources")
end

#job_resources=(value) ⇒ Object 



222
223
224
225
226
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 222

def job_resources=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringResourcesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9uaXRvcmluZ1Jlc291cmNlc1Byb3BlcnR5In1dfX0=")), "jobResources")
  jsii_set_property("jobResources", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


110
111
112
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 110

def logical_id()
  jsii_get_property("logicalId")
end

#model_explainability_app_specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityAppSpecificationProperty

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

Returns:



231
232
233
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 231

def model_explainability_app_specification()
  jsii_get_property("modelExplainabilityAppSpecification")
end

#model_explainability_app_specification=(value) ⇒ Object 



235
236
237
238
239
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 235

def model_explainability_app_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityAppSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUFwcFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "modelExplainabilityAppSpecification")
  jsii_set_property("modelExplainabilityAppSpecification", value)
end

#model_explainability_baseline_config ⇒ AWSCDK::IResolvable, ...

The baseline configuration for a model explainability job.

Returns:



306
307
308
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 306

def model_explainability_baseline_config()
  jsii_get_property("modelExplainabilityBaselineConfig")
end

#model_explainability_baseline_config=(value) ⇒ Object 



310
311
312
313
314
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 310

def model_explainability_baseline_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityBaselineConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUJhc2VsaW5lQ29uZmlnUHJvcGVydHkifV19fQ==")), "modelExplainabilityBaselineConfig") unless value.nil?
  jsii_set_property("modelExplainabilityBaselineConfig", value)
end

#model_explainability_job_definition_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::ModelExplainabilityJobDefinitionReference

A reference to a ModelExplainabilityJobDefinition resource.

Returns:



204
205
206
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 204

def model_explainability_job_definition_ref()
  jsii_get_property("modelExplainabilityJobDefinitionRef")
end

#model_explainability_job_input ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityJobInputProperty

Inputs for the model explainability job.

Returns:



244
245
246
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 244

def model_explainability_job_input()
  jsii_get_property("modelExplainabilityJobInput")
end

#model_explainability_job_input=(value) ⇒ Object 



248
249
250
251
252
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 248

def model_explainability_job_input=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::ModelExplainabilityJobInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9kZWxFeHBsYWluYWJpbGl0eUpvYklucHV0UHJvcGVydHkifV19fQ==")), "modelExplainabilityJobInput")
  jsii_set_property("modelExplainabilityJobInput", value)
end

#model_explainability_job_output_config ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringOutputConfigProperty

The output configuration for monitoring jobs.

Returns:



257
258
259
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 257

def model_explainability_job_output_config()
  jsii_get_property("modelExplainabilityJobOutputConfig")
end

#model_explainability_job_output_config=(value) ⇒ Object 



261
262
263
264
265
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 261

def model_explainability_job_output_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::MonitoringOutputConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTW9uaXRvcmluZ091dHB1dENvbmZpZ1Byb3BlcnR5In1dfX0=")), "modelExplainabilityJobOutputConfig")
  jsii_set_property("modelExplainabilityJobOutputConfig", value)
end

#network_config ⇒ AWSCDK::IResolvable, ...

Networking options for a model explainability job.

Returns:



319
320
321
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 319

def network_config()
  jsii_get_property("networkConfig")
end

#network_config=(value) ⇒ Object 



323
324
325
326
327
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 323

def network_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::NetworkConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uTmV0d29ya0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "networkConfig") unless value.nil?
  jsii_set_property("networkConfig", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


93
94
95
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 93

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



582
583
584
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 582

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



589
590
591
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 589

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



382
383
384
385
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 382

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


129
130
131
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 129

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



600
601
602
603
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 600

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


607
608
609
610
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 607

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



617
618
619
620
621
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 617

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String

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

Returns:

  • (String) 


270
271
272
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 270

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



274
275
276
277
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 274

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



626
627
628
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 626

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



119
120
121
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 119

def stack()
  jsii_get_property("stack")
end

#stopping_condition ⇒ AWSCDK::IResolvable, ...

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

Returns:



332
333
334
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 332

def stopping_condition()
  jsii_get_property("stoppingCondition")
end

#stopping_condition=(value) ⇒ Object 



336
337
338
339
340
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 336

def stopping_condition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelExplainabilityJobDefinition::StoppingConditionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxFeHBsYWluYWJpbGl0eUpvYkRlZmluaXRpb24uU3RvcHBpbmdDb25kaXRpb25Qcm9wZXJ0eSJ9XX19")), "stoppingCondition") unless value.nil?
  jsii_set_property("stoppingCondition", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



211
212
213
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 211

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



345
346
347
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 345

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



349
350
351
352
353
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 349

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



358
359
360
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 358

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


166
167
168
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 166

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 176

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


632
633
634
635
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 632

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


371
372
373
374
375
376
 
# File 'sagemaker/cfn_model_explainability_job_definition.rb', line 371

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end