AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Domain

Provides a SageMaker Domain resource.

Example Usage

Basic usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleDomain = new Aws.Sagemaker.Domain("exampleDomain", new Aws.Sagemaker.DomainArgs
        {
            DomainName = "example",
            AuthMode = "IAM",
            VpcId = aws_vpc.Test.Id,
            SubnetIds = 
            {
                aws_subnet.Test.Id,
            },
            DefaultUserSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs
            {
                ExecutionRole = aws_iam_role.Test.Arn,
            },
        });
        var examplePolicyDocument = Output.Create(Aws.Iam.GetPolicyDocument.InvokeAsync(new Aws.Iam.GetPolicyDocumentArgs
        {
            Statements = 
            {
                new Aws.Iam.Inputs.GetPolicyDocumentStatementArgs
                {
                    Actions = 
                    {
                        "sts:AssumeRole",
                    },
                    Principals = 
                    {
                        new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalArgs
                        {
                            Type = "Service",
                            Identifiers = 
                            {
                                "sagemaker.amazonaws.com",
                            },
                        },
                    },
                },
            },
        }));
        var exampleRole = new Aws.Iam.Role("exampleRole", new Aws.Iam.RoleArgs
        {
            Path = "/",
            AssumeRolePolicy = examplePolicyDocument.Apply(examplePolicyDocument => examplePolicyDocument.Json),
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewDomain(ctx, "exampleDomain", &sagemaker.DomainArgs{
			DomainName: pulumi.String("example"),
			AuthMode:   pulumi.String("IAM"),
			VpcId:      pulumi.Any(aws_vpc.Test.Id),
			SubnetIds: pulumi.StringArray{
				pulumi.Any(aws_subnet.Test.Id),
			},
			DefaultUserSettings: &sagemaker.DomainDefaultUserSettingsArgs{
				ExecutionRole: pulumi.Any(aws_iam_role.Test.Arn),
			},
		})
		if err != nil {
			return err
		}
		examplePolicyDocument, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				iam.GetPolicyDocumentStatement{
					Actions: []string{
						"sts:AssumeRole",
					},
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						iam.GetPolicyDocumentStatementPrincipal{
							Type: "Service",
							Identifiers: []string{
								"sagemaker.amazonaws.com",
							},
						},
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = iam.NewRole(ctx, "exampleRole", &iam.RoleArgs{
			Path:             pulumi.String("/"),
			AssumeRolePolicy: pulumi.String(examplePolicyDocument.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()        
            .domainName("example")
            .authMode("IAM")
            .vpcId(aws_vpc.test().id())
            .subnetIds(aws_subnet.test().id())
            .defaultUserSettings(DomainDefaultUserSettingsArgs.builder()
                .executionRole(aws_iam_role.test().arn())
                .build())
            .build());

        final var examplePolicyDocument = Output.of(IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .actions("sts:AssumeRole")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("Service")
                    .identifiers("sagemaker.amazonaws.com")
                    .build())
                .build())
            .build()));

        var exampleRole = new Role("exampleRole", RoleArgs.builder()        
            .path("/")
            .assumeRolePolicy(examplePolicyDocument.apply(getPolicyDocumentResult -> getPolicyDocumentResult.json()))
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example_domain = aws.sagemaker.Domain("exampleDomain",
    domain_name="example",
    auth_mode="IAM",
    vpc_id=aws_vpc["test"]["id"],
    subnet_ids=[aws_subnet["test"]["id"]],
    default_user_settings=aws.sagemaker.DomainDefaultUserSettingsArgs(
        execution_role=aws_iam_role["test"]["arn"],
    ))
example_policy_document = aws.iam.get_policy_document(statements=[aws.iam.GetPolicyDocumentStatementArgs(
    actions=["sts:AssumeRole"],
    principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
        type="Service",
        identifiers=["sagemaker.amazonaws.com"],
    )],
)])
example_role = aws.iam.Role("exampleRole",
    path="/",
    assume_role_policy=example_policy_document.json)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleDomain = new aws.sagemaker.Domain("exampleDomain", {
    domainName: "example",
    authMode: "IAM",
    vpcId: aws_vpc.test.id,
    subnetIds: [aws_subnet.test.id],
    defaultUserSettings: {
        executionRole: aws_iam_role.test.arn,
    },
});
const examplePolicyDocument = aws.iam.getPolicyDocument({
    statements: [{
        actions: ["sts:AssumeRole"],
        principals: [{
            type: "Service",
            identifiers: ["sagemaker.amazonaws.com"],
        }],
    }],
});
const exampleRole = new aws.iam.Role("exampleRole", {
    path: "/",
    assumeRolePolicy: examplePolicyDocument.then(examplePolicyDocument => examplePolicyDocument.json),
});
resources:
  exampleDomain:
    type: aws:sagemaker:Domain
    properties:
      domainName: example
      authMode: IAM
      vpcId: ${aws_vpc.test.id}
      subnetIds:
        - ${aws_subnet.test.id}
      defaultUserSettings:
        executionRole: ${aws_iam_role.test.arn}
  exampleRole:
    type: aws:iam:Role
    properties:
      path: /
      assumeRolePolicy: ${examplePolicyDocument.json}
variables:
  examplePolicyDocument:
    Fn::Invoke:
      Function: aws:iam:getPolicyDocument
      Arguments:
        statements:
          - actions:
              - sts:AssumeRole
            principals:
              - type: Service
                identifiers:
                  - sagemaker.amazonaws.com

Using Custom Images

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var testImage = new Aws.Sagemaker.Image("testImage", new Aws.Sagemaker.ImageArgs
        {
            ImageName = "example",
            RoleArn = aws_iam_role.Test.Arn,
        });
        var testAppImageConfig = new Aws.Sagemaker.AppImageConfig("testAppImageConfig", new Aws.Sagemaker.AppImageConfigArgs
        {
            AppImageConfigName = "example",
            KernelGatewayImageConfig = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigArgs
            {
                KernelSpec = new Aws.Sagemaker.Inputs.AppImageConfigKernelGatewayImageConfigKernelSpecArgs
                {
                    Name = "example",
                },
            },
        });
        var testImageVersion = new Aws.Sagemaker.ImageVersion("testImageVersion", new Aws.Sagemaker.ImageVersionArgs
        {
            ImageName = testImage.Id,
            BaseImage = "base-image",
        });
        var testDomain = new Aws.Sagemaker.Domain("testDomain", new Aws.Sagemaker.DomainArgs
        {
            DomainName = "example",
            AuthMode = "IAM",
            VpcId = aws_vpc.Test.Id,
            SubnetIds = 
            {
                aws_subnet.Test.Id,
            },
            DefaultUserSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs
            {
                ExecutionRole = aws_iam_role.Test.Arn,
                KernelGatewayAppSettings = new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs
                {
                    CustomImages = 
                    {
                        new Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs
                        {
                            AppImageConfigName = testAppImageConfig.AppImageConfigName,
                            ImageName = testImageVersion.ImageName,
                        },
                    },
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testImage, err := sagemaker.NewImage(ctx, "testImage", &sagemaker.ImageArgs{
			ImageName: pulumi.String("example"),
			RoleArn:   pulumi.Any(aws_iam_role.Test.Arn),
		})
		if err != nil {
			return err
		}
		testAppImageConfig, err := sagemaker.NewAppImageConfig(ctx, "testAppImageConfig", &sagemaker.AppImageConfigArgs{
			AppImageConfigName: pulumi.String("example"),
			KernelGatewayImageConfig: &sagemaker.AppImageConfigKernelGatewayImageConfigArgs{
				KernelSpec: &sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs{
					Name: pulumi.String("example"),
				},
			},
		})
		if err != nil {
			return err
		}
		testImageVersion, err := sagemaker.NewImageVersion(ctx, "testImageVersion", &sagemaker.ImageVersionArgs{
			ImageName: testImage.ID(),
			BaseImage: pulumi.String("base-image"),
		})
		if err != nil {
			return err
		}
		_, err = sagemaker.NewDomain(ctx, "testDomain", &sagemaker.DomainArgs{
			DomainName: pulumi.String("example"),
			AuthMode:   pulumi.String("IAM"),
			VpcId:      pulumi.Any(aws_vpc.Test.Id),
			SubnetIds: pulumi.StringArray{
				pulumi.Any(aws_subnet.Test.Id),
			},
			DefaultUserSettings: &sagemaker.DomainDefaultUserSettingsArgs{
				ExecutionRole: pulumi.Any(aws_iam_role.Test.Arn),
				KernelGatewayAppSettings: &sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs{
					CustomImages: sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArray{
						&sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs{
							AppImageConfigName: testAppImageConfig.AppImageConfigName,
							ImageName:          testImageVersion.ImageName,
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testImage = new Image("testImage", ImageArgs.builder()        
            .imageName("example")
            .roleArn(aws_iam_role.test().arn())
            .build());

        var testAppImageConfig = new AppImageConfig("testAppImageConfig", AppImageConfigArgs.builder()        
            .appImageConfigName("example")
            .kernelGatewayImageConfig(AppImageConfigKernelGatewayImageConfigArgs.builder()
                .kernelSpec(AppImageConfigKernelGatewayImageConfigKernelSpecArgs.builder()
                    .name("example")
                    .build())
                .build())
            .build());

        var testImageVersion = new ImageVersion("testImageVersion", ImageVersionArgs.builder()        
            .imageName(testImage.id())
            .baseImage("base-image")
            .build());

        var testDomain = new Domain("testDomain", DomainArgs.builder()        
            .domainName("example")
            .authMode("IAM")
            .vpcId(aws_vpc.test().id())
            .subnetIds(aws_subnet.test().id())
            .defaultUserSettings(DomainDefaultUserSettingsArgs.builder()
                .executionRole(aws_iam_role.test().arn())
                .kernelGatewayAppSettings(DomainDefaultUserSettingsKernelGatewayAppSettingsArgs.builder()
                    .customImages(DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs.builder()
                        .appImageConfigName(testAppImageConfig.appImageConfigName())
                        .imageName(testImageVersion.imageName())
                        .build())
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

test_image = aws.sagemaker.Image("testImage",
    image_name="example",
    role_arn=aws_iam_role["test"]["arn"])
test_app_image_config = aws.sagemaker.AppImageConfig("testAppImageConfig",
    app_image_config_name="example",
    kernel_gateway_image_config=aws.sagemaker.AppImageConfigKernelGatewayImageConfigArgs(
        kernel_spec=aws.sagemaker.AppImageConfigKernelGatewayImageConfigKernelSpecArgs(
            name="example",
        ),
    ))
test_image_version = aws.sagemaker.ImageVersion("testImageVersion",
    image_name=test_image.id,
    base_image="base-image")
test_domain = aws.sagemaker.Domain("testDomain",
    domain_name="example",
    auth_mode="IAM",
    vpc_id=aws_vpc["test"]["id"],
    subnet_ids=[aws_subnet["test"]["id"]],
    default_user_settings=aws.sagemaker.DomainDefaultUserSettingsArgs(
        execution_role=aws_iam_role["test"]["arn"],
        kernel_gateway_app_settings=aws.sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsArgs(
            custom_images=[aws.sagemaker.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImageArgs(
                app_image_config_name=test_app_image_config.app_image_config_name,
                image_name=test_image_version.image_name,
            )],
        ),
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testImage = new aws.sagemaker.Image("testImage", {
    imageName: "example",
    roleArn: aws_iam_role.test.arn,
});
const testAppImageConfig = new aws.sagemaker.AppImageConfig("testAppImageConfig", {
    appImageConfigName: "example",
    kernelGatewayImageConfig: {
        kernelSpec: {
            name: "example",
        },
    },
});
const testImageVersion = new aws.sagemaker.ImageVersion("testImageVersion", {
    imageName: testImage.id,
    baseImage: "base-image",
});
const testDomain = new aws.sagemaker.Domain("testDomain", {
    domainName: "example",
    authMode: "IAM",
    vpcId: aws_vpc.test.id,
    subnetIds: [aws_subnet.test.id],
    defaultUserSettings: {
        executionRole: aws_iam_role.test.arn,
        kernelGatewayAppSettings: {
            customImages: [{
                appImageConfigName: testAppImageConfig.appImageConfigName,
                imageName: testImageVersion.imageName,
            }],
        },
    },
});
resources:
  testImage:
    type: aws:sagemaker:Image
    properties:
      imageName: example
      roleArn: ${aws_iam_role.test.arn}
  testAppImageConfig:
    type: aws:sagemaker:AppImageConfig
    properties:
      appImageConfigName: example
      kernelGatewayImageConfig:
        kernelSpec:
          name: example
  testImageVersion:
    type: aws:sagemaker:ImageVersion
    properties:
      imageName: ${testImage.id}
      baseImage: base-image
  testDomain:
    type: aws:sagemaker:Domain
    properties:
      domainName: example
      authMode: IAM
      vpcId: ${aws_vpc.test.id}
      subnetIds:
        - ${aws_subnet.test.id}
      defaultUserSettings:
        executionRole: ${aws_iam_role.test.arn}
        kernelGatewayAppSettings:
          customImages:
            - appImageConfigName: ${testAppImageConfig.appImageConfigName}
              imageName: ${testImageVersion.imageName}

Create a Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           app_network_access_type: Optional[str] = None,
           auth_mode: Optional[str] = None,
           default_user_settings: Optional[DomainDefaultUserSettingsArgs] = None,
           domain_name: Optional[str] = None,
           kms_key_id: Optional[str] = None,
           retention_policy: Optional[DomainRetentionPolicyArgs] = None,
           subnet_ids: Optional[Sequence[str]] = None,
           tags: Optional[Mapping[str, str]] = None,
           vpc_id: Optional[str] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)
func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: aws:sagemaker:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DomainArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Domain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Domain resource accepts the following input properties:

AuthMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

DefaultUserSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

DomainName string

The domain name.

SubnetIds List<string>

The VPC subnets that Studio uses for communication.

VpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

AppNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

KmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

RetentionPolicy Pulumi.Aws.Sagemaker.Inputs.DomainRetentionPolicyArgs

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 Retention Policy below.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

AuthMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

DefaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

DomainName string

The domain name.

SubnetIds []string

The VPC subnets that Studio uses for communication.

VpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

AppNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

KmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

RetentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

authMode String

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domainName String

The domain name.

subnetIds List<String>

The VPC subnets that Studio uses for communication.

vpcId String

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType String

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

kmsKeyId String

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

authMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domainName string

The domain name.

subnetIds string[]

The VPC subnets that Studio uses for communication.

vpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

kmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

auth_mode str

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

default_user_settings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domain_name str

The domain name.

subnet_ids Sequence[str]

The VPC subnets that Studio uses for communication.

vpc_id str

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

app_network_access_type str

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

kms_key_id str

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retention_policy DomainRetentionPolicyArgs

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 Retention Policy below.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

authMode String

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings Property Map

The default user settings. See Default User Settings below.

domainName String

The domain name.

subnetIds List<String>

The VPC subnets that Studio uses for communication.

vpcId String

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType String

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

kmsKeyId String

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy Property Map

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 Retention Policy below.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

Arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

HomeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

Id string

The provider-assigned unique ID for this managed resource.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Url string

The domain's URL.

Arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

HomeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

Id string

The provider-assigned unique ID for this managed resource.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

Url string

The domain's URL.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

homeEfsFileSystemId String

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

id String

The provider-assigned unique ID for this managed resource.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

url String

The domain's URL.

arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

homeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

id string

The provider-assigned unique ID for this managed resource.

singleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

url string

The domain's URL.

arn str

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

home_efs_file_system_id str

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

id str

The provider-assigned unique ID for this managed resource.

single_sign_on_managed_application_instance_id str

The SSO managed application instance ID.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

url str

The domain's URL.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

homeEfsFileSystemId String

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

id String

The provider-assigned unique ID for this managed resource.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

url String

The domain's URL.

Look up an Existing Domain Resource

Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_network_access_type: Optional[str] = None,
        arn: Optional[str] = None,
        auth_mode: Optional[str] = None,
        default_user_settings: Optional[DomainDefaultUserSettingsArgs] = None,
        domain_name: Optional[str] = None,
        home_efs_file_system_id: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        retention_policy: Optional[DomainRetentionPolicyArgs] = None,
        single_sign_on_managed_application_instance_id: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        url: Optional[str] = None,
        vpc_id: Optional[str] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

Arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

AuthMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

DefaultUserSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

DomainName string

The domain name.

HomeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

KmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

RetentionPolicy Pulumi.Aws.Sagemaker.Inputs.DomainRetentionPolicyArgs

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 Retention Policy below.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

SubnetIds List<string>

The VPC subnets that Studio uses for communication.

Tags Dictionary<string, string>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Url string

The domain's URL.

VpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

AppNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

Arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

AuthMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

DefaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

DomainName string

The domain name.

HomeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

KmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

RetentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

SubnetIds []string

The VPC subnets that Studio uses for communication.

Tags map[string]string

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

Url string

The domain's URL.

VpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType String

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

authMode String

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domainName String

The domain name.

homeEfsFileSystemId String

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

kmsKeyId String

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

subnetIds List<String>

The VPC subnets that Studio uses for communication.

tags Map<String,String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

url String

The domain's URL.

vpcId String

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType string

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

arn string

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

authMode string

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domainName string

The domain name.

homeEfsFileSystemId string

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

kmsKeyId string

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy DomainRetentionPolicyArgs

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 Retention Policy below.

singleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

subnetIds string[]

The VPC subnets that Studio uses for communication.

tags {[key: string]: string}

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

url string

The domain's URL.

vpcId string

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

app_network_access_type str

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

arn str

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

auth_mode str

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

default_user_settings DomainDefaultUserSettingsArgs

The default user settings. See Default User Settings below.

domain_name str

The domain name.

home_efs_file_system_id str

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

kms_key_id str

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retention_policy DomainRetentionPolicyArgs

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 Retention Policy below.

single_sign_on_managed_application_instance_id str

The SSO managed application instance ID.

subnet_ids Sequence[str]

The VPC subnets that Studio uses for communication.

tags Mapping[str, str]

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

url str

The domain's URL.

vpc_id str

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

appNetworkAccessType String

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.

arn String

The Amazon Resource Name (ARN) assigned by AWS to this Domain.

authMode String

The mode of authentication that members use to access the domain. Valid values are IAM and SSO.

defaultUserSettings Property Map

The default user settings. See Default User Settings below.

domainName String

The domain name.

homeEfsFileSystemId String

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

kmsKeyId String

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

retentionPolicy Property Map

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 Retention Policy below.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

subnetIds List<String>

The VPC subnets that Studio uses for communication.

tags Map<String>

A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

url String

The domain's URL.

vpcId String

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Supporting Types

DomainDefaultUserSettings

ExecutionRole string

The execution role ARN for the user.

JupyterServerAppSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsJupyterServerAppSettings

The Jupyter server's app settings. See Jupyter Server App Settings below.

KernelGatewayAppSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettings

The kernel gateway app settings. See Kernel Gateway App Settings below.

SecurityGroups List<string>

The security groups.

SharingSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsSharingSettings

The sharing settings. See Sharing Settings below.

TensorBoardAppSettings Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsTensorBoardAppSettings

The TensorBoard app settings. See TensorBoard App Settings below.

ExecutionRole string

The execution role ARN for the user.

JupyterServerAppSettings DomainDefaultUserSettingsJupyterServerAppSettings

The Jupyter server's app settings. See Jupyter Server App Settings below.

KernelGatewayAppSettings DomainDefaultUserSettingsKernelGatewayAppSettings

The kernel gateway app settings. See Kernel Gateway App Settings below.

SecurityGroups []string

The security groups.

SharingSettings DomainDefaultUserSettingsSharingSettings

The sharing settings. See Sharing Settings below.

TensorBoardAppSettings DomainDefaultUserSettingsTensorBoardAppSettings

The TensorBoard app settings. See TensorBoard App Settings below.

executionRole String

The execution role ARN for the user.

jupyterServerAppSettings DomainDefaultUserSettingsJupyterServerAppSettings

The Jupyter server's app settings. See Jupyter Server App Settings below.

kernelGatewayAppSettings DomainDefaultUserSettingsKernelGatewayAppSettings

The kernel gateway app settings. See Kernel Gateway App Settings below.

securityGroups List<String>

The security groups.

sharingSettings DomainDefaultUserSettingsSharingSettings

The sharing settings. See Sharing Settings below.

tensorBoardAppSettings DomainDefaultUserSettingsTensorBoardAppSettings

The TensorBoard app settings. See TensorBoard App Settings below.

executionRole string

The execution role ARN for the user.

jupyterServerAppSettings DomainDefaultUserSettingsJupyterServerAppSettings

The Jupyter server's app settings. See Jupyter Server App Settings below.

kernelGatewayAppSettings DomainDefaultUserSettingsKernelGatewayAppSettings

The kernel gateway app settings. See Kernel Gateway App Settings below.

securityGroups string[]

The security groups.

sharingSettings DomainDefaultUserSettingsSharingSettings

The sharing settings. See Sharing Settings below.

tensorBoardAppSettings DomainDefaultUserSettingsTensorBoardAppSettings

The TensorBoard app settings. See TensorBoard App Settings below.

execution_role str

The execution role ARN for the user.

jupyter_server_app_settings DomainDefaultUserSettingsJupyterServerAppSettings

The Jupyter server's app settings. See Jupyter Server App Settings below.

kernel_gateway_app_settings DomainDefaultUserSettingsKernelGatewayAppSettings

The kernel gateway app settings. See Kernel Gateway App Settings below.

security_groups Sequence[str]

The security groups.

sharing_settings DomainDefaultUserSettingsSharingSettings

The sharing settings. See Sharing Settings below.

tensor_board_app_settings DomainDefaultUserSettingsTensorBoardAppSettings

The TensorBoard app settings. See TensorBoard App Settings below.

executionRole String

The execution role ARN for the user.

jupyterServerAppSettings Property Map

The Jupyter server's app settings. See Jupyter Server App Settings below.

kernelGatewayAppSettings Property Map

The kernel gateway app settings. See Kernel Gateway App Settings below.

securityGroups List<String>

The security groups.

sharingSettings Property Map

The sharing settings. See Sharing Settings below.

tensorBoardAppSettings Property Map

The TensorBoard app settings. See TensorBoard App Settings below.

DomainDefaultUserSettingsJupyterServerAppSettings

DefaultResourceSpec Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

LifecycleConfigArns List<string>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

DefaultResourceSpec DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

LifecycleConfigArns []string

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

defaultResourceSpec DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns List<String>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

defaultResourceSpec DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns string[]

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

default_resource_spec DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycle_config_arns Sequence[str]

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

defaultResourceSpec Property Map

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns List<String>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

DomainDefaultUserSettingsJupyterServerAppSettingsDefaultResourceSpec

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

instanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn string

The ARN of the image version created on the instance.

instance_type str

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycle_config_arn str

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemaker_image_arn str

The ARN of the SageMaker image that the image version belongs to.

sagemaker_image_version_arn str

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

DomainDefaultUserSettingsKernelGatewayAppSettings

CustomImages List<Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage>

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

DefaultResourceSpec Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

LifecycleConfigArns List<string>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

CustomImages []DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

DefaultResourceSpec DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

LifecycleConfigArns []string

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

customImages List<DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage>

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

defaultResourceSpec DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns List<String>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

customImages DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage[]

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

defaultResourceSpec DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns string[]

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

custom_images Sequence[DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage]

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

default_resource_spec DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycle_config_arns Sequence[str]

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

customImages List<Property Map>

A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.

defaultResourceSpec Property Map

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

lifecycleConfigArns List<String>

The Amazon Resource Name (ARN) of the Lifecycle Configurations.

DomainDefaultUserSettingsKernelGatewayAppSettingsCustomImage

AppImageConfigName string

The name of the App Image Config.

ImageName string

The name of the Custom Image.

ImageVersionNumber int

The version number of the Custom Image.

AppImageConfigName string

The name of the App Image Config.

ImageName string

The name of the Custom Image.

ImageVersionNumber int

The version number of the Custom Image.

appImageConfigName String

The name of the App Image Config.

imageName String

The name of the Custom Image.

imageVersionNumber Integer

The version number of the Custom Image.

appImageConfigName string

The name of the App Image Config.

imageName string

The name of the Custom Image.

imageVersionNumber number

The version number of the Custom Image.

app_image_config_name str

The name of the App Image Config.

image_name str

The name of the Custom Image.

image_version_number int

The version number of the Custom Image.

appImageConfigName String

The name of the App Image Config.

imageName String

The name of the Custom Image.

imageVersionNumber Number

The version number of the Custom Image.

DomainDefaultUserSettingsKernelGatewayAppSettingsDefaultResourceSpec

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

instanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn string

The ARN of the image version created on the instance.

instance_type str

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycle_config_arn str

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemaker_image_arn str

The ARN of the SageMaker image that the image version belongs to.

sagemaker_image_version_arn str

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

DomainDefaultUserSettingsSharingSettings

NotebookOutputOption string

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

S3KmsKeyId string

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

S3OutputPath string

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

NotebookOutputOption string

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

S3KmsKeyId string

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

S3OutputPath string

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

notebookOutputOption String

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

s3KmsKeyId String

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

s3OutputPath String

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

notebookOutputOption string

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

s3KmsKeyId string

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

s3OutputPath string

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

notebook_output_option str

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

s3_kms_key_id str

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

s3_output_path str

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

notebookOutputOption String

Whether to include the notebook cell output when sharing the notebook. The default is Disabled. Valid values are Allowed and Disabled.

s3KmsKeyId String

When notebook_output_option is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

s3OutputPath String

When notebook_output_option is Allowed, the Amazon S3 bucket used to save the notebook cell output.

DomainDefaultUserSettingsTensorBoardAppSettings

DefaultResourceSpec Pulumi.Aws.Sagemaker.Inputs.DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

DefaultResourceSpec DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

defaultResourceSpec DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

defaultResourceSpec DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

default_resource_spec DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

defaultResourceSpec Property Map

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.

DomainDefaultUserSettingsTensorBoardAppSettingsDefaultResourceSpec

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

InstanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

LifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

SagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

SagemakerImageVersionArn string

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

instanceType string

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn string

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn string

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn string

The ARN of the image version created on the instance.

instance_type str

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycle_config_arn str

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemaker_image_arn str

The ARN of the SageMaker image that the image version belongs to.

sagemaker_image_version_arn str

The ARN of the image version created on the instance.

instanceType String

The instance type that the image version runs on.. For valid values see SageMaker Instance Types.

lifecycleConfigArn String

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

sagemakerImageArn String

The ARN of the SageMaker image that the image version belongs to.

sagemakerImageVersionArn String

The ARN of the image version created on the instance.

DomainRetentionPolicy

HomeEfsFileSystem string

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

HomeEfsFileSystem string

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

homeEfsFileSystem String

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

homeEfsFileSystem string

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

home_efs_file_system str

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

homeEfsFileSystem String

The retention policy for data stored on an Amazon Elastic File System (EFS) volume. Valid values are Retain or Delete. Default value is Retain.

Import

SageMaker Code Domains can be imported using the id, e.g.,

 $ pulumi import aws:sagemaker/domain:Domain test_domain d-8jgsjtilstu8

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.