Resource: awsSagemakerAppImageConfig
Provides a SageMaker App Image Config resource.
Example Usage
Basic usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerAppImageConfig.SagemakerAppImageConfig(this, "test", {
appImageConfigName: "example",
kernelGatewayImageConfig: {
kernelSpec: {
name: "example",
},
},
});
Default File System Config
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerAppImageConfig.SagemakerAppImageConfig(this, "test", {
appImageConfigName: "example",
kernelGatewayImageConfig: {
fileSystemConfig: {},
kernelSpec: {
name: "example",
},
},
});
Argument Reference
The following arguments are supported:
appImageConfigName
- (Required) The name of the App Image Config.kernelGatewayImageConfig
- (Optional) The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app. See Kernel Gateway Image Config details below.tags
- (Optional) A map of tags to assign to the resource. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Kernel Gateway Image Config
fileSystemConfig
- (Optional) The URL where the Git repository is located. See File System Config details below.kernelSpec
- (Required) The default branch for the Git repository. See Kernel Spec details below.
File System Config
defaultGid
- (Optional) The default POSIX group ID (GID). If not specified, defaults to100
. Valid values are0
and100
.defaultUid
- (Optional) The default POSIX user ID (UID). If not specified, defaults to1000
. Valid values are0
and1000
.mountPath
- (Optional) The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to/home/sagemakerUser
.
\~> Note: When specifying defaultGid
and defaultUid
, Valid value pairs are [0
, 0
] and [100
, 1000
].
Kernel Spec
name
- (Required) The name of the kernel.displayName
- (Optional) The display name of the kernel.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
id
- The name of the App Image Config.arn
- The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
SageMaker App Image Configs can be imported using the name
, e.g.,