Interface IContainerDefinition

(experimental) Describes the container, as part of model definition.

Namespace: Amazon.CDK.AWS.Sagemaker.Alpha

Assembly: Amazon.CDK.AWS.Sagemaker.Alpha.dll

Syntax (csharp)

public interface IContainerDefinition

Syntax (vb)

Public Interface IContainerDefinition

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker.Alpha;

             ContainerImage containerImage;
             ModelData modelData;

             var containerDefinition = new ContainerDefinition {
                 Image = containerImage,

                 // the properties below are optional
                 ContainerHostname = "containerHostname",
                 Environment = new Dictionary<string, string> {
                     { "environmentKey", "environment" }
                 },
                 ModelData = modelData
             };

Synopsis

Properties

ContainerHostname	(experimental) Hostname of the container within an inference pipeline.
Environment	(experimental) A map of environment variables to pass into the container.
Image	(experimental) The image used to start a container.
ModelData	(experimental) S3 path to the model artifacts.

Properties

ContainerHostname

(experimental) Hostname of the container within an inference pipeline.

string? ContainerHostname { get; }

Property Value

string

Remarks

For single container models, this field is ignored. When specifying a hostname for one ContainerDefinition in a pipeline, hostnames must be specified for all other ContainerDefinitions in that pipeline.

Default: - Amazon SageMaker will automatically assign a unique name based on the position of this ContainerDefinition in an inference pipeline.

Stability: Experimental

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-containerhostname

Environment

(experimental) A map of environment variables to pass into the container.

IDictionary<string, string>? Environment { get; }

Property Value

IDictionary<string, string>

Remarks

Default: - none

Stability: Experimental

Image

(experimental) The image used to start a container.

ContainerImage Image { get; }

Property Value

ContainerImage

Remarks

Stability: Experimental

ModelData

(experimental) S3 path to the model artifacts.

ModelData? ModelData { get; }

Property Value

ModelData

Remarks

Default: - none

Stability: Experimental