> **Experimental**
>
> `@aws-cdk/aws-sagemaker-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# Model

Defines a SageMaker Model.

Extends: Construct › Resource › Model
Implements: IModel, IResource, IConnectable, IGrantable, IEnvironmentAware, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/model.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0-alpha.0/packages/@aws-cdk/aws-sagemaker-alpha/lib/model.ts#L228)

## Example

```ts
import * as sagemaker from '@aws-cdk/aws-sagemaker-alpha';

declare const image: sagemaker.ContainerImage;
declare const modelData: sagemaker.ModelData;

const model = new sagemaker.Model(this, 'ContainerModel', {
  containers: [
    {
      image,
      modelData,
    }
  ],
  networkIsolation: true,
});
```

## Initializer

```ts
new Model(scope: Construct, id: string, props?: ModelProps)
```

## Construct Props

- `allowAllOutbound`: boolean = true — 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.

- `containers`: [ContainerDefinition](/cdk/api/v2/docs/@aws-cdk_aws-sagemaker-alpha.ContainerDefinition.html)[] = none — Specifies the container definitions for this model, consisting of either a single primary container or an inference pipeline of multiple containers.

- `modelName`: string = AWS CloudFormation generates a unique physical ID and uses that ID for the model's name. — Name of the SageMaker Model.

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

- `networkIsolation`: boolean = false — Whether to enable network isolation for the model container.

  When enabled, no inbound or outbound network calls can be made to or from the model container.

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = a new IAM role will be created with the `AmazonSageMakerFullAccess` policy attached. — The IAM role that the Amazon SageMaker service assumes.

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

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] = A security group will be automatically created if 'vpc' is supplied — 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

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) = none — The VPC to deploy model containers to.

- `vpcSubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) = none — The VPC subnets to use when deploying model containers.

## Properties

- `connections`: [Connections](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Connections.html) (required) — An accessor for the Connections object that will fail if this Model does not have a VPC configured.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) (required) — The principal this Model is running as.

- `modelArn`: string (required) — Returns the ARN of this model.

- `modelName`: string (required) — Returns the name of the model.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — Execution role for SageMaker Model.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `addContainer(container: ContainerDefinition): void` — Add containers to the model.

  **Parameters**

  - `container` — The container definition to add.

- `addToRolePolicy(statement: PolicyStatement): void` — Adds a statement to the IAM role assumed by the instance.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromModelArn(scope: Construct, id: string, modelArn: string): IModel` (static) — Imports a Model defined either outside the CDK or in a different CDK stack.

  **Parameters**

  - `scope` — the Construct scope.
  - `id` — the resource id.
  - `modelArn` — the ARN of the model.

- `fromModelAttributes(scope: Construct, id: string, attrs: ModelAttributes): IModel` (static) — Imports a Model defined either outside the CDK or in a different CDK stack.

  **Parameters**

  - `scope` — the Construct scope.
  - `id` — the resource id.
  - `attrs` — the attributes of the model to import.

- `fromModelName(scope: Construct, id: string, modelName: string): IModel` (static) — Imports a Model defined either outside the CDK or in a different CDK stack.

  **Parameters**

  - `scope` — the Construct scope.
  - `id` — the resource id.
  - `modelName` — the name of the model.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.