Class: Aws::SageMaker::Types::ContainerDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Describes the container, as part of model definition.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_hostname ⇒ String

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Hash<String,String>

The environment variables to set in the Docker container.

The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB.

Returns:

  • (Hash<String,String>) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#image ⇒ String

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#image_config ⇒ Types::ImageConfig

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers.

The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating.

Returns:



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#inference_specification_name ⇒ String

The inference specification name in the model package version.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

Whether the container hosts a single model or multiple models.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_data_source ⇒ Types::ModelDataSource

Specifies the location of ML model data to deploy.

Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

Returns:



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_data_url ⇒ String

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_package_name ⇒ String

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

Returns:

  • (String) 


4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end

#multi_model_config ⇒ Types::MultiModelConfig

Specifies additional configuration for multi-model endpoints.

Returns:



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 4678

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :environment,
  :model_package_name,
  :inference_specification_name,
  :multi_model_config)
  SENSITIVE = []
  include Aws::Structure
end