Package software.amazon.awscdk.services.sagemaker

Class CfnModel.ContainerDefinitionProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sagemaker.CfnModel.ContainerDefinitionProperty.Jsii$Proxy

All Implemented Interfaces:

CfnModel.ContainerDefinitionProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnModel.ContainerDefinitionProperty

@Stability(Stable)
@Internal
public static final class CfnModel.ContainerDefinitionProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnModel.ContainerDefinitionProperty

An implementation for CfnModel.ContainerDefinitionProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.CfnModel.ContainerDefinitionProperty

CfnModel.ContainerDefinitionProperty.Builder, CfnModel.ContainerDefinitionProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnModel.ContainerDefinitionProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnModel.ContainerDefinitionProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getContainerHostname()	This parameter is ignored for models that contain only a PrimaryContainer .
final Object	getEnvironment()	The environment variables to set in the Docker container.
final String	getImage()	The path where inference code is stored.
final Object	getImageConfig()	Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
final String	getInferenceSpecificationName()	The inference specification name in the model package version.
final String	getMode()	Whether the container hosts a single model or multiple models.
final Object	getModelDataSource()	Specifies the location of ML model data to deploy.
final String	getModelDataUrl()	The S3 path where the model artifacts, which result from model training, are stored.
final String	getModelPackageName()	The name or Amazon Resource Name (ARN) of the model package to use to create the model.
final Object	getMultiModelConfig()	Specifies additional configuration for multi-model endpoints.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnModel.ContainerDefinitionProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnModel.ContainerDefinitionProperty.Builder.

Method Details

getContainerHostname

public final String getContainerHostname()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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.

Specified by:

getContainerHostname in interface CfnModel.ContainerDefinitionProperty

See Also:

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

getEnvironment

public final Object getEnvironment()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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.

Specified by:

getEnvironment in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-environment

getImage

public final String getImage()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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.

Specified by:

getImage in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-image

getImageConfig

public final Object getImageConfig()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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 union: either IResolvable or CfnModel.ImageConfigProperty

Specified by:

getImageConfig in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-imageconfig

getInferenceSpecificationName

public final String getInferenceSpecificationName()

Description copied from interface: CfnModel.ContainerDefinitionProperty

The inference specification name in the model package version.

Specified by:

getInferenceSpecificationName in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-inferencespecificationname

getMode

public final String getMode()

Description copied from interface: CfnModel.ContainerDefinitionProperty

Whether the container hosts a single model or multiple models.

Specified by:

getMode in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-mode

getModelDataSource

public final Object getModelDataSource()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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 union: either IResolvable or CfnModel.ModelDataSourceProperty

Specified by:

getModelDataSource in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldatasource

getModelDataUrl

public final String getModelDataUrl()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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 AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your AWS account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS 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 .

Specified by:

getModelDataUrl in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modeldataurl

getModelPackageName

public final String getModelPackageName()

Description copied from interface: CfnModel.ContainerDefinitionProperty

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

Specified by:

getModelPackageName in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-modelpackagename

getMultiModelConfig

public final Object getMultiModelConfig()

Description copied from interface: CfnModel.ContainerDefinitionProperty

Specifies additional configuration for multi-model endpoints.

Returns union: either IResolvable or CfnModel.MultiModelConfigProperty

Specified by:

getMultiModelConfig in interface CfnModel.ContainerDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition.html#cfn-sagemaker-model-containerdefinition-multimodelconfig

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object