@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-sagemaker-monitoringschedule.d.ts

@@ -0,0 +1,528 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerMonitoringSchedule = ResourceDefinitionWithAttributes<"AWS::SageMaker::MonitoringSchedule", SageMakerMonitoringScheduleProps, SageMakerMonitoringScheduleAttribs>;
+/**
+ * The `AWS::SageMaker::MonitoringSchedule` resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.
+ */
+export type SageMakerMonitoringScheduleProps = {
+    /**
+     * The name of the endpoint using the monitoring schedule.
+     */
+    EndpointName?: string | undefined;
+    /**
+     * Contains the reason a monitoring job failed, if it failed.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    FailureReason?: string | undefined;
+    /**
+     * Describes metadata on the last execution to run, if there was one.
+     */
+    LastMonitoringExecutionSummary?: MonitoringExecutionSummary | undefined;
+    /**
+     * The configuration object that specifies the monitoring schedule and defines the monitoring job.
+     */
+    MonitoringScheduleConfig: MonitoringScheduleConfig;
+    /**
+     * The name of the monitoring schedule.
+     */
+    MonitoringScheduleName: string;
+    /**
+     * The status of the monitoring schedule.
+     */
+    MonitoringScheduleStatus?: "Pending" | "Failed" | "Scheduled" | "Stopped" | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+};
+export type SageMakerMonitoringScheduleAttribs = {
+    /**
+     * The time when the monitoring schedule was created.
+     */
+    CreationTime: string;
+    /**
+     * The last time that the monitoring schedule was modified.
+     */
+    LastModifiedTime: string;
+    /**
+     * The Amazon Resource Name (ARN) of the monitoring schedule.
+     * @minLength 1
+     * @maxLength 256
+     */
+    MonitoringScheduleArn: string;
+};
+/**
+ * Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
+ */
+export type BaselineConfig = {
+    /**
+     * The Amazon S3 URI for the constraints resource.
+     */
+    ConstraintsResource?: ConstraintsResource | undefined;
+    /**
+     * The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
+     */
+    StatisticsResource?: StatisticsResource | undefined;
+};
+/**
+ * Input object for the batch transform job.
+ */
+export type BatchTransformInput = {
+    /**
+     * The Amazon S3 location being used to capture the data.
+     * @maxLength 512
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    DataCapturedDestinationS3Uri: string;
+    /**
+     * The dataset format for your batch transform job.
+     */
+    DatasetFormat: DatasetFormat;
+    /**
+     * The attributes of the input data to exclude from the analysis.
+     * @maxLength 100
+     */
+    ExcludeFeaturesAttribute?: string | undefined;
+    /**
+     * Path to the filesystem where the batch transform data is available to the container.
+     * @maxLength 256
+     * @pattern .*
+     */
+    LocalPath: string;
+    /**
+     * Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to `FullyReplicated`
+     */
+    S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job. `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
+     */
+    S3InputMode?: "Pipe" | "File" | undefined;
+};
+/**
+ * Configuration for the cluster used to run model monitoring jobs.
+ */
+export type ClusterConfig = {
+    /**
+     * The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
+     * @min 1
+     * @max 100
+     */
+    InstanceCount: number;
+    /**
+     * The ML compute instance type for the processing job.
+     */
+    InstanceType: string;
+    /**
+     * The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
+     * @min 1
+     * @max 2048
+     */
+    VolumeKmsKeyId?: string | undefined;
+    /**
+     * The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.
+     * @min 1
+     * @max 16384
+     */
+    VolumeSizeInGB: number;
+};
+/**
+ * The Amazon S3 URI for the constraints resource.
+ */
+export type ConstraintsResource = {
+    /**
+     * The Amazon S3 URI for the constraints resource.
+     */
+    S3Uri?: string | undefined;
+};
+/**
+ * The CSV format
+ */
+export type Csv = {
+    /**
+     * A boolean flag indicating if given CSV has header
+     */
+    Header?: boolean | undefined;
+};
+/**
+ * The dataset format of the data to monitor
+ */
+export type DatasetFormat = {
+    /**
+     * The CSV format
+     */
+    Csv?: Csv | undefined;
+    /**
+     * The Json format
+     */
+    Json?: Json | undefined;
+    /**
+     * A flag indicating if the dataset format is Parquet
+     */
+    Parquet?: boolean | undefined;
+};
+/**
+ * Input object for the endpoint
+ */
+export type EndpointInput = {
+    /**
+     * An endpoint in customer's account which has enabled `DataCaptureConfig` enabled.
+     */
+    EndpointName: string;
+    /**
+     * The attributes of the input data to exclude from the analysis.
+     * @maxLength 100
+     */
+    ExcludeFeaturesAttribute?: string | undefined;
+    /**
+     * Path to the filesystem where the endpoint data is available to the container.
+     * @maxLength 256
+     * @pattern .*
+     */
+    LocalPath: string;
+    /**
+     * Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to `FullyReplicated`
+     */
+    S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job. `Pipe` mode is recommended for large datasets. `File` mode is useful for small files that fit in memory. Defaults to `File` .
+     */
+    S3InputMode?: "Pipe" | "File" | undefined;
+};
+/**
+ * The Json format
+ */
+export type Json = {
+    /**
+     * A boolean flag indicating if it is JSON line format
+     */
+    Line?: boolean | undefined;
+};
+/**
+ * Container image configuration object for the monitoring job.
+ */
+export type MonitoringAppSpecification = {
+    /**
+     * An array of arguments for the container used to run the monitoring job.
+     */
+    ContainerArguments?: string[] | undefined;
+    /**
+     * Specifies the entrypoint for a container used to run the monitoring job.
+     */
+    ContainerEntrypoint?: string[] | undefined;
+    /**
+     * The container image to be run by the monitoring job.
+     * @maxLength 255
+     * @pattern .*
+     */
+    ImageUri: string;
+    /**
+     * An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
+     */
+    PostAnalyticsProcessorSourceUri?: string | undefined;
+    /**
+     * An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
+     */
+    RecordPreprocessorSourceUri?: string | undefined;
+};
+/**
+ * Summary of information about the last monitoring job to run.
+ */
+export type MonitoringExecutionSummary = {
+    /**
+     * The time at which the monitoring job was created.
+     */
+    CreationTime: string;
+    /**
+     * The name of the endpoint used to run the monitoring job.
+     */
+    EndpointName?: string | undefined;
+    /**
+     * Contains the reason a monitoring job failed, if it failed.
+     * @maxLength 1024
+     */
+    FailureReason?: string | undefined;
+    /**
+     * A timestamp that indicates the last time the monitoring job was modified.
+     */
+    LastModifiedTime: string;
+    /**
+     * The status of the monitoring job.
+     */
+    MonitoringExecutionStatus: "Pending" | "Completed" | "CompletedWithViolations" | "InProgress" | "Failed" | "Stopping" | "Stopped";
+    /**
+     * The name of the monitoring schedule.
+     */
+    MonitoringScheduleName: string;
+    /**
+     * The Amazon Resource Name (ARN) of the monitoring job.
+     * @maxLength 256
+     * @pattern aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
+     */
+    ProcessingJobArn?: string | undefined;
+    /**
+     * The time the monitoring job was scheduled.
+     */
+    ScheduledTime: string;
+};
+/**
+ * The inputs for a monitoring job.
+ */
+export type MonitoringInput = {
+    /**
+     * Input object for the batch transform job.
+     */
+    BatchTransformInput?: BatchTransformInput | undefined;
+    /**
+     * The endpoint for a monitoring job.
+     */
+    EndpointInput?: EndpointInput | undefined;
+};
+/**
+ * Defines the monitoring job.
+ */
+export type MonitoringJobDefinition = {
+    /**
+     * Baseline configuration used to validate that the data conforms to the specified constraints and statistics
+     */
+    BaselineConfig?: BaselineConfig | undefined;
+    /**
+     * Sets the environment variables in the Docker container.
+     */
+    Environment?: Record<string, string> | undefined;
+    /**
+     * Configures the monitoring job to run a specified Docker container image.
+     */
+    MonitoringAppSpecification: MonitoringAppSpecification;
+    /**
+     * The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker AI Endpoint.
+     */
+    MonitoringInputs: MonitoringInput[];
+    /**
+     * The array of outputs from the monitoring job to be uploaded to Amazon S3.
+     */
+    MonitoringOutputConfig: MonitoringOutputConfig;
+    /**
+     * Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
+     */
+    MonitoringResources: MonitoringResources;
+    /**
+     * Specifies networking options for an monitoring job.
+     */
+    NetworkConfig?: NetworkConfig | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform tasks on your behalf.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     */
+    RoleArn: string;
+    /**
+     * Specifies a time limit for how long the monitoring job is allowed to run.
+     */
+    StoppingCondition?: StoppingCondition | undefined;
+};
+/**
+ * The output object for a monitoring job.
+ */
+export type MonitoringOutput = {
+    /**
+     * The Amazon S3 storage location where the results of a monitoring job are saved.
+     */
+    S3Output: S3Output;
+};
+/**
+ * The output configuration for monitoring jobs.
+ */
+export type MonitoringOutputConfig = {
+    /**
+     * The AWS Key Management Service ( AWS KMS ) key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
+     * @maxLength 2048
+     * @pattern .*
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
+     */
+    MonitoringOutputs: MonitoringOutput[];
+};
+/**
+ * Identifies the resources to deploy for a monitoring job.
+ */
+export type MonitoringResources = {
+    /**
+     * The configuration for the cluster resources used to run the processing job.
+     */
+    ClusterConfig: ClusterConfig;
+};
+/**
+ * Configures the monitoring schedule and defines the monitoring job.
+ */
+export type MonitoringScheduleConfig = {
+    /**
+     * Defines the monitoring job.
+     */
+    MonitoringJobDefinition?: MonitoringJobDefinition | undefined;
+    /**
+     * The name of the monitoring job definition to schedule.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
+     */
+    MonitoringJobDefinitionName?: string | undefined;
+    /**
+     * The type of the monitoring job definition to schedule.
+     */
+    MonitoringType?: MonitoringType | undefined;
+    /**
+     * Configures the monitoring schedule.
+     */
+    ScheduleConfig?: ScheduleConfig | undefined;
+};
+/**
+ * The type of monitoring job.
+ */
+export type MonitoringType = "DataQuality" | "ModelQuality" | "ModelBias" | "ModelExplainability";
+/**
+ * Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
+ */
+export type NetworkConfig = {
+    /**
+     * Whether to encrypt all communications between distributed processing jobs. Choose `True` to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
+     */
+    EnableInterContainerTrafficEncryption?: boolean | undefined;
+    /**
+     * Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
+     */
+    EnableNetworkIsolation?: boolean | undefined;
+    /**
+     * Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Training Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .
+     */
+    VpcConfig?: VpcConfig | undefined;
+};
+/**
+ * Information about where and how you want to store the results of a monitoring job.
+ */
+export type S3Output = {
+    /**
+     * The local path to the S3 storage location where SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.
+     * @maxLength 256
+     * @pattern .*
+     */
+    LocalPath: string;
+    /**
+     * Whether to upload the results of the monitoring job continuously or after the job completes.
+     */
+    S3UploadMode?: "Continuous" | "EndOfJob" | undefined;
+    /**
+     * A URI that identifies the S3 storage location where SageMaker saves the results of a monitoring job.
+     * @maxLength 512
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3Uri: string;
+};
+/**
+ * Configuration details about the monitoring schedule.
+ */
+export type ScheduleConfig = {
+    /**
+     * Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of each monitoring job, you would specify: `"-PT1H"` .
+     *
+     * The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify the start time with the `DataAnalysisStartTime` parameter.
+     *
+     * If you set `ScheduleExpression` to `NOW` , this parameter is required.
+     */
+    DataAnalysisEndTime?: string | undefined;
+    /**
+     * Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule your monitoring jobs to run. You schedule monitoring jobs with the `ScheduleExpression` parameter. Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in your dataset that precede the start of each monitoring job, you would specify: `"-PT5H"` .
+     *
+     * The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify the end time with the `DataAnalysisEndTime` parameter.
+     *
+     * If you set `ScheduleExpression` to `NOW` , this parameter is required.
+     */
+    DataAnalysisStartTime?: string | undefined;
+    /**
+     * A cron expression that describes details about the monitoring schedule.
+     *
+     * The supported cron expressions are:
+     *
+     * - If you want to set the job to start every hour, use the following:
+     *
+     * `Hourly: cron(0 * ? * * *)`
+     * - If you want to start the job daily:
+     *
+     * `cron(0 [00-23] ? * * *)`
+     * - If you want to run the job one time, immediately, use the following keyword:
+     *
+     * `NOW`
+     *
+     * For example, the following are valid cron expressions:
+     *
+     * - Daily at noon UTC: `cron(0 12 ? * * *)`
+     * - Daily at midnight UTC: `cron(0 0 ? * * *)`
+     *
+     * To support running every 6, 12 hours, the following are also supported:
+     *
+     * `cron(0 [00-23]/[01-24] ? * * *)`
+     *
+     * For example, the following are valid cron expressions:
+     *
+     * - Every 12 hours, starting at 5pm UTC: `cron(0 17/12 ? * * *)`
+     * - Every two hours starting at midnight: `cron(0 0/2 ? * * *)`
+     *
+     * > - Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
+     * > - We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker AI will pick a time for running every day.
+     *
+     * You can also specify the keyword `NOW` to run the monitoring job immediately, one time, without recurring.
+     * @minLength 1
+     * @maxLength 256
+     */
+    ScheduleExpression: string;
+};
+/**
+ * The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
+ */
+export type StatisticsResource = {
+    /**
+     * The S3 URI for the statistics resource.
+     */
+    S3Uri?: string | undefined;
+};
+/**
+ * Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.
+ *
+ * To stop a training job, SageMaker sends the algorithm the `SIGTERM` signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
+ *
+ * The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with `CreateModel` .
+ *
+ * > The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
+ */
+export type StoppingCondition = {
+    /**
+     * The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
+     *
+     * For compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
+     *
+     * For all other jobs, if the job does not complete during this time, SageMaker ends the job. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
+     *
+     * The maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
+     * @min 1
+     * @max 86400
+     */
+    MaxRuntimeInSeconds: number;
+};
+/**
+ * Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
+ */
+export type VpcConfig = {
+    /**
+     * The VPC security group IDs, in the form `sg-xxxxxxxx` . Specify the security groups for the VPC that is specified in the `Subnets` field.
+     */
+    SecurityGroupIds: string[];
+    /**
+     * The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see [Supported Instance Types and Availability Zones](https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html) .
+     */
+    Subnets: string[];
+};
+//# sourceMappingURL=aws-sagemaker-monitoringschedule.d.ts.map

package/out/exports/resources.generated/aws-sagemaker-notebookinstance.d.ts

@@ -0,0 +1,104 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerNotebookInstance = ResourceDefinitionWithAttributes<"AWS::SageMaker::NotebookInstance", SageMakerNotebookInstanceProps, SageMakerNotebookInstanceAttribs>;
+/**
+ * The `AWS::SageMaker::NotebookInstance` resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see [Use Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html) .
+ */
+export type SageMakerNotebookInstanceProps = {
+    /**
+     * A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) .
+     *
+     * *Valid Values:* `ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge` .
+     */
+    AcceleratorTypes?: string[] | undefined;
+    /**
+     * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see [Associating Git Repositories with SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) .
+     */
+    AdditionalCodeRepositories?: string[] | undefined;
+    /**
+     * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see [Associating Git Repositories with SageMaker AI Notebook Instances](https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html) .
+     */
+    DefaultCodeRepository?: string | undefined;
+    /**
+     * Sets whether SageMaker AI provides internet access to the notebook instance. If you set this to `Disabled` this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker AI training and endpoint services unless you configure a NAT Gateway in your VPC.
+     *
+     * For more information, see [Notebook Instances Are Internet-Enabled by Default](https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access) . You can set the value of this parameter to `Disabled` only if you set a value for the `SubnetId` parameter.
+     */
+    DirectInternetAccess?: string | undefined;
+    /**
+     * Information on the IMDS configuration of the notebook instance
+     */
+    InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined;
+    /**
+     * The type of ML compute instance to launch for the notebook instance.
+     *
+     * > Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
+     */
+    InstanceType: string;
+    /**
+     * The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see [Enabling and Disabling Keys](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the *AWS Key Management Service Developer Guide* .
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The name of a lifecycle configuration to associate with the notebook instance. For information about lifecycle configurations, see [Customize a Notebook Instance](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) in the *Amazon SageMaker Developer Guide* .
+     */
+    LifecycleConfigName?: string | undefined;
+    /**
+     * The name of the new notebook instance.
+     */
+    NotebookInstanceName?: string | undefined;
+    /**
+     * The platform identifier of the notebook instance runtime environment.
+     */
+    PlatformIdentifier?: string | undefined;
+    /**
+     * When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see [SageMaker AI Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html) .
+     *
+     * > To be able to pass this role to SageMaker AI, the caller of this API must have the `iam:PassRole` permission.
+     */
+    RoleArn: string;
+    /**
+     * Whether root access is enabled or disabled for users of the notebook instance. The default value is `Enabled` .
+     *
+     * > Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
+     */
+    RootAccess?: string | undefined;
+    /**
+     * The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
+     */
+    SecurityGroupIds?: string[] | undefined;
+    /**
+     * The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
+     */
+    SubnetId?: string | undefined;
+    /**
+     * A list of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) .
+     *
+     * You can add tags later by using the `CreateTags` API.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
+     *
+     * > Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
+     */
+    VolumeSizeInGB?: number | undefined;
+};
+export type SageMakerNotebookInstanceAttribs = {
+    Id: string;
+    /**
+     * The name of the notebook instance, such as `MyNotebookInstance` .
+     */
+    NotebookInstanceName: string;
+};
+/**
+ * Information on the IMDS configuration of the notebook instance
+ */
+export type InstanceMetadataServiceConfiguration = {
+    /**
+     * Indicates the minimum IMDS version that the notebook instance supports. When passed as part of `CreateNotebookInstance` , if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of `UpdateNotebookInstance` , there is no default.
+     */
+    MinimumInstanceMetadataServiceVersion: string;
+};
+//# sourceMappingURL=aws-sagemaker-notebookinstance.d.ts.map

package/out/exports/resources.generated/aws-sagemaker-notebookinstancelifecycleconfig.d.ts

@@ -0,0 +1,36 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type SageMakerNotebookInstanceLifecycleConfig = ResourceDefinitionWithAttributes<"AWS::SageMaker::NotebookInstanceLifecycleConfig", SageMakerNotebookInstanceLifecycleConfigProps, SageMakerNotebookInstanceLifecycleConfigAttribs>;
+/**
+ * The `AWS::SageMaker::NotebookInstanceLifecycleConfig` resource creates shell scripts that run when you create and/or start a notebook instance. For information about notebook instance lifecycle configurations, see [Customize a Notebook Instance](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) in the *Amazon SageMaker Developer Guide* .
+ */
+export type SageMakerNotebookInstanceLifecycleConfigProps = {
+    /**
+     * The name of the lifecycle configuration.
+     */
+    NotebookInstanceLifecycleConfigName?: string | undefined;
+    /**
+     * A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
+     */
+    OnCreate?: NotebookInstanceLifecycleHook[] | undefined;
+    /**
+     * A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
+     */
+    OnStart?: NotebookInstanceLifecycleHook[] | undefined;
+};
+export type SageMakerNotebookInstanceLifecycleConfigAttribs = {
+    Id: string;
+    /**
+     * The name of the lifecycle configuration, such as `MyLifecycleConfig` .
+     */
+    NotebookInstanceLifecycleConfigName: string;
+};
+/**
+ * Specifies the notebook instance lifecycle configuration script. Each lifecycle configuration script has a limit of 16384 characters.
+ */
+export type NotebookInstanceLifecycleHook = {
+    /**
+     * A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
+     */
+    Content?: string | undefined;
+};
+//# sourceMappingURL=aws-sagemaker-notebookinstancelifecycleconfig.d.ts.map