Package software.amazon.awscdk.services.sagemaker

Interface CfnModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:15.780Z")
@Stability(Stable)
public interface CfnModelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnModel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 Object environment;
 CfnModelProps cfnModelProps = CfnModelProps.builder()
         .containers(List.of(ContainerDefinitionProperty.builder()
                 .containerHostname("containerHostname")
                 .environment(environment)
                 .image("image")
                 .imageConfig(ImageConfigProperty.builder()
                         .repositoryAccessMode("repositoryAccessMode")
                         // the properties below are optional
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .inferenceSpecificationName("inferenceSpecificationName")
                 .mode("mode")
                 .modelDataSource(ModelDataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .compressionType("compressionType")
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .hubAccessConfig(HubAccessConfigProperty.builder()
                                         .hubContentArn("hubContentArn")
                                         .build())
                                 .modelAccessConfig(ModelAccessConfigProperty.builder()
                                         .acceptEula(false)
                                         .build())
                                 .build())
                         .build())
                 .modelDataUrl("modelDataUrl")
                 .modelPackageName("modelPackageName")
                 .multiModelConfig(MultiModelConfigProperty.builder()
                         .modelCacheSetting("modelCacheSetting")
                         .build())
                 .build()))
         .enableNetworkIsolation(false)
         .executionRoleArn("executionRoleArn")
         .inferenceExecutionConfig(InferenceExecutionConfigProperty.builder()
                 .mode("mode")
                 .build())
         .modelName("modelName")
         .primaryContainer(ContainerDefinitionProperty.builder()
                 .containerHostname("containerHostname")
                 .environment(environment)
                 .image("image")
                 .imageConfig(ImageConfigProperty.builder()
                         .repositoryAccessMode("repositoryAccessMode")
                         // the properties below are optional
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .inferenceSpecificationName("inferenceSpecificationName")
                 .mode("mode")
                 .modelDataSource(ModelDataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .compressionType("compressionType")
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .hubAccessConfig(HubAccessConfigProperty.builder()
                                         .hubContentArn("hubContentArn")
                                         .build())
                                 .modelAccessConfig(ModelAccessConfigProperty.builder()
                                         .acceptEula(false)
                                         .build())
                                 .build())
                         .build())
                 .modelDataUrl("modelDataUrl")
                 .modelPackageName("modelPackageName")
                 .multiModelConfig(MultiModelConfigProperty.builder()
                         .modelCacheSetting("modelCacheSetting")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelProps.Builder	A builder for CfnModelProps
static final class	CfnModelProps.Jsii$Proxy	An implementation for CfnModelProps

Method Summary

Modifier and Type	Method	Description
static CfnModelProps.Builder	builder()
default Object	getContainers()	Specifies the containers in the inference pipeline.
default Object	getEnableNetworkIsolation()	Isolates the model container.
default String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs.
default Object	getInferenceExecutionConfig()	Specifies details of how containers in a multi-container endpoint are called.
default String	getModelName()	The name of the new model.
default Object	getPrimaryContainer()	The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.
default Object	getVpcConfig()	A VpcConfig object that specifies the VPC that you want your model to connect to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainers

@Stability(Stable)
@Nullable
default Object getContainers()

Specifies the containers in the inference pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-containers

getEnableNetworkIsolation

@Stability(Stable)
@Nullable
default Object getEnableNetworkIsolation()

Isolates the model container.

No inbound or outbound network calls can be made to or from the model container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-enablenetworkisolation

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs.

Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles .

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-executionrolearn

getInferenceExecutionConfig

@Stability(Stable)
@Nullable
default Object getInferenceExecutionConfig()

Specifies details of how containers in a multi-container endpoint are called.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-inferenceexecutionconfig

getModelName

@Stability(Stable)
@Nullable
default String getModelName()

The name of the new model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-modelname

getPrimaryContainer

@Stability(Stable)
@Nullable
default Object getPrimaryContainer()

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-primarycontainer

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-tags

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-model.html#cfn-sagemaker-model-vpcconfig

builder

@Stability(Stable)
static CfnModelProps.Builder builder()

Returns:

a CfnModelProps.Builder of CfnModelProps