CfnAppImageConfig

class aws_cdk.aws_sagemaker.CfnAppImageConfig(scope, id, *, app_image_config_name, jupyter_lab_app_image_config=None, kernel_gateway_image_config=None, tags=None)

Bases: CfnResource

Creates a configuration for running a SageMaker image as a KernelGateway app.

The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-appimageconfig.html

CloudformationResource:

AWS::SageMaker::AppImageConfig

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_app_image_config = sagemaker.CfnAppImageConfig(self, "MyCfnAppImageConfig",
    app_image_config_name="appImageConfigName",

    # the properties below are optional
    jupyter_lab_app_image_config=sagemaker.CfnAppImageConfig.JupyterLabAppImageConfigProperty(
        container_config=sagemaker.CfnAppImageConfig.ContainerConfigProperty(
            container_arguments=["containerArguments"],
            container_entrypoint=["containerEntrypoint"],
            container_environment_variables=[sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
                key="key",
                value="value"
            )]
        )
    ),
    kernel_gateway_image_config=sagemaker.CfnAppImageConfig.KernelGatewayImageConfigProperty(
        kernel_specs=[sagemaker.CfnAppImageConfig.KernelSpecProperty(
            name="name",

            # the properties below are optional
            display_name="displayName"
        )],

        # the properties below are optional
        file_system_config=sagemaker.CfnAppImageConfig.FileSystemConfigProperty(
            default_gid=123,
            default_uid=123,
            mount_path="mountPath"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • app_image_config_name (str) – The name of the AppImageConfig. Must be unique to your account.

  • jupyter_lab_app_image_config (Union[IResolvable, JupyterLabAppImageConfigProperty, Dict[str, Any], None]) – The configuration for the file system and the runtime, such as the environment variables and entry point.

  • kernel_gateway_image_config (Union[IResolvable, KernelGatewayImageConfigProperty, Dict[str, Any], None]) – The configuration for the file system and kernels in the SageMaker image.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SageMaker::AppImageConfig'
app_image_config_name

The name of the AppImageConfig.

attr_app_image_config_arn

The Amazon Resource Name (ARN) of the AppImageConfig, such as arn:aws:sagemaker:us-west-2:account-id:app-image-config/my-app-image-config-name .

CloudformationAttribute:

AppImageConfigArn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

jupyter_lab_app_image_config

The configuration for the file system and the runtime, such as the environment variables and entry point.

kernel_gateway_image_config

The configuration for the file system and kernels in the SageMaker image.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

An array of key-value pairs to apply to this resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ContainerConfigProperty

class CfnAppImageConfig.ContainerConfigProperty(*, container_arguments=None, container_entrypoint=None, container_environment_variables=None)

Bases: object

The configuration used to run the application image container.

Parameters:
  • container_arguments (Optional[Sequence[str]]) – The arguments for the container when you’re running the application.

  • container_entrypoint (Optional[Sequence[str]]) – The entrypoint used to run the application in the container.

  • container_environment_variables (Union[IResolvable, Sequence[Union[IResolvable, CustomImageContainerEnvironmentVariableProperty, Dict[str, Any]]], None]) – The environment variables to set in the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

container_config_property = sagemaker.CfnAppImageConfig.ContainerConfigProperty(
    container_arguments=["containerArguments"],
    container_entrypoint=["containerEntrypoint"],
    container_environment_variables=[sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
        key="key",
        value="value"
    )]
)

Attributes

container_arguments

The arguments for the container when you’re running the application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerarguments

container_entrypoint

The entrypoint used to run the application in the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerentrypoint

container_environment_variables

The environment variables to set in the container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-containerconfig.html#cfn-sagemaker-appimageconfig-containerconfig-containerenvironmentvariables

CustomImageContainerEnvironmentVariableProperty

class CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(*, key, value)

Bases: object

The environment variables to set in the container.

Parameters:
  • key (str) – The key that identifies a container environment variable.

  • value (str) – The value of the container environment variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

custom_image_container_environment_variable_property = sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
    key="key",
    value="value"
)

Attributes

key

The key that identifies a container environment variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-key

value

The value of the container environment variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-customimagecontainerenvironmentvariable.html#cfn-sagemaker-appimageconfig-customimagecontainerenvironmentvariable-value

FileSystemConfigProperty

class CfnAppImageConfig.FileSystemConfigProperty(*, default_gid=None, default_uid=None, mount_path=None)

Bases: object

The Amazon Elastic File System storage configuration for a SageMaker image.

Parameters:
  • default_gid (Union[int, float, None]) – The default POSIX group ID (GID). If not specified, defaults to 100 .

  • default_uid (Union[int, float, None]) – The default POSIX user ID (UID). If not specified, defaults to 1000 .

  • mount_path (Optional[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* .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

file_system_config_property = sagemaker.CfnAppImageConfig.FileSystemConfigProperty(
    default_gid=123,
    default_uid=123,
    mount_path="mountPath"
)

Attributes

default_gid

The default POSIX group ID (GID).

If not specified, defaults to 100 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultgid

default_uid

The default POSIX user ID (UID).

If not specified, defaults to 1000 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-defaultuid

mount_path

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* .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-filesystemconfig.html#cfn-sagemaker-appimageconfig-filesystemconfig-mountpath

JupyterLabAppImageConfigProperty

class CfnAppImageConfig.JupyterLabAppImageConfigProperty(*, container_config=None)

Bases: object

The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app.

The FileSystemConfig object is not supported.

Parameters:

container_config (Union[IResolvable, ContainerConfigProperty, Dict[str, Any], None]) – The configuration used to run the application image container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

jupyter_lab_app_image_config_property = sagemaker.CfnAppImageConfig.JupyterLabAppImageConfigProperty(
    container_config=sagemaker.CfnAppImageConfig.ContainerConfigProperty(
        container_arguments=["containerArguments"],
        container_entrypoint=["containerEntrypoint"],
        container_environment_variables=[sagemaker.CfnAppImageConfig.CustomImageContainerEnvironmentVariableProperty(
            key="key",
            value="value"
        )]
    )
)

Attributes

container_config

The configuration used to run the application image container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-jupyterlabappimageconfig.html#cfn-sagemaker-appimageconfig-jupyterlabappimageconfig-containerconfig

KernelGatewayImageConfigProperty

class CfnAppImageConfig.KernelGatewayImageConfigProperty(*, kernel_specs, file_system_config=None)

Bases: object

The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

kernel_gateway_image_config_property = sagemaker.CfnAppImageConfig.KernelGatewayImageConfigProperty(
    kernel_specs=[sagemaker.CfnAppImageConfig.KernelSpecProperty(
        name="name",

        # the properties below are optional
        display_name="displayName"
    )],

    # the properties below are optional
    file_system_config=sagemaker.CfnAppImageConfig.FileSystemConfigProperty(
        default_gid=123,
        default_uid=123,
        mount_path="mountPath"
    )
)

Attributes

file_system_config

The Amazon Elastic File System storage configuration for a SageMaker image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-filesystemconfig

kernel_specs

The specification of the Jupyter kernels in the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelgatewayimageconfig.html#cfn-sagemaker-appimageconfig-kernelgatewayimageconfig-kernelspecs

KernelSpecProperty

class CfnAppImageConfig.KernelSpecProperty(*, name, display_name=None)

Bases: object

The specification of a Jupyter kernel.

Parameters:
  • name (str) – The name of the Jupyter kernel in the image. This value is case sensitive.

  • display_name (Optional[str]) – The display name of the kernel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

kernel_spec_property = sagemaker.CfnAppImageConfig.KernelSpecProperty(
    name="name",

    # the properties below are optional
    display_name="displayName"
)

Attributes

display_name

The display name of the kernel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-displayname

name

The name of the Jupyter kernel in the image.

This value is case sensitive.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-appimageconfig-kernelspec.html#cfn-sagemaker-appimageconfig-kernelspec-name