Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. AppImageConfig

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
pulumi/pulumi-aws-native

aws-native.sagemaker.AppImageConfig

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
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::AppImageConfig

    Create AppImageConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AppImageConfig(name: string, args?: AppImageConfigArgs, opts?: CustomResourceOptions);
    @overload
def AppImageConfig(resource_name: str,
                   args: Optional[AppImageConfigArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def AppImageConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   app_image_config_name: Optional[str] = None,
                   code_editor_app_image_config: Optional[AppImageConfigCodeEditorAppImageConfigArgs] = None,
                   jupyter_lab_app_image_config: Optional[AppImageConfigJupyterLabAppImageConfigArgs] = None,
                   kernel_gateway_image_config: Optional[AppImageConfigKernelGatewayImageConfigArgs] = None,
                   tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewAppImageConfig(ctx *Context, name string, args *AppImageConfigArgs, opts ...ResourceOption) (*AppImageConfig, error)
    public AppImageConfig(string name, AppImageConfigArgs? args = null, CustomResourceOptions? opts = null)
    public AppImageConfig(String name, AppImageConfigArgs args)
public AppImageConfig(String name, AppImageConfigArgs args, CustomResourceOptions options)

    type: aws-native:sagemaker:AppImageConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AppImageConfigArgs
    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 AppImageConfigArgs
    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 AppImageConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppImageConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AppImageConfig Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AppImageConfig resource accepts the following input properties:

    AppImageConfigName string
    The Name of the AppImageConfig.
    CodeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfigArgs
    The CodeEditorAppImageConfig.
    JupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfigArgs
    The JupyterLabAppImageConfig.
    KernelGatewayImageConfig AppImageConfigKernelGatewayImageConfigArgs
    The KernelGatewayImageConfig.
    Tags CreateOnlyTagArgs
    A list of tags to apply to the AppImageConfig.
    appImageConfigName String
    The Name of the AppImageConfig.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    tags List<CreateOnlyTag>
    A list of tags to apply to the AppImageConfig.
    appImageConfigName string
    The Name of the AppImageConfig.
    codeEditorAppImageConfig AppImageConfigCodeEditorAppImageConfig
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig AppImageConfigJupyterLabAppImageConfig
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig AppImageConfigKernelGatewayImageConfig
    The KernelGatewayImageConfig.
    tags CreateOnlyTag[]
    A list of tags to apply to the AppImageConfig.
    appImageConfigName String
    The Name of the AppImageConfig.
    codeEditorAppImageConfig Property Map
    The CodeEditorAppImageConfig.
    jupyterLabAppImageConfig Property Map
    The JupyterLabAppImageConfig.
    kernelGatewayImageConfig Property Map
    The KernelGatewayImageConfig.
    tags List<Property Map>
    A list of tags to apply to the AppImageConfig.

    Outputs

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

    AppImageConfigArn string
    The Amazon Resource Name (ARN) of the AppImageConfig.
    Id string
    The provider-assigned unique ID for this managed resource.
    AppImageConfigArn string
    The Amazon Resource Name (ARN) of the AppImageConfig.
    Id string
    The provider-assigned unique ID for this managed resource.
    appImageConfigArn String
    The Amazon Resource Name (ARN) of the AppImageConfig.
    id String
    The provider-assigned unique ID for this managed resource.
    appImageConfigArn string
    The Amazon Resource Name (ARN) of the AppImageConfig.
    id string
    The provider-assigned unique ID for this managed resource.
    app_image_config_arn str
    The Amazon Resource Name (ARN) of the AppImageConfig.
    id str
    The provider-assigned unique ID for this managed resource.
    appImageConfigArn String
    The Amazon Resource Name (ARN) of the AppImageConfig.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AppImageConfigCodeEditorAppImageConfig, AppImageConfigCodeEditorAppImageConfigArgs

    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, AppImageConfigContainerConfigArgs

    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, AppImageConfigCustomImageContainerEnvironmentVariableArgs

    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, AppImageConfigFileSystemConfigArgs

    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, AppImageConfigJupyterLabAppImageConfigArgs

    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, AppImageConfigKernelGatewayImageConfigArgs

    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, AppImageConfigKernelSpecArgs

    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.

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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
    pulumi/pulumi-aws-native