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

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::ContainerDefinition

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sagemaker/types.rb

Overview

Describes the container, as part of model definition.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#additional_model_data_sources ⇒ Array<Types::AdditionalModelDataSource>

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
#container_hostname ⇒ String

This parameter is ignored for models that contain only a PrimaryContainer.
#environment ⇒ Hash<String,String>

The environment variables to set in the Docker container.
#image ⇒ String

The path where inference code is stored.
#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).
#inference_specification_name ⇒ String

The inference specification name in the model package version.
#mode ⇒ String

Whether the container hosts a single model or multiple models.
#model_data_source ⇒ Types::ModelDataSource

Specifies the location of ML model data to deploy.
#model_data_url ⇒ String

The S3 path where the model artifacts, which result from model training, are stored.
#model_package_name ⇒ String

The name or Amazon Resource Name (ARN) of the model package to use to create the model.
#multi_model_config ⇒ Types::MultiModelConfig

Specifies additional configuration for multi-model endpoints.

Instance Attribute Details

#additional_model_data_sources ⇒ `Array<Types::AdditionalModelDataSource>`

Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.

Returns:

(Array<Types::AdditionalModelDataSource>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

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

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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. Don’t include any sensitive data in your environment variables.

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

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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` image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker].

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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].

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html

Returns:

(Types::ImageConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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.

<note markdown=“1”> Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace.

</note>

Returns:

(Types::ModelDataSource)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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].

<note markdown=“1”> The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

</note>

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.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

class ContainerDefinition < Struct.new(
  :container_hostname,
  :image,
  :image_config,
  :mode,
  :model_data_url,
  :model_data_source,
  :additional_model_data_sources,
  :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:

(Types::MultiModelConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 7317

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_model_data_sources ⇒ Array<Types::AdditionalModelDataSource>

#container_hostname ⇒ String

#environment ⇒ Hash<String,String>

#image ⇒ String

#image_config ⇒ Types::ImageConfig

#inference_specification_name ⇒ String

#mode ⇒ String

#model_data_source ⇒ Types::ModelDataSource

#model_data_url ⇒ String

#model_package_name ⇒ String

#multi_model_config ⇒ Types::MultiModelConfig

#additional_model_data_sources ⇒ `Array<Types::AdditionalModelDataSource>`

#container_hostname ⇒ `String`

#environment ⇒ `Hash<String,String>`

#image ⇒ `String`

#image_config ⇒ `Types::ImageConfig`

#inference_specification_name ⇒ `String`

#mode ⇒ `String`

#model_data_source ⇒ `Types::ModelDataSource`

#model_data_url ⇒ `String`

#model_package_name ⇒ `String`

#multi_model_config ⇒ `Types::MultiModelConfig`