Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnModelPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnModelPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.087Z")
@Stability(Stable)
public class CfnModelPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::SageMaker::Model resource to create a model to host at an Amazon SageMaker endpoint.

For more information, see Deploying a Model on Amazon SageMaker Hosting Services in the Amazon SageMaker Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 Object environment;
 IMergeStrategy mergeStrategy;
 CfnModelPropsMixin cfnModelPropsMixin = CfnModelPropsMixin.Builder.create(CfnModelMixinProps.builder()
         .containers(List.of(ContainerDefinitionProperty.builder()
                 .containerHostname("containerHostname")
                 .environment(environment)
                 .image("image")
                 .imageConfig(ImageConfigProperty.builder()
                         .repositoryAccessMode("repositoryAccessMode")
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .inferenceSpecificationName("inferenceSpecificationName")
                 .mode("mode")
                 .modelDataSource(ModelDataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .compressionType("compressionType")
                                 .hubAccessConfig(HubAccessConfigProperty.builder()
                                         .hubContentArn("hubContentArn")
                                         .build())
                                 .modelAccessConfig(ModelAccessConfigProperty.builder()
                                         .acceptEula(false)
                                         .build())
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 .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")
                         .repositoryAuthConfig(RepositoryAuthConfigProperty.builder()
                                 .repositoryCredentialsProviderArn("repositoryCredentialsProviderArn")
                                 .build())
                         .build())
                 .inferenceSpecificationName("inferenceSpecificationName")
                 .mode("mode")
                 .modelDataSource(ModelDataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .compressionType("compressionType")
                                 .hubAccessConfig(HubAccessConfigProperty.builder()
                                         .hubContentArn("hubContentArn")
                                         .build())
                                 .modelAccessConfig(ModelAccessConfigProperty.builder()
                                         .acceptEula(false)
                                         .build())
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnModelPropsMixin.Builder	A fluent builder for CfnModelPropsMixin.
static interface	CfnModelPropsMixin.ContainerDefinitionProperty	Describes the container, as part of model definition.
static interface	CfnModelPropsMixin.HubAccessConfigProperty	The configuration for a private hub model reference that points to a public SageMaker JumpStart model.
static interface	CfnModelPropsMixin.ImageConfigProperty	Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC).
static interface	CfnModelPropsMixin.InferenceExecutionConfigProperty	Specifies details about how containers in a multi-container endpoint are run.
static interface	CfnModelPropsMixin.ModelAccessConfigProperty	The access configuration file to control access to the ML model.
static interface	CfnModelPropsMixin.ModelDataSourceProperty	Specifies the location of ML model data to deploy.
static interface	CfnModelPropsMixin.MultiModelConfigProperty	Specifies additional configuration for hosting multi-model endpoints.
static interface	CfnModelPropsMixin.RepositoryAuthConfigProperty	Specifies an authentication configuration for the private docker registry where your model image is hosted.
static interface	CfnModelPropsMixin.S3DataSourceProperty	Describes the S3 data source.
static interface	CfnModelPropsMixin.VpcConfigProperty	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnModelPropsMixin(CfnModelMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::Model.
	CfnModelPropsMixin(CfnModelMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::Model.
protected	CfnModelPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModelPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnModelMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnModelPropsMixin

protected CfnModelPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnModelPropsMixin

protected CfnModelPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnModelPropsMixin

@Stability(Stable)
public CfnModelPropsMixin(@NotNull
 CfnModelMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::Model.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnModelPropsMixin

@Stability(Stable)
public CfnModelPropsMixin(@NotNull
 CfnModelMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::Model.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnModelMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()