Class: AWSCDK::Sagemaker::CfnDataQualityJobDefinition

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

Overview

Creates a definition for a job that monitors data quality and drift.

For information about model monitor, see Amazon SageMaker AI Model Monitor .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDataQualityJobDefinition

Create a new AWS::SageMaker::DataQualityJobDefinition.

Parameters:



20
21
22
23
24
25
26
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinitionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkRhdGFRdWFsaXR5Sm9iRGVmaW5pdGlvblByb3BzIn0=")), "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) 


185
186
187
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 185

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

.is_cfn_data_quality_job_definition(x) ⇒ Boolean

Checks whether the given object is a CfnDataQualityJobDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


87
88
89
90
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 87

def self.is_cfn_data_quality_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.CfnDataQualityJobDefinition", "isCfnDataQualityJobDefinition", [x])
end

.jsii_overridable_methods ⇒ Object 



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
80
81
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 28

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 },
    :data_quality_job_definition_ref => { kind: :property, name: "dataQualityJobDefinitionRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :data_quality_app_specification => { kind: :property, name: "dataQualityAppSpecification", is_optional: false },
    :data_quality_job_input => { kind: :property, name: "dataQualityJobInput", is_optional: false },
    :data_quality_job_output_config => { kind: :property, name: "dataQualityJobOutputConfig", is_optional: false },
    :job_resources => { kind: :property, name: "jobResources", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :data_quality_baseline_config => { kind: :property, name: "dataQualityBaselineConfig", is_optional: true },
    :endpoint_name => { kind: :property, name: "endpointName", is_optional: true },
    :job_definition_name => { kind: :property, name: "jobDefinitionName", 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.



393
394
395
396
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 393

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:



405
406
407
408
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 405

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:



415
416
417
418
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 415

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:



426
427
428
429
430
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 426

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.


483
484
485
486
487
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 483

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.



493
494
495
496
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 493

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.



505
506
507
508
509
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 505

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:



518
519
520
521
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 518

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:



540
541
542
543
544
545
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 540

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) 


192
193
194
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 192

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) 


199
200
201
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 199

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:



138
139
140
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 138

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


143
144
145
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 143

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


549
550
551
552
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 549

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}) 


148
149
150
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 148

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


155
156
157
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 155

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


100
101
102
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 100

def creation_stack()
  jsii_get_property("creationStack")
end

#data_quality_app_specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DataQualityAppSpecificationProperty

Specifies the container that runs the monitoring job.

Returns:



220
221
222
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 220

def data_quality_app_specification()
  jsii_get_property("dataQualityAppSpecification")
end

#data_quality_app_specification=(value) ⇒ Object 



224
225
226
227
228
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 224

def data_quality_app_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DataQualityAppSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLkRhdGFRdWFsaXR5QXBwU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "dataQualityAppSpecification")
  jsii_set_property("dataQualityAppSpecification", value)
end

#data_quality_baseline_config ⇒ AWSCDK::IResolvable, ...

Configures the constraints and baselines for the monitoring job.

Returns:



284
285
286
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 284

def data_quality_baseline_config()
  jsii_get_property("dataQualityBaselineConfig")
end

#data_quality_baseline_config=(value) ⇒ Object 



288
289
290
291
292
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 288

def data_quality_baseline_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DataQualityBaselineConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLkRhdGFRdWFsaXR5QmFzZWxpbmVDb25maWdQcm9wZXJ0eSJ9XX19")), "dataQualityBaselineConfig") unless value.nil?
  jsii_set_property("dataQualityBaselineConfig", value)
end

#data_quality_job_definition_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::DataQualityJobDefinitionReference

A reference to a DataQualityJobDefinition resource.

Returns:



206
207
208
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 206

def data_quality_job_definition_ref()
  jsii_get_property("dataQualityJobDefinitionRef")
end

#data_quality_job_input ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DataQualityJobInputProperty

A list of inputs for the monitoring job.

Returns:



233
234
235
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 233

def data_quality_job_input()
  jsii_get_property("dataQualityJobInput")
end

#data_quality_job_input=(value) ⇒ Object 



237
238
239
240
241
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 237

def data_quality_job_input=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DataQualityJobInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLkRhdGFRdWFsaXR5Sm9iSW5wdXRQcm9wZXJ0eSJ9XX19")), "dataQualityJobInput")
  jsii_set_property("dataQualityJobInput", value)
end

#data_quality_job_output_config ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDataQualityJobDefinition::MonitoringOutputConfigProperty

The output configuration for monitoring jobs.

Returns:



246
247
248
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 246

def data_quality_job_output_config()
  jsii_get_property("dataQualityJobOutputConfig")
end

#data_quality_job_output_config=(value) ⇒ Object 



250
251
252
253
254
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 250

def data_quality_job_output_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::MonitoringOutputConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLk1vbml0b3JpbmdPdXRwdXRDb25maWdQcm9wZXJ0eSJ9XX19")), "dataQualityJobOutputConfig")
  jsii_set_property("dataQualityJobOutputConfig", value)
end

#endpoint_name ⇒ String?

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

Returns:

  • (String, nil) 


297
298
299
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 297

def endpoint_name()
  jsii_get_property("endpointName")
end

#endpoint_name=(value) ⇒ Object 



301
302
303
304
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 301

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:



160
161
162
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 160

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:



562
563
564
565
566
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 562

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:



573
574
575
576
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 573

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:



643
644
645
646
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 643

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 for the monitoring job definition.

Returns:

  • (String, nil) 


309
310
311
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 309

def job_definition_name()
  jsii_get_property("jobDefinitionName")
end

#job_definition_name=(value) ⇒ Object 



313
314
315
316
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 313

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::CfnDataQualityJobDefinition::MonitoringResourcesProperty

Identifies the resources to deploy for a monitoring job.

Returns:



259
260
261
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 259

def job_resources()
  jsii_get_property("jobResources")
end

#job_resources=(value) ⇒ Object 



263
264
265
266
267
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 263

def job_resources=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::MonitoringResourcesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLk1vbml0b3JpbmdSZXNvdXJjZXNQcm9wZXJ0eSJ9XX19")), "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) 


112
113
114
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 112

def logical_id()
  jsii_get_property("logicalId")
end

#network_config ⇒ AWSCDK::IResolvable, ...

Specifies networking configuration for the monitoring job.

Returns:



321
322
323
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 321

def network_config()
  jsii_get_property("networkConfig")
end

#network_config=(value) ⇒ Object 



325
326
327
328
329
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 325

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


95
96
97
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 95

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:



584
585
586
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 584

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:



591
592
593
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 591

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.



384
385
386
387
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 384

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) 


131
132
133
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 131

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:



602
603
604
605
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 602

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}) 


609
610
611
612
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 609

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:



619
620
621
622
623
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 619

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) 


272
273
274
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 272

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



276
277
278
279
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 276

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.



628
629
630
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 628

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:



121
122
123
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 121

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:



334
335
336
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 334

def stopping_condition()
  jsii_get_property("stoppingCondition")
end

#stopping_condition=(value) ⇒ Object 



338
339
340
341
342
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 338

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



213
214
215
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 213

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



347
348
349
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 347

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



351
352
353
354
355
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 351

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



360
361
362
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 360

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}) 


168
169
170
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 168

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}) 


178
179
180
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 178

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


634
635
636
637
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 634

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) 


373
374
375
376
377
378
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 373

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