AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getDomain

Resource Type definition for AWS::SageMaker::Domain

Using getDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
def get_domain(domain_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

> Note: This function is named LookupDomain in the Go SDK.

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:sagemaker:getDomain
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DomainId string

The domain name.

DomainId string

The domain name.

domainId String

The domain name.

domainId string

The domain name.

domain_id str

The domain name.

domainId String

The domain name.

getDomain Result

The following output properties are available:

DefaultUserSettings Pulumi.AwsNative.SageMaker.Outputs.DomainUserSettings

The default user settings.

DomainArn string

The Amazon Resource Name (ARN) of the created domain.

DomainId string

The domain name.

DomainSettings Pulumi.AwsNative.SageMaker.Outputs.DomainSettings
HomeEfsFileSystemId string

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

SecurityGroupIdForDomainBoundary string

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

Url string

The URL to the created domain.

DefaultUserSettings DomainUserSettings

The default user settings.

DomainArn string

The Amazon Resource Name (ARN) of the created domain.

DomainId string

The domain name.

DomainSettings DomainSettings
HomeEfsFileSystemId string

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

SecurityGroupIdForDomainBoundary string

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

SingleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

Url string

The URL to the created domain.

defaultUserSettings DomainUserSettings

The default user settings.

domainArn String

The Amazon Resource Name (ARN) of the created domain.

domainId String

The domain name.

domainSettings DomainSettings
homeEfsFileSystemId String

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

securityGroupIdForDomainBoundary String

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

url String

The URL to the created domain.

defaultUserSettings DomainUserSettings

The default user settings.

domainArn string

The Amazon Resource Name (ARN) of the created domain.

domainId string

The domain name.

domainSettings DomainSettings
homeEfsFileSystemId string

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

securityGroupIdForDomainBoundary string

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

singleSignOnManagedApplicationInstanceId string

The SSO managed application instance ID.

url string

The URL to the created domain.

default_user_settings DomainUserSettings

The default user settings.

domain_arn str

The Amazon Resource Name (ARN) of the created domain.

domain_id str

The domain name.

domain_settings DomainSettings
home_efs_file_system_id str

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

security_group_id_for_domain_boundary str

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

single_sign_on_managed_application_instance_id str

The SSO managed application instance ID.

url str

The URL to the created domain.

defaultUserSettings Property Map

The default user settings.

domainArn String

The Amazon Resource Name (ARN) of the created domain.

domainId String

The domain name.

domainSettings Property Map
homeEfsFileSystemId String

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

securityGroupIdForDomainBoundary String

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

singleSignOnManagedApplicationInstanceId String

The SSO managed application instance ID.

url String

The URL to the created domain.

Supporting Types

DomainCustomImage

AppImageConfigName string

The Name of the AppImageConfig.

ImageName string

The name of the CustomImage. Must be unique to your account.

ImageVersionNumber int

The version number of the CustomImage.

AppImageConfigName string

The Name of the AppImageConfig.

ImageName string

The name of the CustomImage. Must be unique to your account.

ImageVersionNumber int

The version number of the CustomImage.

appImageConfigName String

The Name of the AppImageConfig.

imageName String

The name of the CustomImage. Must be unique to your account.

imageVersionNumber Integer

The version number of the CustomImage.

appImageConfigName string

The Name of the AppImageConfig.

imageName string

The name of the CustomImage. Must be unique to your account.

imageVersionNumber number

The version number of the CustomImage.

app_image_config_name str

The Name of the AppImageConfig.

image_name str

The name of the CustomImage. Must be unique to your account.

image_version_number int

The version number of the CustomImage.

appImageConfigName String

The Name of the AppImageConfig.

imageName String

The name of the CustomImage. Must be unique to your account.

imageVersionNumber Number

The version number of the CustomImage.

DomainJupyterServerAppSettings

DomainKernelGatewayAppSettings

CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomImage>

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

DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

CustomImages []DomainCustomImage

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

DefaultResourceSpec DomainResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

customImages List<DomainCustomImage>

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

defaultResourceSpec DomainResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

customImages DomainCustomImage[]

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

defaultResourceSpec DomainResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

custom_images Sequence[DomainCustomImage]

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

default_resource_spec DomainResourceSpec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

customImages List<Property Map>

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

defaultResourceSpec Property Map

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

DomainRSessionAppSettings

CustomImages []DomainCustomImage

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

DefaultResourceSpec DomainResourceSpec
customImages List<DomainCustomImage>

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

defaultResourceSpec DomainResourceSpec
customImages DomainCustomImage[]

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

defaultResourceSpec DomainResourceSpec
custom_images Sequence[DomainCustomImage]

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

default_resource_spec DomainResourceSpec
customImages List<Property Map>

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

defaultResourceSpec Property Map

DomainRStudioServerProAppSettings

AccessStatus Pulumi.AwsNative.SageMaker.DomainRStudioServerProAppSettingsAccessStatus

Indicates whether the current user has access to the RStudioServerPro app.

UserGroup Pulumi.AwsNative.SageMaker.DomainRStudioServerProAppSettingsUserGroup

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

AccessStatus DomainRStudioServerProAppSettingsAccessStatus

Indicates whether the current user has access to the RStudioServerPro app.

UserGroup DomainRStudioServerProAppSettingsUserGroup

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

accessStatus DomainRStudioServerProAppSettingsAccessStatus

Indicates whether the current user has access to the RStudioServerPro app.

userGroup DomainRStudioServerProAppSettingsUserGroup

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

accessStatus DomainRStudioServerProAppSettingsAccessStatus

Indicates whether the current user has access to the RStudioServerPro app.

userGroup DomainRStudioServerProAppSettingsUserGroup

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

access_status DomainRStudioServerProAppSettingsAccessStatus

Indicates whether the current user has access to the RStudioServerPro app.

user_group DomainRStudioServerProAppSettingsUserGroup

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

accessStatus "ENABLED" | "DISABLED"

Indicates whether the current user has access to the RStudioServerPro app.

userGroup "R_STUDIO_ADMIN" | "R_STUDIO_USER"

The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

DomainRStudioServerProAppSettingsAccessStatus

DomainRStudioServerProAppSettingsUserGroup

DomainRStudioServerProDomainSettings

DomainExecutionRoleArn string

The ARN of the execution role for the RStudioServerPro Domain-level app.

DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
RStudioConnectUrl string

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl string

A URL pointing to an RStudio Package Manager server.

DomainExecutionRoleArn string

The ARN of the execution role for the RStudioServerPro Domain-level app.

DefaultResourceSpec DomainResourceSpec
RStudioConnectUrl string

A URL pointing to an RStudio Connect server.

RStudioPackageManagerUrl string

A URL pointing to an RStudio Package Manager server.

domainExecutionRoleArn String

The ARN of the execution role for the RStudioServerPro Domain-level app.

defaultResourceSpec DomainResourceSpec
rStudioConnectUrl String

A URL pointing to an RStudio Connect server.

rStudioPackageManagerUrl String

A URL pointing to an RStudio Package Manager server.

domainExecutionRoleArn string

The ARN of the execution role for the RStudioServerPro Domain-level app.

defaultResourceSpec DomainResourceSpec
rStudioConnectUrl string

A URL pointing to an RStudio Connect server.

rStudioPackageManagerUrl string

A URL pointing to an RStudio Package Manager server.

domain_execution_role_arn str

The ARN of the execution role for the RStudioServerPro Domain-level app.

default_resource_spec DomainResourceSpec
r_studio_connect_url str

A URL pointing to an RStudio Connect server.

r_studio_package_manager_url str

A URL pointing to an RStudio Package Manager server.

domainExecutionRoleArn String

The ARN of the execution role for the RStudioServerPro Domain-level app.

defaultResourceSpec Property Map
rStudioConnectUrl String

A URL pointing to an RStudio Connect server.

rStudioPackageManagerUrl String

A URL pointing to an RStudio Package Manager server.

DomainResourceSpec

InstanceType Pulumi.AwsNative.SageMaker.DomainResourceSpecInstanceType

The instance type that the image version runs on.

LifecycleConfigArn string

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

SageMakerImageArn string

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string

The Amazon Resource Name (ARN) of the image version created on the instance.

InstanceType DomainResourceSpecInstanceType

The instance type that the image version runs on.

LifecycleConfigArn string

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

SageMakerImageArn string

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

SageMakerImageVersionArn string

The Amazon Resource Name (ARN) of the image version created on the instance.

instanceType DomainResourceSpecInstanceType

The instance type that the image version runs on.

lifecycleConfigArn String

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

sageMakerImageArn String

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

sageMakerImageVersionArn String

The Amazon Resource Name (ARN) of the image version created on the instance.

instanceType DomainResourceSpecInstanceType

The instance type that the image version runs on.

lifecycleConfigArn string

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

sageMakerImageArn string

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

sageMakerImageVersionArn string

The Amazon Resource Name (ARN) of the image version created on the instance.

instance_type DomainResourceSpecInstanceType

The instance type that the image version runs on.

lifecycle_config_arn str

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

sage_maker_image_arn str

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

sage_maker_image_version_arn str

The Amazon Resource Name (ARN) of the image version created on the instance.

instanceType "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.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.g4dn.xlarge" | "ml.g4dn.2xlarge" | "ml.g4dn.4xlarge" | "ml.g4dn.8xlarge" | "ml.g4dn.12xlarge" | "ml.g4dn.16xlarge"

The instance type that the image version runs on.

lifecycleConfigArn String

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

sageMakerImageArn String

The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.

sageMakerImageVersionArn String

The Amazon Resource Name (ARN) of the image version created on the instance.

DomainResourceSpecInstanceType

DomainSettings

RStudioServerProDomainSettings Pulumi.AwsNative.SageMaker.Inputs.DomainRStudioServerProDomainSettings
SecurityGroupIds List<string>

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

RStudioServerProDomainSettings DomainRStudioServerProDomainSettings
SecurityGroupIds []string

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

rStudioServerProDomainSettings DomainRStudioServerProDomainSettings
securityGroupIds List<String>

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

rStudioServerProDomainSettings DomainRStudioServerProDomainSettings
securityGroupIds string[]

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

r_studio_server_pro_domain_settings DomainRStudioServerProDomainSettings
security_group_ids Sequence[str]

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

rStudioServerProDomainSettings Property Map
securityGroupIds List<String>

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

DomainSharingSettings

NotebookOutputOption Pulumi.AwsNative.SageMaker.DomainSharingSettingsNotebookOutputOption

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

S3KmsKeyId string

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

NotebookOutputOption DomainSharingSettingsNotebookOutputOption

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

S3KmsKeyId string

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

notebookOutputOption DomainSharingSettingsNotebookOutputOption

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

s3KmsKeyId String

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

notebookOutputOption DomainSharingSettingsNotebookOutputOption

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

s3KmsKeyId string

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

notebook_output_option DomainSharingSettingsNotebookOutputOption

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

s3_kms_key_id str

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

notebookOutputOption "Allowed" | "Disabled"

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

s3KmsKeyId String

When NotebookOutputOption 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 NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

DomainSharingSettingsNotebookOutputOption

DomainUserSettings

ExecutionRole string

The user profile Amazon Resource Name (ARN).

JupyterServerAppSettings DomainJupyterServerAppSettings

The Jupyter server's app settings.

KernelGatewayAppSettings DomainKernelGatewayAppSettings

The kernel gateway app settings.

RSessionAppSettings DomainRSessionAppSettings
RStudioServerProAppSettings DomainRStudioServerProAppSettings
SecurityGroups []string

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

SharingSettings DomainSharingSettings

The sharing settings.

executionRole String

The user profile Amazon Resource Name (ARN).

jupyterServerAppSettings DomainJupyterServerAppSettings

The Jupyter server's app settings.

kernelGatewayAppSettings DomainKernelGatewayAppSettings

The kernel gateway app settings.

rSessionAppSettings DomainRSessionAppSettings
rStudioServerProAppSettings DomainRStudioServerProAppSettings
securityGroups List<String>

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

sharingSettings DomainSharingSettings

The sharing settings.

executionRole string

The user profile Amazon Resource Name (ARN).

jupyterServerAppSettings DomainJupyterServerAppSettings

The Jupyter server's app settings.

kernelGatewayAppSettings DomainKernelGatewayAppSettings

The kernel gateway app settings.

rSessionAppSettings DomainRSessionAppSettings
rStudioServerProAppSettings DomainRStudioServerProAppSettings
securityGroups string[]

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

sharingSettings DomainSharingSettings

The sharing settings.

execution_role str

The user profile Amazon Resource Name (ARN).

jupyter_server_app_settings DomainJupyterServerAppSettings

The Jupyter server's app settings.

kernel_gateway_app_settings DomainKernelGatewayAppSettings

The kernel gateway app settings.

r_session_app_settings DomainRSessionAppSettings
r_studio_server_pro_app_settings DomainRStudioServerProAppSettings
security_groups Sequence[str]

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

sharing_settings DomainSharingSettings

The sharing settings.

executionRole String

The user profile Amazon Resource Name (ARN).

jupyterServerAppSettings Property Map

The Jupyter server's app settings.

kernelGatewayAppSettings Property Map

The kernel gateway app settings.

rSessionAppSettings Property Map
rStudioServerProAppSettings Property Map
securityGroups List<String>

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

sharingSettings Property Map

The sharing settings.

Package Details

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