Class: AWSCDK::Sagemaker::CfnImageVersion

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSSagemaker::IImageVersionRef
Defined in:
sagemaker/cfn_image_version.rb

Overview

Creates a version of the SageMaker image specified by ImageName .

The version represents the Amazon Container Registry (ECR) container image specified by BaseImage .

You can use the DependsOn attribute to specify that the creation of a specific resource follows another. You can use it for the following use cases. For more information, see DependsOn attribute .

  1. DependsOn can be used to establish a parent/child relationship between ImageVersion and Image where the ImageVersion DependsOn the Image .
  2. DependsOn can be used to establish order among ImageVersion s within the same Image namespace. For example, if ImageVersionB DependsOn ImageVersionA and both share the same parent Image , then ImageVersionA is version N and ImageVersionB is N+1.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnImageVersion

Create a new AWS::SageMaker::ImageVersion.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Sagemaker::CfnImageVersionProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'sagemaker/cfn_image_version.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnImageVersionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkltYWdlVmVyc2lvblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_image_version(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_image_version(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSUltYWdlVmVyc2lvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnImageVersion", "arnForImageVersion", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_image_version(x) ⇒ Boolean

Checks whether the given object is a CfnImageVersion.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
82
83
84
85
86
 
# File 'sagemaker/cfn_image_version.rb', line 32

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_container_image => { kind: :property, name: "attrContainerImage", is_optional: false },
    :attr_image_arn => { kind: :property, name: "attrImageArn", is_optional: false },
    :attr_image_version_arn => { kind: :property, name: "attrImageVersionArn", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :image_version_ref => { kind: :property, name: "imageVersionRef", is_optional: false },
    :base_image => { kind: :property, name: "baseImage", is_optional: false },
    :image_name => { kind: :property, name: "imageName", is_optional: false },
    :_alias => { kind: :property, name: "alias", is_optional: true },
    :aliases => { kind: :property, name: "aliases", is_optional: true },
    :horovod => { kind: :property, name: "horovod", is_optional: true },
    :job_type => { kind: :property, name: "jobType", is_optional: true },
    :ml_framework => { kind: :property, name: "mlFramework", is_optional: true },
    :processor => { kind: :property, name: "processor", is_optional: true },
    :programming_lang => { kind: :property, name: "programmingLang", is_optional: true },
    :release_notes => { kind: :property, name: "releaseNotes", is_optional: true },
    :vendor_guidance => { kind: :property, name: "vendorGuidance", 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

#_alias ⇒ String?

The alias of the image version.

Returns:

  • (String, nil) 


269
270
271
 
# File 'sagemaker/cfn_image_version.rb', line 269

def _alias()
  jsii_get_property("alias")
end

#_alias=(value) ⇒ Object 



273
274
275
276
 
# File 'sagemaker/cfn_image_version.rb', line 273

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

#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.



410
411
412
413
 
# File 'sagemaker/cfn_image_version.rb', line 410

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:



422
423
424
425
 
# File 'sagemaker/cfn_image_version.rb', line 422

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:



432
433
434
435
 
# File 'sagemaker/cfn_image_version.rb', line 432

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:



443
444
445
446
447
 
# File 'sagemaker/cfn_image_version.rb', line 443

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.


500
501
502
503
504
 
# File 'sagemaker/cfn_image_version.rb', line 500

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.



510
511
512
513
 
# File 'sagemaker/cfn_image_version.rb', line 510

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.



522
523
524
525
526
 
# File 'sagemaker/cfn_image_version.rb', line 522

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

#aliases ⇒ Array<String>?

List of aliases for the image version.

Returns:

  • (Array<String>, nil) 


281
282
283
 
# File 'sagemaker/cfn_image_version.rb', line 281

def aliases()
  jsii_get_property("aliases")
end

#aliases=(value) ⇒ Object 



285
286
287
288
 
# File 'sagemaker/cfn_image_version.rb', line 285

def aliases=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "aliases") unless value.nil?
  jsii_set_property("aliases", 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:



535
536
537
538
 
# File 'sagemaker/cfn_image_version.rb', line 535

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:



557
558
559
560
561
562
 
# File 'sagemaker/cfn_image_version.rb', line 557

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_container_image ⇒ String

The URI of the container image version referenced by ImageVersion.

Returns:

  • (String) 


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

def attr_container_image()
  jsii_get_property("attrContainerImage")
end

#attr_image_arn ⇒ String

The Amazon Resource Name (ARN) of the parent Image.

Returns:

  • (String) 


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

def attr_image_arn()
  jsii_get_property("attrImageArn")
end

#attr_image_version_arn ⇒ String

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])* /[0-9]+$

Returns:

  • (String) 


224
225
226
 
# File 'sagemaker/cfn_image_version.rb', line 224

def attr_image_version_arn()
  jsii_get_property("attrImageVersionArn")
end

#attr_version ⇒ Numeric

The version of the image.

Returns:

  • (Numeric) 


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

def attr_version()
  jsii_get_property("attrVersion")
end

#base_image ⇒ String

The container image that the SageMaker image version is based on.

Returns:

  • (String) 


245
246
247
 
# File 'sagemaker/cfn_image_version.rb', line 245

def base_image()
  jsii_get_property("baseImage")
end

#base_image=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



150
151
152
 
# File 'sagemaker/cfn_image_version.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


566
567
568
569
 
# File 'sagemaker/cfn_image_version.rb', line 566

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'sagemaker/cfn_image_version.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'sagemaker/cfn_image_version.rb', line 172

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:



579
580
581
582
583
 
# File 'sagemaker/cfn_image_version.rb', line 579

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:



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

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

#horovod ⇒ Boolean, ...

Indicates Horovod compatibility.

Returns:



293
294
295
 
# File 'sagemaker/cfn_image_version.rb', line 293

def horovod()
  jsii_get_property("horovod")
end

#horovod=(value) ⇒ Object 



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

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

#image_name ⇒ String

The name of the parent image.

Returns:

  • (String) 


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

def image_name()
  jsii_get_property("imageName")
end

#image_name=(value) ⇒ Object 



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

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

#image_version_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::ImageVersionReference

A reference to a ImageVersion resource.

Returns:



238
239
240
 
# File 'sagemaker/cfn_image_version.rb', line 238

def image_version_ref()
  jsii_get_property("imageVersionRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



660
661
662
663
 
# File 'sagemaker/cfn_image_version.rb', line 660

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

#job_type ⇒ String?

Indicates SageMaker job type compatibility.

Returns:

  • (String, nil) 


305
306
307
 
# File 'sagemaker/cfn_image_version.rb', line 305

def job_type()
  jsii_get_property("jobType")
end

#job_type=(value) ⇒ Object 



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

def job_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobType") unless value.nil?
  jsii_set_property("jobType", 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) 


124
125
126
 
# File 'sagemaker/cfn_image_version.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#ml_framework ⇒ String?

The machine learning framework vended in the image version.

Returns:

  • (String, nil) 


317
318
319
 
# File 'sagemaker/cfn_image_version.rb', line 317

def ml_framework()
  jsii_get_property("mlFramework")
end

#ml_framework=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


107
108
109
 
# File 'sagemaker/cfn_image_version.rb', line 107

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:



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

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:



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

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.



401
402
403
404
 
# File 'sagemaker/cfn_image_version.rb', line 401

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

#processor ⇒ String?

Indicates CPU or GPU compatibility.

Returns:

  • (String, nil) 


329
330
331
 
# File 'sagemaker/cfn_image_version.rb', line 329

def processor()
  jsii_get_property("processor")
end

#processor=(value) ⇒ Object 



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

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

#programming_lang ⇒ String?

The supported programming language and its version.

Returns:

  • (String, nil) 


341
342
343
 
# File 'sagemaker/cfn_image_version.rb', line 341

def programming_lang()
  jsii_get_property("programmingLang")
end

#programming_lang=(value) ⇒ Object 



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

def programming_lang=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "programmingLang") unless value.nil?
  jsii_set_property("programmingLang", value)
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) 


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

def ref()
  jsii_get_property("ref")
end

#release_notes ⇒ String?

The maintainer description of the image version.

Returns:

  • (String, nil) 


353
354
355
 
# File 'sagemaker/cfn_image_version.rb', line 353

def release_notes()
  jsii_get_property("releaseNotes")
end

#release_notes=(value) ⇒ Object 



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

def release_notes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "releaseNotes") unless value.nil?
  jsii_set_property("releaseNotes", value)
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:



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

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


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

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:



636
637
638
639
640
 
# File 'sagemaker/cfn_image_version.rb', line 636

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

#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.



645
646
647
 
# File 'sagemaker/cfn_image_version.rb', line 645

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:



133
134
135
 
# File 'sagemaker/cfn_image_version.rb', line 133

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



377
378
379
 
# File 'sagemaker/cfn_image_version.rb', line 377

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


180
181
182
 
# File 'sagemaker/cfn_image_version.rb', line 180

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


651
652
653
654
 
# File 'sagemaker/cfn_image_version.rb', line 651

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

#vendor_guidance ⇒ String?

The availability of the image version specified by the maintainer.

Returns:

  • (String, nil) 


365
366
367
 
# File 'sagemaker/cfn_image_version.rb', line 365

def vendor_guidance()
  jsii_get_property("vendorGuidance")
end

#vendor_guidance=(value) ⇒ Object 



369
370
371
372
 
# File 'sagemaker/cfn_image_version.rb', line 369

def vendor_guidance=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vendorGuidance") unless value.nil?
  jsii_set_property("vendorGuidance", value)
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) 


390
391
392
393
394
395
 
# File 'sagemaker/cfn_image_version.rb', line 390

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