Class: AWSCDK::Sagemaker::CfnModelPackage

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

Overview

A container for your trained model that can be deployed for SageMaker inference.

This can include inference code, artifacts, and metadata. The model package type can be one of the following.

  • Versioned model: A part of a model package group in Model Registry.
  • Unversioned model: Not part of a model package group and used in AWS Marketplace.

For more information, see CreateModelPackage .

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnModelPackage

Create a new AWS::SageMaker::ModelPackage.

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::CfnModelPackageProps, nil) (defaults to: nil)

    Resource properties.



25
26
27
28
29
30
31
# File 'sagemaker/cfn_model_package.rb', line 25

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

Class Method Details

.arn_for_model_package(resource) ⇒ String

Parameters:

Returns:

  • (String)


108
109
110
111
# File 'sagemaker/cfn_model_package.rb', line 108

def self.arn_for_model_package(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSU1vZGVsUGFja2FnZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelPackage", "arnForModelPackage", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


215
216
217
# File 'sagemaker/cfn_model_package.rb', line 215

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

.is_cfn_model_package(x) ⇒ Boolean

Checks whether the given object is a CfnModelPackage.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


117
118
119
120
# File 'sagemaker/cfn_model_package.rb', line 117

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

.jsii_overridable_methodsObject



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'sagemaker/cfn_model_package.rb', line 33

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_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :attr_model_package_arn => { kind: :property, name: "attrModelPackageArn", is_optional: false },
    :attr_model_package_status => { kind: :property, name: "attrModelPackageStatus", is_optional: false },
    :model_package_ref => { kind: :property, name: "modelPackageRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :additional_inference_specifications => { kind: :property, name: "additionalInferenceSpecifications", is_optional: true },
    :additional_inference_specifications_to_add => { kind: :property, name: "additionalInferenceSpecificationsToAdd", is_optional: true },
    :approval_description => { kind: :property, name: "approvalDescription", is_optional: true },
    :certify_for_marketplace => { kind: :property, name: "certifyForMarketplace", is_optional: true },
    :client_token => { kind: :property, name: "clientToken", is_optional: true },
    :customer_metadata_properties => { kind: :property, name: "customerMetadataProperties", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :drift_check_baselines => { kind: :property, name: "driftCheckBaselines", is_optional: true },
    :inference_specification => { kind: :property, name: "inferenceSpecification", is_optional: true },
    :last_modified_time => { kind: :property, name: "lastModifiedTime", is_optional: true },
    :metadata_properties => { kind: :property, name: "metadataProperties", is_optional: true },
    :model_approval_status => { kind: :property, name: "modelApprovalStatus", is_optional: true },
    :model_card => { kind: :property, name: "modelCard", is_optional: true },
    :model_metrics => { kind: :property, name: "modelMetrics", is_optional: true },
    :model_package_description => { kind: :property, name: "modelPackageDescription", is_optional: true },
    :model_package_group_name => { kind: :property, name: "modelPackageGroupName", is_optional: true },
    :model_package_name => { kind: :property, name: "modelPackageName", is_optional: true },
    :model_package_status_details => { kind: :property, name: "modelPackageStatusDetails", is_optional: true },
    :model_package_version => { kind: :property, name: "modelPackageVersion", is_optional: true },
    :sample_payload_url => { kind: :property, name: "samplePayloadUrl", is_optional: true },
    :security_config => { kind: :property, name: "securityConfig", is_optional: true },
    :skip_model_validation => { kind: :property, name: "skipModelValidation", is_optional: true },
    :source_algorithm_specification => { kind: :property, name: "sourceAlgorithmSpecification", is_optional: true },
    :source_uri => { kind: :property, name: "sourceUri", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :task => { kind: :property, name: "task", is_optional: true },
    :validation_specification => { kind: :property, name: "validationSpecification", 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.



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

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:



653
654
655
656
# File 'sagemaker/cfn_model_package.rb', line 653

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:



663
664
665
666
# File 'sagemaker/cfn_model_package.rb', line 663

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.



674
675
676
677
678
# File 'sagemaker/cfn_model_package.rb', line 674

def (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.


731
732
733
734
735
# File 'sagemaker/cfn_model_package.rb', line 731

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.



741
742
743
744
# File 'sagemaker/cfn_model_package.rb', line 741

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.



753
754
755
756
757
# File 'sagemaker/cfn_model_package.rb', line 753

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

#additional_inference_specificationsAWSCDK::IResolvable, ...

An array of additional Inference Specification objects.



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

def additional_inference_specifications()
  jsii_get_property("additionalInferenceSpecifications")
end

#additional_inference_specifications=(value) ⇒ Object



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

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

#additional_inference_specifications_to_addAWSCDK::IResolvable, ...

An array of additional Inference Specification objects to be added to the existing array.



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

def additional_inference_specifications_to_add()
  jsii_get_property("additionalInferenceSpecificationsToAdd")
end

#additional_inference_specifications_to_add=(value) ⇒ Object



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

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



766
767
768
769
# File 'sagemaker/cfn_model_package.rb', line 766

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:



788
789
790
791
792
793
# File 'sagemaker/cfn_model_package.rb', line 788

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

#approval_descriptionString?

A description provided when the model approval is set.

Returns:

  • (String, nil)


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

def approval_description()
  jsii_get_property("approvalDescription")
end

#approval_description=(value) ⇒ Object



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

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

#attr_creation_timeString

The time that the model package was created.

Returns:

  • (String)


222
223
224
# File 'sagemaker/cfn_model_package.rb', line 222

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_last_modified_timeString

The time at which the model package was last modified.

Returns:

  • (String)


229
230
231
# File 'sagemaker/cfn_model_package.rb', line 229

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#attr_model_package_arnString

The Amazon Resource Name (ARN) of the model package.

Returns:

  • (String)


236
237
238
# File 'sagemaker/cfn_model_package.rb', line 236

def attr_model_package_arn()
  jsii_get_property("attrModelPackageArn")
end

#attr_model_package_statusString

The status of the model package. This can be one of the following values.

  • PENDING - The model package creation is pending.
  • IN_PROGRESS - The model package is in the process of being created.
  • COMPLETED - The model package was successfully created.
  • FAILED - The model package creation failed.
  • DELETING - The model package is in the process of being deleted.

Returns:

  • (String)


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

def attr_model_package_status()
  jsii_get_property("attrModelPackageStatus")
end

#certify_for_marketplaceBoolean, ...

Whether the model package is to be certified to be listed on AWS Marketplace.

Returns:



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

def certify_for_marketplace()
  jsii_get_property("certifyForMarketplace")
end

#certify_for_marketplace=(value) ⇒ Object



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

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

#cfn_optionsAWSCDK::ICfnResourceOptions

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



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


173
174
175
# File 'sagemaker/cfn_model_package.rb', line 173

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


797
798
799
800
# File 'sagemaker/cfn_model_package.rb', line 797

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_tokenString?

A unique token that guarantees that the call to this API is idempotent.

Returns:

  • (String, nil)


318
319
320
# File 'sagemaker/cfn_model_package.rb', line 318

def client_token()
  jsii_get_property("clientToken")
end

#client_token=(value) ⇒ Object



322
323
324
325
# File 'sagemaker/cfn_model_package.rb', line 322

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

#creation_stackArray<String>

Returns:

  • (Array<String>)


130
131
132
# File 'sagemaker/cfn_model_package.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#customer_metadata_propertiesAWSCDK::IResolvable, ...

The metadata properties for the model package.

Returns:



330
331
332
# File 'sagemaker/cfn_model_package.rb', line 330

def ()
  jsii_get_property("customerMetadataProperties")
end

#customer_metadata_properties=(value) ⇒ Object



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

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

#domainString?

The machine learning domain of your model package and its components.

Returns:

  • (String, nil)


342
343
344
# File 'sagemaker/cfn_model_package.rb', line 342

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object



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

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

#drift_check_baselinesAWSCDK::IResolvable, ...

Represents the drift check baselines that can be used when the model monitor is set using the model package.



354
355
356
# File 'sagemaker/cfn_model_package.rb', line 354

def drift_check_baselines()
  jsii_get_property("driftCheckBaselines")
end

#drift_check_baselines=(value) ⇒ Object



358
359
360
361
362
# File 'sagemaker/cfn_model_package.rb', line 358

def drift_check_baselines=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::DriftCheckBaselinesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLkRyaWZ0Q2hlY2tCYXNlbGluZXNQcm9wZXJ0eSJ9XX19")), "driftCheckBaselines") unless value.nil?
  jsii_set_property("driftCheckBaselines", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



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

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:



810
811
812
813
814
# File 'sagemaker/cfn_model_package.rb', line 810

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.



821
822
823
824
# File 'sagemaker/cfn_model_package.rb', line 821

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

#inference_specificationAWSCDK::IResolvable, ...

Defines how to perform inference generation after a training job is run.



367
368
369
# File 'sagemaker/cfn_model_package.rb', line 367

def inference_specification()
  jsii_get_property("inferenceSpecification")
end

#inference_specification=(value) ⇒ Object



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

def inference_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::InferenceSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLkluZmVyZW5jZVNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "inferenceSpecification") unless value.nil?
  jsii_set_property("inferenceSpecification", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



891
892
893
894
# File 'sagemaker/cfn_model_package.rb', line 891

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

#last_modified_timeString?

The last time the model package was modified.

Returns:

  • (String, nil)


380
381
382
# File 'sagemaker/cfn_model_package.rb', line 380

def last_modified_time()
  jsii_get_property("lastModifiedTime")
end

#last_modified_time=(value) ⇒ Object



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

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

#logical_idString

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)


142
143
144
# File 'sagemaker/cfn_model_package.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#metadata_propertiesAWSCDK::IResolvable, ...

Metadata properties of the tracking entity, trial, or trial component.



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

def ()
  jsii_get_property("metadataProperties")
end

#metadata_properties=(value) ⇒ Object



396
397
398
399
400
# File 'sagemaker/cfn_model_package.rb', line 396

def (value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::MetadataPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLk1ldGFkYXRhUHJvcGVydGllc1Byb3BlcnR5In1dfX0=")), "metadataProperties") unless value.nil?
  jsii_set_property("metadataProperties", value)
end

#model_approval_statusString?

The approval status of the model.

This can be one of the following values.

Returns:

  • (String, nil)


407
408
409
# File 'sagemaker/cfn_model_package.rb', line 407

def model_approval_status()
  jsii_get_property("modelApprovalStatus")
end

#model_approval_status=(value) ⇒ Object



411
412
413
414
# File 'sagemaker/cfn_model_package.rb', line 411

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

#model_cardAWSCDK::IResolvable, ...

An Amazon SageMaker Model Card.



419
420
421
# File 'sagemaker/cfn_model_package.rb', line 419

def model_card()
  jsii_get_property("modelCard")
end

#model_card=(value) ⇒ Object



423
424
425
426
427
# File 'sagemaker/cfn_model_package.rb', line 423

def model_card=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::ModelCardProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLk1vZGVsQ2FyZFByb3BlcnR5In1dfX0=")), "modelCard") unless value.nil?
  jsii_set_property("modelCard", value)
end

#model_metricsAWSCDK::IResolvable, ...

Metrics for the model.



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

def model_metrics()
  jsii_get_property("modelMetrics")
end

#model_metrics=(value) ⇒ Object



436
437
438
439
440
# File 'sagemaker/cfn_model_package.rb', line 436

def model_metrics=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::ModelMetricsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLk1vZGVsTWV0cmljc1Byb3BlcnR5In1dfX0=")), "modelMetrics") unless value.nil?
  jsii_set_property("modelMetrics", value)
end

#model_package_descriptionString?

The description of the model package.

Returns:

  • (String, nil)


445
446
447
# File 'sagemaker/cfn_model_package.rb', line 445

def model_package_description()
  jsii_get_property("modelPackageDescription")
end

#model_package_description=(value) ⇒ Object



449
450
451
452
# File 'sagemaker/cfn_model_package.rb', line 449

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

#model_package_group_nameString?

The model group to which the model belongs.

Returns:

  • (String, nil)


457
458
459
# File 'sagemaker/cfn_model_package.rb', line 457

def model_package_group_name()
  jsii_get_property("modelPackageGroupName")
end

#model_package_group_name=(value) ⇒ Object



461
462
463
464
# File 'sagemaker/cfn_model_package.rb', line 461

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

#model_package_nameString?

The name of the model package.

The name can be as follows:.

Returns:

  • (String, nil)


471
472
473
# File 'sagemaker/cfn_model_package.rb', line 471

def model_package_name()
  jsii_get_property("modelPackageName")
end

#model_package_name=(value) ⇒ Object



475
476
477
478
# File 'sagemaker/cfn_model_package.rb', line 475

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

#model_package_refAWSCDK::Interfaces::AWSSagemaker::ModelPackageReference

A reference to a ModelPackage resource.



256
257
258
# File 'sagemaker/cfn_model_package.rb', line 256

def model_package_ref()
  jsii_get_property("modelPackageRef")
end

#model_package_status_detailsAWSCDK::IResolvable, ...

Specifies the validation and image scan statuses of the model package.



483
484
485
# File 'sagemaker/cfn_model_package.rb', line 483

def model_package_status_details()
  jsii_get_property("modelPackageStatusDetails")
end

#model_package_status_details=(value) ⇒ Object



487
488
489
490
491
# File 'sagemaker/cfn_model_package.rb', line 487

def model_package_status_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::ModelPackageStatusDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLk1vZGVsUGFja2FnZVN0YXR1c0RldGFpbHNQcm9wZXJ0eSJ9XX19")), "modelPackageStatusDetails") unless value.nil?
  jsii_set_property("modelPackageStatusDetails", value)
end

#model_package_versionNumeric?

The version number of a versioned model.

Returns:

  • (Numeric, nil)


496
497
498
# File 'sagemaker/cfn_model_package.rb', line 496

def model_package_version()
  jsii_get_property("modelPackageVersion")
end

#model_package_version=(value) ⇒ Object



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

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


125
126
127
# File 'sagemaker/cfn_model_package.rb', line 125

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



832
833
834
# File 'sagemaker/cfn_model_package.rb', line 832

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



839
840
841
# File 'sagemaker/cfn_model_package.rb', line 839

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.



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

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

#refString

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)


161
162
163
# File 'sagemaker/cfn_model_package.rb', line 161

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:



850
851
852
853
# File 'sagemaker/cfn_model_package.rb', line 850

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


857
858
859
860
# File 'sagemaker/cfn_model_package.rb', line 857

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:



867
868
869
870
871
# File 'sagemaker/cfn_model_package.rb', line 867

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

#sample_payload_urlString?

The Amazon Simple Storage Service path where the sample payload are stored.

Returns:

  • (String, nil)


508
509
510
# File 'sagemaker/cfn_model_package.rb', line 508

def sample_payload_url()
  jsii_get_property("samplePayloadUrl")
end

#sample_payload_url=(value) ⇒ Object



512
513
514
515
# File 'sagemaker/cfn_model_package.rb', line 512

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

#security_configAWSCDK::IResolvable, ...

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.



520
521
522
# File 'sagemaker/cfn_model_package.rb', line 520

def security_config()
  jsii_get_property("securityConfig")
end

#security_config=(value) ⇒ Object



524
525
526
527
528
# File 'sagemaker/cfn_model_package.rb', line 524

def security_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::SecurityConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLlNlY3VyaXR5Q29uZmlnUHJvcGVydHkifV19fQ==")), "securityConfig") unless value.nil?
  jsii_set_property("securityConfig", value)
end

#should_synthesizeBoolean

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.



876
877
878
# File 'sagemaker/cfn_model_package.rb', line 876

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

#skip_model_validationString?

Indicates if you want to skip model validation.

Returns:

  • (String, nil)


533
534
535
# File 'sagemaker/cfn_model_package.rb', line 533

def skip_model_validation()
  jsii_get_property("skipModelValidation")
end

#skip_model_validation=(value) ⇒ Object



537
538
539
540
# File 'sagemaker/cfn_model_package.rb', line 537

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

#source_algorithm_specificationAWSCDK::IResolvable, ...

A list of algorithms that were used to create a model package.



545
546
547
# File 'sagemaker/cfn_model_package.rb', line 545

def source_algorithm_specification()
  jsii_get_property("sourceAlgorithmSpecification")
end

#source_algorithm_specification=(value) ⇒ Object



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

def source_algorithm_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::SourceAlgorithmSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLlNvdXJjZUFsZ29yaXRobVNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "sourceAlgorithmSpecification") unless value.nil?
  jsii_set_property("sourceAlgorithmSpecification", value)
end

#source_uriString?

The URI of the source for the model package.

Returns:

  • (String, nil)


558
559
560
# File 'sagemaker/cfn_model_package.rb', line 558

def source_uri()
  jsii_get_property("sourceUri")
end

#source_uri=(value) ⇒ Object



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

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



151
152
153
# File 'sagemaker/cfn_model_package.rb', line 151

def stack()
  jsii_get_property("stack")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



263
264
265
# File 'sagemaker/cfn_model_package.rb', line 263

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

A list of the tags associated with the model package.

Returns:



570
571
572
# File 'sagemaker/cfn_model_package.rb', line 570

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



574
575
576
577
578
# File 'sagemaker/cfn_model_package.rb', line 574

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

#taskString?

The machine learning task your model package accomplishes.

Returns:

  • (String, nil)


583
584
585
# File 'sagemaker/cfn_model_package.rb', line 583

def task()
  jsii_get_property("task")
end

#task=(value) ⇒ Object



587
588
589
590
# File 'sagemaker/cfn_model_package.rb', line 587

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



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

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

#updated_properitesHash{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})


198
199
200
# File 'sagemaker/cfn_model_package.rb', line 198

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


208
209
210
# File 'sagemaker/cfn_model_package.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


882
883
884
885
# File 'sagemaker/cfn_model_package.rb', line 882

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

#validation_specificationAWSCDK::IResolvable, ...

Specifies batch transform jobs that SageMaker runs to validate your model package.



595
596
597
# File 'sagemaker/cfn_model_package.rb', line 595

def validation_specification()
  jsii_get_property("validationSpecification")
end

#validation_specification=(value) ⇒ Object



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

def validation_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelPackage::ValidationSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxQYWNrYWdlLlZhbGlkYXRpb25TcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "validationSpecification") unless value.nil?
  jsii_set_property("validationSpecification", 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)


621
622
623
624
625
626
# File 'sagemaker/cfn_model_package.rb', line 621

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