class Aws::SageMaker::Types::CreateDomainRequest

@note When making an API call, you may pass CreateDomainRequest

data as a hash:

    {
      domain_name: "DomainName", # required
      auth_mode: "SSO", # required, accepts SSO, IAM
      default_user_settings: { # required
        execution_role: "RoleArn",
        security_groups: ["SecurityGroupId"],
        sharing_settings: {
          notebook_output_option: "Allowed", # accepts Allowed, Disabled
          s3_output_path: "S3Uri",
          s3_kms_key_id: "KmsKeyId",
        },
        jupyter_server_app_settings: {
          default_resource_spec: {
            sage_maker_image_arn: "ImageArn",
            sage_maker_image_version_arn: "ImageVersionArn",
            instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
            lifecycle_config_arn: "StudioLifecycleConfigArn",
          },
          lifecycle_config_arns: ["StudioLifecycleConfigArn"],
        },
        kernel_gateway_app_settings: {
          default_resource_spec: {
            sage_maker_image_arn: "ImageArn",
            sage_maker_image_version_arn: "ImageVersionArn",
            instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
            lifecycle_config_arn: "StudioLifecycleConfigArn",
          },
          custom_images: [
            {
              image_name: "ImageName", # required
              image_version_number: 1,
              app_image_config_name: "AppImageConfigName", # required
            },
          ],
          lifecycle_config_arns: ["StudioLifecycleConfigArn"],
        },
        tensor_board_app_settings: {
          default_resource_spec: {
            sage_maker_image_arn: "ImageArn",
            sage_maker_image_version_arn: "ImageVersionArn",
            instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
            lifecycle_config_arn: "StudioLifecycleConfigArn",
          },
        },
      },
      subnet_ids: ["SubnetId"], # required
      vpc_id: "VpcId", # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      app_network_access_type: "PublicInternetOnly", # accepts PublicInternetOnly, VpcOnly
      home_efs_file_system_kms_key_id: "KmsKeyId",
      kms_key_id: "KmsKeyId",
    }

@!attribute [rw] domain_name

A name for the domain.
@return [String]

@!attribute [rw] auth_mode

The mode of authentication that members use to access the domain.
@return [String]

@!attribute [rw] default_user_settings

The default settings to use to create a user profile when
`UserSettings` isn't specified in the call to the
`CreateUserProfile` API.

`SecurityGroups` is aggregated when specified in both calls. For all
other settings in `UserSettings`, the values specified in
`CreateUserProfile` take precedence over those specified in
`CreateDomain`.
@return [Types::UserSettings]

@!attribute [rw] subnet_ids

The VPC subnets that Studio uses for communication.
@return [Array<String>]

@!attribute [rw] vpc_id

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses
for communication.
@return [String]

@!attribute [rw] tags

Tags to associated with the Domain. Each tag consists of a key and
an optional value. Tag keys must be unique per resource. Tags are
searchable using the `Search` API.

Tags that you specify for the Domain are also added to all Apps that
the Domain launches.
@return [Array<Types::Tag>]

@!attribute [rw] app_network_access_type

Specifies the VPC used for non-EFS traffic. The default value is
`PublicInternetOnly`.

* `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by
  Amazon SageMaker, which allows direct internet access

* `VpcOnly` - All Studio traffic is through the specified VPC and
  subnets
@return [String]

@!attribute [rw] home_efs_file_system_kms_key_id

This member is deprecated and replaced with `KmsKeyId`.
@return [String]

@!attribute [rw] kms_key_id

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume
attached to the domain with an Amazon Web Services managed customer
master key (CMK) by default. For more control, specify a customer
managed CMK.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateDomainRequest AWS API Documentation

Constants

SENSITIVE