Class: AWSCDK::Sagemaker::CfnModelCard

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

Overview

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnModelCard

Create a new AWS::SageMaker::ModelCard.

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::CfnModelCardProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_model_card(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_model_card(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSU1vZGVsQ2FyZFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelCard", "arnForModelCard", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


223
224
225
 
# File 'sagemaker/cfn_model_card.rb', line 223

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

.from_model_card_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSSagemaker::IModelCardRef

Creates a new IModelCardRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



101
102
103
104
105
106
 
# File 'sagemaker/cfn_model_card.rb', line 101

def self.from_model_card_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelCard", "fromModelCardArn", [scope, id, arn])
end

.from_model_card_name(scope, id, model_card_name) ⇒ AWSCDK::Interfaces::AWSSagemaker::IModelCardRef

Creates a new IModelCardRef from a modelCardName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • model_card_name (String)

Returns:



114
115
116
117
118
119
 
# File 'sagemaker/cfn_model_card.rb', line 114

def self.from_model_card_name(scope, id, model_card_name)
  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(model_card_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelCardName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelCard", "fromModelCardName", [scope, id, model_card_name])
end

.is_cfn_model_card(x) ⇒ Boolean

Checks whether the given object is a CfnModelCard.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_model_card(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnModelCard", "isCfnModelCard", [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
82
83
84
85
86
 
# File 'sagemaker/cfn_model_card.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_created_by_domain_id => { kind: :property, name: "attrCreatedByDomainId", is_optional: false },
    :attr_created_by_user_profile_arn => { kind: :property, name: "attrCreatedByUserProfileArn", is_optional: false },
    :attr_created_by_user_profile_name => { kind: :property, name: "attrCreatedByUserProfileName", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_last_modified_by_domain_id => { kind: :property, name: "attrLastModifiedByDomainId", is_optional: false },
    :attr_last_modified_by_user_profile_arn => { kind: :property, name: "attrLastModifiedByUserProfileArn", is_optional: false },
    :attr_last_modified_by_user_profile_name => { kind: :property, name: "attrLastModifiedByUserProfileName", is_optional: false },
    :attr_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :attr_model_card_arn => { kind: :property, name: "attrModelCardArn", is_optional: false },
    :attr_model_card_processing_status => { kind: :property, name: "attrModelCardProcessingStatus", is_optional: false },
    :attr_model_card_version => { kind: :property, name: "attrModelCardVersion", is_optional: false },
    :model_card_ref => { kind: :property, name: "modelCardRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :content => { kind: :property, name: "content", is_optional: false },
    :model_card_name => { kind: :property, name: "modelCardName", is_optional: false },
    :model_card_status => { kind: :property, name: "modelCardStatus", is_optional: false },
    :created_by => { kind: :property, name: "createdBy", is_optional: true },
    :last_modified_by => { kind: :property, name: "lastModifiedBy", is_optional: true },
    :security_config => { kind: :property, name: "securityConfig", 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.



447
448
449
450
 
# File 'sagemaker/cfn_model_card.rb', line 447

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:



459
460
461
462
 
# File 'sagemaker/cfn_model_card.rb', line 459

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:



469
470
471
472
 
# File 'sagemaker/cfn_model_card.rb', line 469

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:



480
481
482
483
484
 
# File 'sagemaker/cfn_model_card.rb', line 480

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.


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

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.



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

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.



559
560
561
562
563
 
# File 'sagemaker/cfn_model_card.rb', line 559

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:



572
573
574
575
 
# File 'sagemaker/cfn_model_card.rb', line 572

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:



594
595
596
597
598
599
 
# File 'sagemaker/cfn_model_card.rb', line 594

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

The domain associated with the user.

Returns:

  • (String) 


230
231
232
 
# File 'sagemaker/cfn_model_card.rb', line 230

def attr_created_by_domain_id()
  jsii_get_property("attrCreatedByDomainId")
end

#attr_created_by_user_profile_arn ⇒ String

The Amazon Resource Name (ARN) of the user's profile.

Returns:

  • (String) 


237
238
239
 
# File 'sagemaker/cfn_model_card.rb', line 237

def ()
  jsii_get_property("attrCreatedByUserProfileArn")
end

#attr_created_by_user_profile_name ⇒ String

The name of the user's profile.

Returns:

  • (String) 


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

def ()
  jsii_get_property("attrCreatedByUserProfileName")
end

#attr_creation_time ⇒ String

The date and time the model card was created.

Returns:

  • (String) 


251
252
253
 
# File 'sagemaker/cfn_model_card.rb', line 251

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_last_modified_by_domain_id ⇒ String

The domain associated with the user.

Returns:

  • (String) 


258
259
260
 
# File 'sagemaker/cfn_model_card.rb', line 258

def attr_last_modified_by_domain_id()
  jsii_get_property("attrLastModifiedByDomainId")
end

#attr_last_modified_by_user_profile_arn ⇒ String

The Amazon Resource Name (ARN) of the user's profile.

Returns:

  • (String) 


265
266
267
 
# File 'sagemaker/cfn_model_card.rb', line 265

def ()
  jsii_get_property("attrLastModifiedByUserProfileArn")
end

#attr_last_modified_by_user_profile_name ⇒ String

The name of the user's profile.

Returns:

  • (String) 


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

def ()
  jsii_get_property("attrLastModifiedByUserProfileName")
end

#attr_last_modified_time ⇒ String

The date and time the model card was last modified.

Returns:

  • (String) 


279
280
281
 
# File 'sagemaker/cfn_model_card.rb', line 279

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#attr_model_card_arn ⇒ String

The Amazon Resource Number (ARN) of the model card.

For example, arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard .

Returns:

  • (String) 


288
289
290
 
# File 'sagemaker/cfn_model_card.rb', line 288

def attr_model_card_arn()
  jsii_get_property("attrModelCardArn")
end

#attr_model_card_processing_status ⇒ String

The processing status of model card deletion.

The ModelCardProcessingStatus updates throughout the different deletion steps.

Returns:

  • (String) 


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

def attr_model_card_processing_status()
  jsii_get_property("attrModelCardProcessingStatus")
end

#attr_model_card_version ⇒ Numeric

A version of the model card.

Returns:

  • (Numeric) 


304
305
306
 
# File 'sagemaker/cfn_model_card.rb', line 304

def attr_model_card_version()
  jsii_get_property("attrModelCardVersion")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'sagemaker/cfn_model_card.rb', line 181

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


603
604
605
606
 
# File 'sagemaker/cfn_model_card.rb', line 603

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


186
187
188
 
# File 'sagemaker/cfn_model_card.rb', line 186

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


193
194
195
 
# File 'sagemaker/cfn_model_card.rb', line 193

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::ContentProperty

The content of the model card.

Returns:



325
326
327
 
# File 'sagemaker/cfn_model_card.rb', line 325

def content()
  jsii_get_property("content")
end

#content=(value) ⇒ Object 



329
330
331
332
333
 
# File 'sagemaker/cfn_model_card.rb', line 329

def content=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::ContentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkNvbnRlbnRQcm9wZXJ0eSJ9XX19")), "content")
  jsii_set_property("content", value)
end

#created_by ⇒ AWSCDK::IResolvable, ...

Information about the user who created or modified one or more of the following:.

Returns:



362
363
364
 
# File 'sagemaker/cfn_model_card.rb', line 362

def created_by()
  jsii_get_property("createdBy")
end

#created_by=(value) ⇒ Object 



366
367
368
369
370
 
# File 'sagemaker/cfn_model_card.rb', line 366

def created_by=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::UserContextProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLlVzZXJDb250ZXh0UHJvcGVydHkifV19fQ==")), "createdBy") unless value.nil?
  jsii_set_property("createdBy", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



616
617
618
619
620
 
# File 'sagemaker/cfn_model_card.rb', line 616

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:



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

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:



697
698
699
700
 
# File 'sagemaker/cfn_model_card.rb', line 697

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

#last_modified_by ⇒ AWSCDK::IResolvable, ...

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Returns:



375
376
377
 
# File 'sagemaker/cfn_model_card.rb', line 375

def last_modified_by()
  jsii_get_property("lastModifiedBy")
end

#last_modified_by=(value) ⇒ Object 



379
380
381
382
383
 
# File 'sagemaker/cfn_model_card.rb', line 379

def last_modified_by=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::UserContextProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLlVzZXJDb250ZXh0UHJvcGVydHkifV19fQ==")), "lastModifiedBy") unless value.nil?
  jsii_set_property("lastModifiedBy", 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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#model_card_name ⇒ String

The unique name of the model card.

Returns:

  • (String) 


338
339
340
 
# File 'sagemaker/cfn_model_card.rb', line 338

def model_card_name()
  jsii_get_property("modelCardName")
end

#model_card_name=(value) ⇒ Object 



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

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

#model_card_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::ModelCardReference

A reference to a ModelCard resource.

Returns:



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

def model_card_ref()
  jsii_get_property("modelCardRef")
end

#model_card_status ⇒ String

The approval status of the model card within your organization.

Returns:

  • (String) 


350
351
352
 
# File 'sagemaker/cfn_model_card.rb', line 350

def model_card_status()
  jsii_get_property("modelCardStatus")
end

#model_card_status=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



638
639
640
 
# File 'sagemaker/cfn_model_card.rb', line 638

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:



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

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.



438
439
440
441
 
# File 'sagemaker/cfn_model_card.rb', line 438

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) 


169
170
171
 
# File 'sagemaker/cfn_model_card.rb', line 169

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:



656
657
658
659
 
# File 'sagemaker/cfn_model_card.rb', line 656

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


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

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:



673
674
675
676
677
 
# File 'sagemaker/cfn_model_card.rb', line 673

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

#security_config ⇒ AWSCDK::IResolvable, ...

The security configuration used to protect model card data.

Returns:



388
389
390
 
# File 'sagemaker/cfn_model_card.rb', line 388

def security_config()
  jsii_get_property("securityConfig")
end

#security_config=(value) ⇒ Object 



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

def security_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::SecurityConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLlNlY3VyaXR5Q29uZmlnUHJvcGVydHkifV19fQ==")), "securityConfig") unless value.nil?
  jsii_set_property("securityConfig", 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.



682
683
684
 
# File 'sagemaker/cfn_model_card.rb', line 682

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:



159
160
161
 
# File 'sagemaker/cfn_model_card.rb', line 159

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs used to manage metadata for the model card.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



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

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


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

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


216
217
218
 
# File 'sagemaker/cfn_model_card.rb', line 216

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


688
689
690
691
 
# File 'sagemaker/cfn_model_card.rb', line 688

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) 


427
428
429
430
431
432
 
# File 'sagemaker/cfn_model_card.rb', line 427

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