Package software.amazon.awscdk.services.sagemaker.alpha

Interface ModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.91.0 (build 1b1f239)",
           date="2023-11-16T22:34:13.149Z")
@Stability(Experimental)
public interface ModelProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a SageMaker Model.

Example:

 import software.amazon.awscdk.services.sagemaker.alpha.*;
 import path.*;
 ContainerImage image = ContainerImage.fromAsset(join("path", "to", "Dockerfile", "directory"));
 ModelData modelData = ModelData.fromAsset(join("path", "to", "artifact", "file.tar.gz"));
 Model model = Model.Builder.create(this, "PrimaryContainerModel")
         .containers(List.of(ContainerDefinition.builder()
                 .image(image)
                 .modelData(modelData)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ModelProps.Builder	builder()
default Boolean	getAllowAllOutbound()	(experimental) Whether to allow the SageMaker Model to send all network traffic.
default List<ContainerDefinition>	getContainers()	(experimental) Specifies the container definitions for this model, consisting of either a single primary container or an inference pipeline of multiple containers.
default String	getModelName()	(experimental) Name of the SageMaker Model.
default IRole	getRole()	(experimental) The IAM role that the Amazon SageMaker service assumes.
default List<ISecurityGroup>	getSecurityGroups()	(experimental) The security groups to associate to the Model.
default IVpc	getVpc()	(experimental) The VPC to deploy model containers to.
default SubnetSelection	getVpcSubnets()	(experimental) The VPC subnets to use when deploying model containers.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowAllOutbound

@Stability(Experimental)
@Nullable
default Boolean getAllowAllOutbound()

(experimental) Whether to allow the SageMaker Model to send all network traffic.

If set to false, you must individually add traffic rules to allow the SageMaker Model to connect to network targets.

Only used if 'vpc' is supplied.

Default: true

getContainers

@Stability(Experimental)
@Nullable
default List<ContainerDefinition> getContainers()

(experimental) Specifies the container definitions for this model, consisting of either a single primary container or an inference pipeline of multiple containers.

Default: - none

getModelName

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

(experimental) Name of the SageMaker Model.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the model's name.

getRole

@Stability(Experimental)
@Nullable
default IRole getRole()

(experimental) The IAM role that the Amazon SageMaker service assumes.

Default: - a new IAM role will be created with the `AmazonSageMakerFullAccess` policy attached.

See Also:

• https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createmodel-perms

getSecurityGroups

@Stability(Experimental)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) The security groups to associate to the Model.

If no security groups are provided and 'vpc' is configured, one security group will be created automatically.

Default: - A security group will be automatically created if 'vpc' is supplied

getVpc

@Stability(Experimental)
@Nullable
default IVpc getVpc()

(experimental) The VPC to deploy model containers to.

Default: - none

getVpcSubnets

@Stability(Experimental)
@Nullable
default SubnetSelection getVpcSubnets()

(experimental) The VPC subnets to use when deploying model containers.

Default: - none

builder

@Stability(Experimental)
static ModelProps.Builder builder()

Returns:

a ModelProps.Builder of ModelProps