1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. getAppImageConfig

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.sagemaker.getAppImageConfig

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Resource Type definition for AWS::SageMaker::AppImageConfig

    Using getAppImageConfig

    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 getAppImageConfig(args: GetAppImageConfigArgs, opts?: InvokeOptions): Promise<GetAppImageConfigResult>
    function getAppImageConfigOutput(args: GetAppImageConfigOutputArgs, opts?: InvokeOptions): Output<GetAppImageConfigResult>
    def get_app_image_config(app_image_config_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAppImageConfigResult
    def get_app_image_config_output(app_image_config_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAppImageConfigResult]
    func LookupAppImageConfig(ctx *Context, args *LookupAppImageConfigArgs, opts ...InvokeOption) (*LookupAppImageConfigResult, error)
    func LookupAppImageConfigOutput(ctx *Context, args *LookupAppImageConfigOutputArgs, opts ...InvokeOption) LookupAppImageConfigResultOutput

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

    public static class GetAppImageConfig 
    {
        public static Task<GetAppImageConfigResult> InvokeAsync(GetAppImageConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetAppImageConfigResult> Invoke(GetAppImageConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppImageConfigResult> getAppImageConfig(GetAppImageConfigArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:sagemaker:getAppImageConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AppImageConfigName string
    The Name of the AppImageConfig.
    AppImageConfigName string
    The Name of the AppImageConfig.
    appImageConfigName String
    The Name of the AppImageConfig.
    appImageConfigName string
    The Name of the AppImageConfig.
    app_image_config_name str
    The Name of the AppImageConfig.
    appImageConfigName String
    The Name of the AppImageConfig.

    getAppImageConfig Result

    The following output properties are available:

    AppImageConfigArn string
    The Amazon Resource Name (ARN) of the AppImageConfig.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    JupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    appImageConfigArn String
    The Amazon Resource Name (ARN) of the AppImageConfig.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    appImageConfigArn string
    The Amazon Resource Name (ARN) of the AppImageConfig.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    app_image_config_arn str
    The Amazon Resource Name (ARN) of the AppImageConfig.
    code_editor_app_image_config AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    jupyter_lab_app_image_config AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    kernel_gateway_image_config AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    appImageConfigArn String
    The Amazon Resource Name (ARN) of the AppImageConfig.
    codeEditorAppImageConfig Property Map
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig Property Map
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig Property Map
    The KernelGatewayImageConfig.

    Supporting Types

    AppImageConfigCodeEditorAppImageConfig

    ContainerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    container_config AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig Property Map
    The container configuration for a SageMaker image.

    AppImageConfigContainerConfig

    ContainerArguments List<string>
    A list of arguments to apply to the container.
    ContainerEntrypoint List<string>
    The custom entry point to use on container.
    ContainerEnvironmentVariables List<Pulumi.AwsNative.SageMaker.Inputs.AppImageConfigCustomImageContainerEnvironmentVariable>
    A list of variables to apply to the custom container.
    ContainerArguments []string
    A list of arguments to apply to the container.
    ContainerEntrypoint []string
    The custom entry point to use on container.
    ContainerEnvironmentVariables []AppImageConfigCustomImageContainerEnvironmentVariable
    A list of variables to apply to the custom container.
    containerArguments List<String>
    A list of arguments to apply to the container.
    containerEntrypoint List<String>
    The custom entry point to use on container.
    containerEnvironmentVariables List<AppImageConfigCustomImageContainerEnvironmentVariable>
    A list of variables to apply to the custom container.
    containerArguments string[]
    A list of arguments to apply to the container.
    containerEntrypoint string[]
    The custom entry point to use on container.
    containerEnvironmentVariables AppImageConfigCustomImageContainerEnvironmentVariable[]
    A list of variables to apply to the custom container.
    container_arguments Sequence[str]
    A list of arguments to apply to the container.
    container_entrypoint Sequence[str]
    The custom entry point to use on container.
    container_environment_variables Sequence[AppImageConfigCustomImageContainerEnvironmentVariable]
    A list of variables to apply to the custom container.
    containerArguments List<String>
    A list of arguments to apply to the container.
    containerEntrypoint List<String>
    The custom entry point to use on container.
    containerEnvironmentVariables List<Property Map>
    A list of variables to apply to the custom container.

    AppImageConfigCustomImageContainerEnvironmentVariable

    Key string
    The key that identifies a container environment variable.
    Value string
    The value of the container environment variable.
    Key string
    The key that identifies a container environment variable.
    Value string
    The value of the container environment variable.
    key String
    The key that identifies a container environment variable.
    value String
    The value of the container environment variable.
    key string
    The key that identifies a container environment variable.
    value string
    The value of the container environment variable.
    key str
    The key that identifies a container environment variable.
    value str
    The value of the container environment variable.
    key String
    The key that identifies a container environment variable.
    value String
    The value of the container environment variable.

    AppImageConfigFileSystemConfig

    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    MountPath string
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
    DefaultGid int
    The default POSIX group ID (GID). If not specified, defaults to 100.
    DefaultUid int
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    MountPath string
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
    defaultGid Integer
    The default POSIX group ID (GID). If not specified, defaults to 100.
    defaultUid Integer
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    mountPath String
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
    defaultGid number
    The default POSIX group ID (GID). If not specified, defaults to 100.
    defaultUid number
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    mountPath string
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
    default_gid int
    The default POSIX group ID (GID). If not specified, defaults to 100.
    default_uid int
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    mount_path str
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.
    defaultGid Number
    The default POSIX group ID (GID). If not specified, defaults to 100.
    defaultUid Number
    The default POSIX user ID (UID). If not specified, defaults to 1000.
    mountPath String
    The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

    AppImageConfigJupyterLabAppImageConfig

    ContainerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    container_config AppImageConfigContainerConfig
    The container configuration for a SageMaker image.
    containerConfig Property Map
    The container configuration for a SageMaker image.

    AppImageConfigKernelGatewayImageConfig

    KernelSpecs List<Pulumi.AwsNative.SageMaker.Inputs.AppImageConfigKernelSpec>
    The specification of the Jupyter kernels in the image.
    FileSystemConfig Pulumi.AwsNative.SageMaker.Inputs.AppImageConfigFileSystemConfig
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
    KernelSpecs []AppImageConfigKernelSpec
    The specification of the Jupyter kernels in the image.
    FileSystemConfig AppImageConfigFileSystemConfig
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
    kernelSpecs List<AppImageConfigKernelSpec>
    The specification of the Jupyter kernels in the image.
    fileSystemConfig AppImageConfigFileSystemConfig
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
    kernelSpecs AppImageConfigKernelSpec[]
    The specification of the Jupyter kernels in the image.
    fileSystemConfig AppImageConfigFileSystemConfig
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
    kernel_specs Sequence[AppImageConfigKernelSpec]
    The specification of the Jupyter kernels in the image.
    file_system_config AppImageConfigFileSystemConfig
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
    kernelSpecs List<Property Map>
    The specification of the Jupyter kernels in the image.
    fileSystemConfig Property Map
    The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

    AppImageConfigKernelSpec

    Name string
    The name of the kernel.
    DisplayName string
    The display name of the kernel.
    Name string
    The name of the kernel.
    DisplayName string
    The display name of the kernel.
    name String
    The name of the kernel.
    displayName String
    The display name of the kernel.
    name string
    The name of the kernel.
    displayName string
    The display name of the kernel.
    name str
    The name of the kernel.
    display_name str
    The display name of the kernel.
    name String
    The name of the kernel.
    displayName String
    The display name of the kernel.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi