Domain class
Provides a SageMaker AI Domain resource.
Example Usage
Basic usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.iam.getPolicyDocument({
statements: [{
principals: [{
type: "Service",
identifiers: ["sagemaker.amazonaws.com"],
}],
actions: ["sts:AssumeRole"],
}],
});
const exampleRole = new aws.iam.Role("example", {
name: "example",
path: "/",
assumeRolePolicy: example.then(example => example.json),
});
const exampleDomain = new aws.sagemaker.Domain("example", {
defaultUserSettings: {
executionRole: exampleRole.arn,
},
domainName: "example",
authMode: "IAM",
vpcId: exampleAwsVpc.id,
subnetIds: [exampleAwsSubnet.id],
});
import pulumi
import pulumi_aws as aws
example = aws.iam.get_policy_document(statements=[{
"principals": [{
"type": "Service",
"identifiers": ["sagemaker.amazonaws.com"],
}],
"actions": ["sts:AssumeRole"],
}])
example_role = aws.iam.Role("example",
name="example",
path="/",
assume_role_policy=example.json)
example_domain = aws.sagemaker.Domain("example",
default_user_settings={
"execution_role": example_role.arn,
},
domain_name="example",
auth_mode="IAM",
vpc_id=example_aws_vpc["id"],
subnet_ids=[example_aws_subnet["id"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Principals = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
{
Type = "Service",
Identifiers = new[]
{
"sagemaker.amazonaws.com",
},
},
},
Actions = new[]
{
"sts:AssumeRole",
},
},
},
});
var exampleRole = new Aws.Iam.Role("example", new()
{
Name = "example",
Path = "/",
AssumeRolePolicy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
var exampleDomain = new Aws.Sagemaker.Domain("example", new()
{
DefaultUserSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs
{
ExecutionRole = exampleRole.Arn,
},
DomainName = "example",
AuthMode = "IAM",
VpcId = exampleAwsVpc.Id,
SubnetIds = new[]
{
exampleAwsSubnet.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "Service",
Identifiers: []string{
"sagemaker.amazonaws.com",
},
},
},
Actions: []string{
"sts:AssumeRole",
},
},
},
}, nil)
if err != nil {
return err
}
exampleRole, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
Name: pulumi.String("example"),
Path: pulumi.String("/"),
AssumeRolePolicy: pulumi.String(example.Json),
})
if err != nil {
return err
}
_, err = sagemaker.NewDomain(ctx, "example", &sagemaker.DomainArgs{
DefaultUserSettings: &sagemaker.DomainDefaultUserSettingsArgs{
ExecutionRole: exampleRole.Arn,
},
DomainName: pulumi.String("example"),
AuthMode: pulumi.String("IAM"),
VpcId: pulumi.Any(exampleAwsVpc.Id),
SubnetIds: pulumi.StringArray{
exampleAwsSubnet.Id,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getpolicydocument" "example" {
statements {
principals {
type = "Service"
identifiers = ["sagemaker.amazonaws.com"]
}
actions = ["sts:AssumeRole"]
}
}
resource "aws_sagemaker_domain" "example" {
default_user_settings = {
execution_role = aws_iam_role.example.arn
}
domain_name = "example"
auth_mode = "IAM"
vpc_id = exampleAwsVpc.id
subnet_ids = [exampleAwsSubnet.id]
}
resource "aws_iam_role" "example" {
name = "example"
path = "/"
assume_role_policy = data.aws_iam_getpolicydocument.example.json
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.sagemaker.Domain;
import com.pulumi.aws.sagemaker.DomainArgs;
import com.pulumi.aws.sagemaker.inputs.DomainDefaultUserSettingsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(GetPolicyDocumentStatementArgs.builder()
.principals(GetPolicyDocumentStatementPrincipalArgs.builder()
.type("Service")
.identifiers("sagemaker.amazonaws.com")
.build())
.actions("sts:AssumeRole")
.build())
.build());
var exampleRole = new Role("exampleRole", RoleArgs.builder()
.name("example")
.path("/")
.assumeRolePolicy(example.json())
.build());
var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
.defaultUserSettings(DomainDefaultUserSettingsArgs.builder()
.executionRole(exampleRole.arn())
.build())
.domainName("example")
.authMode("IAM")
.vpcId(exampleAwsVpc.id())
.subnetIds(exampleAwsSubnet.id())
.build());
}
}
resources:
exampleDomain:
type: aws:sagemaker:Domain
name: example
properties:
defaultUserSettings:
executionRole: ${exampleRole.arn}
domainName: example
authMode: IAM
vpcId: ${exampleAwsVpc.id}
subnetIds:
- ${exampleAwsSubnet.id}
exampleRole:
type: aws:iam:Role
name: example
properties:
name: example
path: /
assumeRolePolicy: ${example.json}
variables:
example:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- principals:
- type: Service
identifiers:
- sagemaker.amazonaws.com
actions:
- sts:AssumeRole
Using Custom Images
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Image("example", {
imageName: "example",
roleArn: exampleAwsIamRole.arn,
});
const exampleAppImageConfig = new aws.sagemaker.AppImageConfig("example", {
kernelGatewayImageConfig: {
kernelSpecs: [{
name: "example",
}],
},
appImageConfigName: "example",
});
const exampleImageVersion = new aws.sagemaker.ImageVersion("example", {
imageName: example.id,
baseImage: "base-image",
});
const exampleDomain = new aws.sagemaker.Domain("example", {
defaultUserSettings: {
kernelGatewayAppSettings: {
customImages: [{
appImageConfigName: exampleAppImageConfig.appImageConfigName,
imageName: exampleImageVersion.imageName,
}],
},
executionRole: exampleAwsIamRole.arn,
},
domainName: "example",
authMode: "IAM",
vpcId: exampleAwsVpc.id,
subnetIds: [exampleAwsSubnet.id],
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Image("example",
image_name="example",
role_arn=example_aws_iam_role["arn"])
example_app_image_config = aws.sagemaker.AppImageConfig("example",
kernel_gateway_image_config={
"kernel_specs": [{
"name": "example",
}],
},
app_image_config_name="example")
example_image_version = aws.sagemaker.ImageVersion("example",
image_name=example.id,
base_image="base-image")
example_domain = aws.sagemaker.Domain("example",
default_user_settings={
"kernel_gateway_app_settings": {
"custom_images": [{
"app_image_config_name": example_app_image_config.app_image_config_name,
"image_name": example_image_version.image_name,
}],
},
"execution_role": example_aws_iam_role["arn"],
},
domain_name="example",
auth_mode="IAM",
vpc_id=example_aws_vpc["id"],
subnet_ids=[example_aws_subnet["id"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.Image("example", new()
{
ImageName = "example",
RoleArn = exampleAwsIamRole.Arn,
});
var exampleAppImageConfig = new Aws.Sagemaker.AppImageConfig("example", new()
{
KernelGatewayImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs
{
KernelSpecs = new[]
{
new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs
{
Name = "example",
},
},
},
AppImageConfigName = "example",
});
var exampleImageVersion = new Aws.Sagemaker.ImageVersion("example", new()
{
ImageName = example.Id,
BaseImage = "base-image",
});
var exampleDomain = new Aws.Sagemaker.Domain("example", new()
{
DefaultUserSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs
{
KernelGatewayAppSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs
{
CustomImages = new[]
{
new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs
{
AppImageConfigName = exampleAppImageConfig.AppImageConfigName,
ImageName = exampleImageVersion.ImageName,
},
},
},
ExecutionRole = exampleAwsIamRole.Arn,
},
DomainName = "example",
AuthMode = "IAM",
VpcId = exampleAwsVpc.Id,
SubnetIds = new[]
{
exampleAwsSubnet.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := sagemaker.NewImage(ctx, "example", &sagemaker.ImageArgs{
ImageName: pulumi.String("example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
})
if err != nil {
return err
}
exampleAppImageConfig, err := sagemaker.NewAppImageConfig(ctx, "example", &sagemaker.AppImageConfigArgs{
KernelGatewayImageConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigArgs{
KernelSpecs: sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArray{
&sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs{
Name: pulumi.String("example"),
},
},
},
AppImageConfigName: pulumi.String("example"),
})
if err != nil {
return err
}
exampleImageVersion, err := sagemaker.NewImageVersion(ctx, "example", &sagemaker.ImageVersionArgs{
ImageName: example.ID().ToIDOutput().ToStringOutput(),
BaseImage: pulumi.String("base-image"),
})
if err != nil {
return err
}
_, err = sagemaker.NewDomain(ctx, "example", &sagemaker.DomainArgs{
DefaultUserSettings: &sagemaker.DomainDefaultUserSettingsArgs{
KernelGatewayAppSettings: &sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs{
CustomImages: sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArray{
&sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs{
AppImageConfigName: exampleAppImageConfig.AppImageConfigName,
ImageName: exampleImageVersion.ImageName,
},
},
},
ExecutionRole: pulumi.Any(exampleAwsIamRole.Arn),
},
DomainName: pulumi.String("example"),
AuthMode: pulumi.String("IAM"),
VpcId: pulumi.Any(exampleAwsVpc.Id),
SubnetIds: pulumi.StringArray{
exampleAwsSubnet.Id,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_image" "example" {
image_name = "example"
role_arn = exampleAwsIamRole.arn
}
resource "aws_sagemaker_appimageconfig" "example" {
kernel_gateway_image_config = {
kernel_specs = [{
"name" = "example"
}]
}
app_image_config_name = "example"
}
resource "aws_sagemaker_imageversion" "example" {
image_name = aws_sagemaker_image.example.id
base_image = "base-image"
}
resource "aws_sagemaker_domain" "example" {
default_user_settings = {
kernel_gateway_app_settings = {
custom_images = [{
"appImageConfigName" = aws_sagemaker_appimageconfig.example.app_image_config_name
"imageName" = aws_sagemaker_imageversion.example.image_name
}]
}
execution_role = exampleAwsIamRole.arn
}
domain_name = "example"
auth_mode = "IAM"
vpc_id = exampleAwsVpc.id
subnet_ids = [exampleAwsSubnet.id]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Image;
import com.pulumi.aws.sagemaker.ImageArgs;
import com.pulumi.aws.sagemaker.AppImageConfig;
import com.pulumi.aws.sagemaker.AppImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigArgs;
import com.pulumi.aws.sagemaker.inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs;
import com.pulumi.aws.sagemaker.ImageVersion;
import com.pulumi.aws.sagemaker.ImageVersionArgs;
import com.pulumi.aws.sagemaker.Domain;
import com.pulumi.aws.sagemaker.DomainArgs;
import com.pulumi.aws.sagemaker.inputs.DomainDefaultUserSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs;
import com.pulumi.aws.sagemaker.inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Image("example", ImageArgs.builder()
.imageName("example")
.roleArn(exampleAwsIamRole.arn())
.build());
var exampleAppImageConfig = new AppImageConfig("exampleAppImageConfig", AppImageConfigArgs.builder()
.kernelGatewayImageConfig(AppImageConfigKernelGatewayImageConfigArgs.builder()
.kernelSpecs(AppImageConfigKernelGatewayImageConfigKernelSpecArgs.builder()
.name("example")
.build())
.build())
.appImageConfigName("example")
.build());
var exampleImageVersion = new ImageVersion("exampleImageVersion", ImageVersionArgs.builder()
.imageName(example.id())
.baseImage("base-image")
.build());
var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
.defaultUserSettings(DomainDefaultUserSettingsArgs.builder()
.kernelGatewayAppSettings(DomainDefaultUserSettingsKernelGatewayAppSettingsArgs.builder()
.customImages(DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs.builder()
.appImageConfigName(exampleAppImageConfig.appImageConfigName())
.imageName(exampleImageVersion.imageName())
.build())
.build())
.executionRole(exampleAwsIamRole.arn())
.build())
.domainName("example")
.authMode("IAM")
.vpcId(exampleAwsVpc.id())
.subnetIds(exampleAwsSubnet.id())
.build());
}
}
resources:
example:
type: aws:sagemaker:Image
properties:
imageName: example
roleArn: ${exampleAwsIamRole.arn}
exampleAppImageConfig:
type: aws:sagemaker:AppImageConfig
name: example
properties:
kernelGatewayImageConfig:
kernelSpecs:
- name: example
appImageConfigName: example
exampleImageVersion:
type: aws:sagemaker:ImageVersion
name: example
properties:
imageName: ${example.id}
baseImage: base-image
exampleDomain:
type: aws:sagemaker:Domain
name: example
properties:
defaultUserSettings:
kernelGatewayAppSettings:
customImages:
- appImageConfigName: ${exampleAppImageConfig.appImageConfigName}
imageName: ${exampleImageVersion.imageName}
executionRole: ${exampleAwsIamRole.arn}
domainName: example
authMode: IAM
vpcId: ${exampleAwsVpc.id}
subnetIds:
- ${exampleAwsSubnet.id}
Import
Using pulumi import, import SageMaker AI Domains using the id. For example:
$ pulumi import aws:sagemaker/domain:Domain test_domain d-8jgsjtilstu8
Constructors
- Domain(String name, {DomainArgs? args, CustomResourceOptions? options})
-
Creates a new Domain.
nameThe Pulumi resource name.argsArguments used to configure this Domain. The set of arguments for Domain.optionsResource options controlling this resource's behavior. - Domain.reference(String urn)
- Creates a typed reference to an existing Domain resource.
Properties
-
appNetworkAccessType
↔ Output<
String?> -
Specifies the VPC used for non-EFS traffic. The default value is
PublicInternetOnly. Valid values arePublicInternetOnlyandVpcOnly.latefinal -
appSecurityGroupManagement
↔ Output<
String?> -
The entity that creates and manages the required security groups for inter-app communication in
VPCOnlymode. Valid values areServiceandCustomer.latefinal -
arn
↔ Output<
String> -
ARN assigned by AWS to this Domain.
latefinal
-
authMode
↔ Output<
String> -
The mode of authentication that members use to access the domain. Valid values are
IAMandSSO.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
defaultSpaceSettings
↔ Output<
DomainDefaultSpaceSettings?> -
The default space settings. See
defaultSpaceSettingsBlock below.latefinal -
defaultUserSettings
↔ Output<
DomainDefaultUserSettings> -
The default user settings. See
defaultUserSettingsBlock below.latefinal -
domainName
↔ Output<
String> -
The domain name.
latefinal
-
domainSettings
↔ Output<
DomainDomainSettings?> -
The domain settings. See
domainSettingsBlock below.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
homeEfsFileSystemId
↔ Output<
String> -
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyId
↔ Output<
String?> -
The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
retentionPolicy
↔ Output<
DomainRetentionPolicy?> -
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See
retentionPolicyBlock below.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIdForDomainBoundary
↔ Output<
String> -
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
latefinal
-
singleSignOnApplicationArn
↔ Output<
String> -
The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after September 19, 2023.
latefinal
-
singleSignOnManagedApplicationInstanceId
↔ Output<
String> -
The SSO managed application instance ID.
latefinal
-
subnetIds
↔ Output<
List< String> > -
The VPC subnets that Studio uses for communication.
latefinal
-
tagPropagation
↔ Output<
String?> -
Indicates whether custom tag propagation is supported for the domain. Defaults to
DISABLED. Valid values are:ENABLEDandDISABLED.latefinal -
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
url
↔ Output<
String> -
The domain's URL.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String> -
ID of the VPC that Studio uses for communication.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited