Class: AWSCDK::Sagemaker::CfnInferenceComponent

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSagemaker::IInferenceComponentRef
Defined in:
sagemaker/cfn_inference_component.rb

Overview

Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint.

In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInferenceComponent

Create a new AWS::SageMaker::InferenceComponent.

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

    Resource properties.



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

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

Class Method Details

.arn_for_inference_component(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'sagemaker/cfn_inference_component.rb', line 88

def self.arn_for_inference_component(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSUluZmVyZW5jZUNvbXBvbmVudFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnInferenceComponent", "arnForInferenceComponent", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'sagemaker/cfn_inference_component.rb', line 195

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

.is_cfn_inference_component(x) ⇒ Boolean

Checks whether the given object is a CfnInferenceComponent.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_inference_component(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnInferenceComponent", "isCfnInferenceComponent", [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
 
# File 'sagemaker/cfn_inference_component.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_inference_component_arn => { kind: :property, name: "attrInferenceComponentArn", is_optional: false },
    :attr_inference_component_status => { kind: :property, name: "attrInferenceComponentStatus", is_optional: false },
    :attr_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :attr_runtime_config_current_copy_count => { kind: :property, name: "attrRuntimeConfigCurrentCopyCount", is_optional: false },
    :attr_runtime_config_desired_copy_count => { kind: :property, name: "attrRuntimeConfigDesiredCopyCount", is_optional: false },
    :attr_specification_container_deployed_image => { kind: :property, name: "attrSpecificationContainerDeployedImage", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :inference_component_ref => { kind: :property, name: "inferenceComponentRef", is_optional: false },
    :endpoint_name => { kind: :property, name: "endpointName", is_optional: false },
    :specification => { kind: :property, name: "specification", is_optional: false },
    :deployment_config => { kind: :property, name: "deploymentConfig", is_optional: true },
    :endpoint_arn => { kind: :property, name: "endpointArn", is_optional: true },
    :inference_component_name => { kind: :property, name: "inferenceComponentName", is_optional: true },
    :runtime_config => { kind: :property, name: "runtimeConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :variant_name => { kind: :property, name: "variantName", 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.



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

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:



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

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:



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

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:



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

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.


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

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.



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

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.



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

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:



528
529
530
531
 
# File 'sagemaker/cfn_inference_component.rb', line 528

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:



550
551
552
553
554
555
 
# File 'sagemaker/cfn_inference_component.rb', line 550

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

#attr_creation_time ⇒ String

The time when the inference component was created.

Returns:

  • (String) 


202
203
204
 
# File 'sagemaker/cfn_inference_component.rb', line 202

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_failure_reason ⇒ String

The failure reason if the inference component is in a failed state.

Returns:

  • (String) 


209
210
211
 
# File 'sagemaker/cfn_inference_component.rb', line 209

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_inference_component_arn ⇒ String

The Amazon Resource Name (ARN) of the inference component.

Returns:

  • (String) 


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

def attr_inference_component_arn()
  jsii_get_property("attrInferenceComponentArn")
end

#attr_inference_component_status ⇒ String

The status of the inference component.

Returns:

  • (String) 


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

def attr_inference_component_status()
  jsii_get_property("attrInferenceComponentStatus")
end

#attr_last_modified_time ⇒ String

The time when the inference component was last updated.

Returns:

  • (String) 


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

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#attr_runtime_config_current_copy_count ⇒ Numeric

The number of runtime copies of the model container that are currently deployed.

Returns:

  • (Numeric) 


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

def attr_runtime_config_current_copy_count()
  jsii_get_property("attrRuntimeConfigCurrentCopyCount")
end

#attr_runtime_config_desired_copy_count ⇒ Numeric

The number of runtime copies of the model container that you requested to deploy with the inference component.

Returns:

  • (Numeric) 


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

def attr_runtime_config_desired_copy_count()
  jsii_get_property("attrRuntimeConfigDesiredCopyCount")
end

#attr_specification_container_deployed_image ⇒ AWSCDK::IResolvable

Returns:



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

def attr_specification_container_deployed_image()
  jsii_get_property("attrSpecificationContainerDeployedImage")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'sagemaker/cfn_inference_component.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#deployment_config ⇒ AWSCDK::IResolvable, ...

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

Returns:



295
296
297
 
# File 'sagemaker/cfn_inference_component.rb', line 295

def deployment_config()
  jsii_get_property("deploymentConfig")
end

#deployment_config=(value) ⇒ Object 



299
300
301
302
303
 
# File 'sagemaker/cfn_inference_component.rb', line 299

def deployment_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnInferenceComponent::InferenceComponentDeploymentConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuSW5mZXJlbmNlQ29tcG9uZW50LkluZmVyZW5jZUNvbXBvbmVudERlcGxveW1lbnRDb25maWdQcm9wZXJ0eSJ9XX19")), "deploymentConfig") unless value.nil?
  jsii_set_property("deploymentConfig", value)
end

#endpoint_arn ⇒ String?

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

Returns:

  • (String, nil) 


308
309
310
 
# File 'sagemaker/cfn_inference_component.rb', line 308

def endpoint_arn()
  jsii_get_property("endpointArn")
end

#endpoint_arn=(value) ⇒ Object 



312
313
314
315
 
# File 'sagemaker/cfn_inference_component.rb', line 312

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

#endpoint_name ⇒ String

The name of the endpoint that hosts the inference component.

Returns:

  • (String) 


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

def endpoint_name()
  jsii_get_property("endpointName")
end

#endpoint_name=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'sagemaker/cfn_inference_component.rb', line 170

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:



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

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:



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

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

#inference_component_name ⇒ String?

The name of the inference component.

Returns:

  • (String, nil) 


320
321
322
 
# File 'sagemaker/cfn_inference_component.rb', line 320

def inference_component_name()
  jsii_get_property("inferenceComponentName")
end

#inference_component_name=(value) ⇒ Object 



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

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

#inference_component_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::InferenceComponentReference

A reference to a InferenceComponent resource.

Returns:



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

def inference_component_ref()
  jsii_get_property("inferenceComponentRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



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

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


122
123
124
 
# File 'sagemaker/cfn_inference_component.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'sagemaker/cfn_inference_component.rb', line 105

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:



594
595
596
 
# File 'sagemaker/cfn_inference_component.rb', line 594

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:



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

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.



394
395
396
397
 
# File 'sagemaker/cfn_inference_component.rb', line 394

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) 


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

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:



612
613
614
615
 
# File 'sagemaker/cfn_inference_component.rb', line 612

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


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

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:



629
630
631
632
633
 
# File 'sagemaker/cfn_inference_component.rb', line 629

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

#runtime_config ⇒ AWSCDK::IResolvable, ...

The runtime config for the inference component.

Returns:



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

def runtime_config()
  jsii_get_property("runtimeConfig")
end

#runtime_config=(value) ⇒ Object 



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

def runtime_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnInferenceComponent::InferenceComponentRuntimeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuSW5mZXJlbmNlQ29tcG9uZW50LkluZmVyZW5jZUNvbXBvbmVudFJ1bnRpbWVDb25maWdQcm9wZXJ0eSJ9XX19")), "runtimeConfig") unless value.nil?
  jsii_set_property("runtimeConfig", 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.



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

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

#specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnInferenceComponent::InferenceComponentSpecificationProperty

The specification for the inference component.

Returns:



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

def specification()
  jsii_get_property("specification")
end

#specification=(value) ⇒ Object 



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

def specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnInferenceComponent::InferenceComponentSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuSW5mZXJlbmNlQ29tcG9uZW50LkluZmVyZW5jZUNvbXBvbmVudFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "specification")
  jsii_set_property("specification", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of tags to apply to the resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


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

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


188
189
190
 
# File 'sagemaker/cfn_inference_component.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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

#variant_name ⇒ String?

The name of the production variant that hosts the inference component.

Returns:

  • (String, nil) 


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

def variant_name()
  jsii_get_property("variantName")
end

#variant_name=(value) ⇒ Object 



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

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


383
384
385
386
387
388
 
# File 'sagemaker/cfn_inference_component.rb', line 383

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